blob: af8366afabe8cc3fa46b2c3c154ef3eae2273a65 [file] [log] [blame]
Bill Wendlingb12b3d72009-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 Patel15e723d2009-08-28 23:24:31 +000013#define DEBUG_TYPE "dwarfdebug"
Bill Wendlingb12b3d72009-05-15 09:23:25 +000014#include "DwarfDebug.h"
15#include "llvm/Module.h"
David Greened87baff2009-08-19 21:52:55 +000016#include "llvm/CodeGen/MachineFunction.h"
Bill Wendlingb12b3d72009-05-15 09:23:25 +000017#include "llvm/CodeGen/MachineModuleInfo.h"
Chris Lattnere6ad12f2009-07-31 18:48:30 +000018#include "llvm/MC/MCSection.h"
Chris Lattner73266f92009-08-19 05:49:37 +000019#include "llvm/MC/MCStreamer.h"
Chris Lattner621c44d2009-08-22 20:48:53 +000020#include "llvm/MC/MCAsmInfo.h"
Bill Wendlingb12b3d72009-05-15 09:23:25 +000021#include "llvm/Target/TargetData.h"
22#include "llvm/Target/TargetFrameInfo.h"
Chris Lattnerc4c40a92009-07-28 03:13:23 +000023#include "llvm/Target/TargetLoweringObjectFile.h"
24#include "llvm/Target/TargetRegisterInfo.h"
Chris Lattnerf5377682009-08-24 03:52:50 +000025#include "llvm/ADT/StringExtras.h"
Daniel Dunbarc74255d2009-10-13 06:47:08 +000026#include "llvm/Support/Debug.h"
27#include "llvm/Support/ErrorHandling.h"
Chris Lattner5632fab2009-09-16 00:08:41 +000028#include "llvm/Support/Mangler.h"
Chris Lattnere6ad12f2009-07-31 18:48:30 +000029#include "llvm/Support/Timer.h"
30#include "llvm/System/Path.h"
Bill Wendlingb12b3d72009-05-15 09:23:25 +000031using namespace llvm;
32
Bill Wendlingb12b3d72009-05-15 09:23:25 +000033//===----------------------------------------------------------------------===//
34
35/// Configuration values for initial hash set sizes (log2).
36///
Bill Wendlingb12b3d72009-05-15 09:23:25 +000037static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendlingb12b3d72009-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 Lewyckyee68f452009-11-17 08:11:44 +000044class CompileUnit {
Bill Wendlingb12b3d72009-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 Patelc50078e2009-11-21 02:48:08 +000051 DIE *CUDie;
Bill Wendlingb12b3d72009-05-15 09:23:25 +000052
Devang Patel1233f912009-11-21 00:31:03 +000053 /// IndexTyDie - An anonymous type for index type.
54 DIE *IndexTyDie;
55
Bill Wendlingb12b3d72009-05-15 09:23:25 +000056 /// GVToDieMap - Tracks the mapping of unit level debug informaton
57 /// variables to debug information entries.
Devang Patel15e723d2009-08-28 23:24:31 +000058 /// FIXME : Rename GVToDieMap -> NodeToDieMap
Devang Pateld90672c2009-11-20 21:37:22 +000059 ValueMap<MDNode *, DIE *> GVToDieMap;
Bill Wendlingb12b3d72009-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 Patel15e723d2009-08-28 23:24:31 +000063 /// FIXME : Rename
Devang Pateld90672c2009-11-20 21:37:22 +000064 ValueMap<MDNode *, DIEEntry *> GVToDIEEntryMap;
Bill Wendlingb12b3d72009-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 Patelec13b4f2009-11-24 01:14:22 +000070 /// GlobalTypes - A map of globally visible types for this unit.
71 ///
72 StringMap<DIE*> GlobalTypes;
73
Bill Wendlingb12b3d72009-05-15 09:23:25 +000074public:
75 CompileUnit(unsigned I, DIE *D)
Devang Patelc50078e2009-11-21 02:48:08 +000076 : ID(I), CUDie(D), IndexTyDie(0) {}
77 ~CompileUnit() { delete CUDie; delete IndexTyDie; }
Bill Wendlingb12b3d72009-05-15 09:23:25 +000078
79 // Accessors.
Devang Patelec13b4f2009-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 Wendlingb12b3d72009-05-15 09:23:25 +000084
85 /// hasContent - Return true if this compile unit has something to write out.
86 ///
Devang Patelc50078e2009-11-21 02:48:08 +000087 bool hasContent() const { return !CUDie->getChildren().empty(); }
Bill Wendlingb12b3d72009-05-15 09:23:25 +000088
Devang Patelc50078e2009-11-21 02:48:08 +000089 /// addGlobal - Add a new global entity to the compile unit.
Bill Wendlingb12b3d72009-05-15 09:23:25 +000090 ///
Devang Patelc50078e2009-11-21 02:48:08 +000091 void addGlobal(const std::string &Name, DIE *Die) { Globals[Name] = Die; }
Bill Wendlingb12b3d72009-05-15 09:23:25 +000092
Devang Patelec13b4f2009-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 Pateld90672c2009-11-20 21:37:22 +000099 /// getDIE - Returns the debug information entry map slot for the
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000100 /// specified debug variable.
Devang Pateld90672c2009-11-20 21:37:22 +0000101 DIE *getDIE(MDNode *N) { return GVToDieMap.lookup(N); }
Jim Grosbach652b7432009-11-21 23:12:12 +0000102
Devang Pateld90672c2009-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 Wendlingb12b3d72009-05-15 09:23:25 +0000107
Devang Pateld90672c2009-11-20 21:37:22 +0000108 /// getDIEEntry - Returns the debug information entry for the speciefied
109 /// debug variable.
Devang Patel8287d662009-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 Pateld90672c2009-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 Wendlingb12b3d72009-05-15 09:23:25 +0000120 }
121
Devang Patelc50078e2009-11-21 02:48:08 +0000122 /// addDie - Adds or interns the DIE to the compile unit.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000123 ///
Devang Patelc50078e2009-11-21 02:48:08 +0000124 void addDie(DIE *Buffer) {
125 this->CUDie->addChild(Buffer);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000126 }
Devang Patel1233f912009-11-21 00:31:03 +0000127
128 // getIndexTyDie - Get an anonymous type for index type.
129 DIE *getIndexTyDie() {
130 return IndexTyDie;
131 }
132
Jim Grosbachb23f2422009-11-22 19:20:36 +0000133 // setIndexTyDie - Set D as anonymous type for index which can be reused
134 // later.
Devang Patel1233f912009-11-21 00:31:03 +0000135 void setIndexTyDie(DIE *D) {
136 IndexTyDie = D;
137 }
138
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000139};
140
141//===----------------------------------------------------------------------===//
142/// DbgVariable - This class is used to track local variable information.
143///
Devang Patel4cb32c32009-11-16 21:53:40 +0000144class DbgVariable {
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000145 DIVariable Var; // Variable Descriptor.
146 unsigned FrameIndex; // Variable frame index.
Devang Patel90a0fe32009-11-10 23:06:00 +0000147 DbgVariable *AbstractVar; // Abstract variable for this variable.
148 DIE *TheDIE;
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000149public:
Devang Patel90a0fe32009-11-10 23:06:00 +0000150 DbgVariable(DIVariable V, unsigned I)
151 : Var(V), FrameIndex(I), AbstractVar(0), TheDIE(0) {}
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000152
153 // Accessors.
Devang Patel90a0fe32009-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 Wendlingb12b3d72009-05-15 09:23:25 +0000160};
161
162//===----------------------------------------------------------------------===//
163/// DbgScope - This class is used to track scope information.
164///
Devang Patel4cb32c32009-11-16 21:53:40 +0000165class DbgScope {
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000166 DbgScope *Parent; // Parent to this scope.
Jim Grosbach652b7432009-11-21 23:12:12 +0000167 DIDescriptor Desc; // Debug info descriptor for scope.
Devang Patel90a0fe32009-11-10 23:06:00 +0000168 WeakVH InlinedAtLocation; // Location at which scope is inlined.
169 bool AbstractScope; // Abstract Scope
Bill Wendlingb12b3d72009-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 Patel90ecd192009-10-01 18:25:23 +0000172 const MachineInstr *LastInsn; // Last instruction of this scope.
173 const MachineInstr *FirstInsn; // First instruction of this scope.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000174 SmallVector<DbgScope *, 4> Scopes; // Scopes defined in scope.
175 SmallVector<DbgVariable *, 8> Variables;// Variables declared in scope.
Daniel Dunbar41716322009-09-19 20:40:05 +0000176
Owen Anderson696d4862009-06-24 22:53:20 +0000177 // Private state for dump()
178 mutable unsigned IndentLevel;
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000179public:
Devang Pateldd7bb432009-10-14 21:08:09 +0000180 DbgScope(DbgScope *P, DIDescriptor D, MDNode *I = 0)
Devang Patel90a0fe32009-11-10 23:06:00 +0000181 : Parent(P), Desc(D), InlinedAtLocation(I), AbstractScope(false),
Jim Grosbach652b7432009-11-21 23:12:12 +0000182 StartLabelID(0), EndLabelID(0),
Devang Pateldd7bb432009-10-14 21:08:09 +0000183 LastInsn(0), FirstInsn(0), IndentLevel(0) {}
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000184 virtual ~DbgScope();
185
186 // Accessors.
187 DbgScope *getParent() const { return Parent; }
Devang Patel90a0fe32009-11-10 23:06:00 +0000188 void setParent(DbgScope *P) { Parent = P; }
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000189 DIDescriptor getDesc() const { return Desc; }
Jim Grosbach652b7432009-11-21 23:12:12 +0000190 MDNode *getInlinedAt() const {
Devang Patel90a0fe32009-11-10 23:06:00 +0000191 return dyn_cast_or_null<MDNode>(InlinedAtLocation);
Devang Pateldd7bb432009-10-14 21:08:09 +0000192 }
Devang Patel90a0fe32009-11-10 23:06:00 +0000193 MDNode *getScopeNode() const { return Desc.getNode(); }
Bill Wendlingb12b3d72009-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 Wendlingb12b3d72009-05-15 09:23:25 +0000198 void setStartLabelID(unsigned S) { StartLabelID = S; }
199 void setEndLabelID(unsigned E) { EndLabelID = E; }
Devang Patel90ecd192009-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 Patel90a0fe32009-11-10 23:06:00 +0000203 void setAbstractScope() { AbstractScope = true; }
204 bool isAbstractScope() const { return AbstractScope; }
Devang Patel90ecd192009-10-01 18:25:23 +0000205 const MachineInstr *getFirstInsn() { return FirstInsn; }
Devang Patel90a0fe32009-11-10 23:06:00 +0000206
Devang Patelc50078e2009-11-21 02:48:08 +0000207 /// addScope - Add a scope to the scope.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000208 ///
Devang Patelc50078e2009-11-21 02:48:08 +0000209 void addScope(DbgScope *S) { Scopes.push_back(S); }
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000210
Devang Patelc50078e2009-11-21 02:48:08 +0000211 /// addVariable - Add a variable to the scope.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000212 ///
Devang Patelc50078e2009-11-21 02:48:08 +0000213 void addVariable(DbgVariable *V) { Variables.push_back(V); }
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000214
Devang Patel98e77302010-01-04 20:44:00 +0000215 void fixInstructionMarkers(DenseMap<const MachineInstr *,
216 unsigned> &MIIndexMap) {
Devang Patel6a260102009-10-01 20:31:14 +0000217 assert (getFirstInsn() && "First instruction is missing!");
Devang Patel98e77302010-01-04 20:44:00 +0000218
219 // Use the end of last child scope as end of this scope.
Devang Patel6a260102009-10-01 20:31:14 +0000220 SmallVector<DbgScope *, 4> &Scopes = getScopes();
Devang Patel3b620bf2010-01-05 16:59:17 +0000221 const MachineInstr *LastInsn = getFirstInsn();
Devang Patel98e77302010-01-04 20:44:00 +0000222 unsigned LIndex = 0;
223 if (Scopes.empty()) {
224 assert (getLastInsn() && "Inner most scope does not have last insn!");
225 return;
226 }
227 for (SmallVector<DbgScope *, 4>::iterator SI = Scopes.begin(),
228 SE = Scopes.end(); SI != SE; ++SI) {
229 DbgScope *DS = *SI;
230 DS->fixInstructionMarkers(MIIndexMap);
231 const MachineInstr *DSLastInsn = DS->getLastInsn();
232 unsigned DSI = MIIndexMap[DSLastInsn];
233 if (DSI > LIndex) {
234 LastInsn = DSLastInsn;
235 LIndex = DSI;
236 }
237 }
238 setLastInsn(LastInsn);
Devang Patel6a260102009-10-01 20:31:14 +0000239 }
240
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000241#ifndef NDEBUG
242 void dump() const;
243#endif
244};
245
246#ifndef NDEBUG
247void DbgScope::dump() const {
David Greenedbc06132009-12-24 00:31:35 +0000248 raw_ostream &err = dbgs();
Chris Lattnerebb8c082009-08-23 00:51:00 +0000249 err.indent(IndentLevel);
Devang Patel90a0fe32009-11-10 23:06:00 +0000250 MDNode *N = Desc.getNode();
251 N->dump();
Chris Lattnerebb8c082009-08-23 00:51:00 +0000252 err << " [" << StartLabelID << ", " << EndLabelID << "]\n";
Devang Patel90a0fe32009-11-10 23:06:00 +0000253 if (AbstractScope)
254 err << "Abstract Scope\n";
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000255
256 IndentLevel += 2;
Devang Patel90a0fe32009-11-10 23:06:00 +0000257 if (!Scopes.empty())
258 err << "Children ...\n";
Bill Wendlingb12b3d72009-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 Wendlingb12b3d72009-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 Wendlingb12b3d72009-05-15 09:23:25 +0000272}
273
274} // end llvm namespace
275
Chris Lattner621c44d2009-08-22 20:48:53 +0000276DwarfDebug::DwarfDebug(raw_ostream &OS, AsmPrinter *A, const MCAsmInfo *T)
Devang Patel5a3d37f2009-06-29 20:45:18 +0000277 : Dwarf(OS, A, T, "dbg"), ModuleCU(0),
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000278 AbbreviationsSet(InitAbbreviationsSetSize), Abbreviations(),
Devang Patelc50078e2009-11-21 02:48:08 +0000279 DIEValues(), StringPool(),
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000280 SectionSourceLines(), didInitial(false), shouldEmit(false),
Devang Patel90a0fe32009-11-10 23:06:00 +0000281 CurrentFnDbgScope(0), DebugTimer(0) {
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000282 if (TimePassesIsEnabled)
Chris Lattner13bf2e52009-12-28 07:41:18 +0000283 DebugTimer = new Timer("Dwarf Debug Writer");
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000284}
285DwarfDebug::~DwarfDebug() {
Devang Patelc50078e2009-11-21 02:48:08 +0000286 for (unsigned j = 0, M = DIEValues.size(); j < M; ++j)
287 delete DIEValues[j];
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000288
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000289 delete DebugTimer;
290}
291
Devang Patelc50078e2009-11-21 02:48:08 +0000292/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000293///
Devang Patelc50078e2009-11-21 02:48:08 +0000294void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendlingb12b3d72009-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 Patelc50078e2009-11-21 02:48:08 +0000315/// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
Bill Wendling0d3db8b2009-05-20 23:24:48 +0000316/// information entry.
Devang Patelc50078e2009-11-21 02:48:08 +0000317DIEEntry *DwarfDebug::createDIEEntry(DIE *Entry) {
Devang Patel1233f912009-11-21 00:31:03 +0000318 DIEEntry *Value = new DIEEntry(Entry);
Devang Patelc50078e2009-11-21 02:48:08 +0000319 DIEValues.push_back(Value);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000320 return Value;
321}
322
Devang Patelc50078e2009-11-21 02:48:08 +0000323/// addUInt - Add an unsigned integer attribute data and value.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000324///
Devang Patelc50078e2009-11-21 02:48:08 +0000325void DwarfDebug::addUInt(DIE *Die, unsigned Attribute,
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000326 unsigned Form, uint64_t Integer) {
327 if (!Form) Form = DIEInteger::BestForm(false, Integer);
Devang Patel1233f912009-11-21 00:31:03 +0000328 DIEValue *Value = new DIEInteger(Integer);
Devang Patelc50078e2009-11-21 02:48:08 +0000329 DIEValues.push_back(Value);
330 Die->addValue(Attribute, Form, Value);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000331}
332
Devang Patelc50078e2009-11-21 02:48:08 +0000333/// addSInt - Add an signed integer attribute data and value.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000334///
Devang Patelc50078e2009-11-21 02:48:08 +0000335void DwarfDebug::addSInt(DIE *Die, unsigned Attribute,
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000336 unsigned Form, int64_t Integer) {
337 if (!Form) Form = DIEInteger::BestForm(true, Integer);
Devang Patel1233f912009-11-21 00:31:03 +0000338 DIEValue *Value = new DIEInteger(Integer);
Devang Patelc50078e2009-11-21 02:48:08 +0000339 DIEValues.push_back(Value);
340 Die->addValue(Attribute, Form, Value);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000341}
342
Devang Pateldf0f2152009-12-02 15:25:16 +0000343/// addString - Add a string attribute data and value. DIEString only
344/// keeps string reference.
Devang Patelc50078e2009-11-21 02:48:08 +0000345void DwarfDebug::addString(DIE *Die, unsigned Attribute, unsigned Form,
Devang Patelc10337d2009-11-24 19:42:17 +0000346 const StringRef String) {
Devang Patel1233f912009-11-21 00:31:03 +0000347 DIEValue *Value = new DIEString(String);
Devang Patelc50078e2009-11-21 02:48:08 +0000348 DIEValues.push_back(Value);
349 Die->addValue(Attribute, Form, Value);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000350}
351
Devang Patelc50078e2009-11-21 02:48:08 +0000352/// addLabel - Add a Dwarf label attribute data and value.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000353///
Devang Patelc50078e2009-11-21 02:48:08 +0000354void DwarfDebug::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000355 const DWLabel &Label) {
Devang Patel1233f912009-11-21 00:31:03 +0000356 DIEValue *Value = new DIEDwarfLabel(Label);
Devang Patelc50078e2009-11-21 02:48:08 +0000357 DIEValues.push_back(Value);
358 Die->addValue(Attribute, Form, Value);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000359}
360
Devang Patelc50078e2009-11-21 02:48:08 +0000361/// addObjectLabel - Add an non-Dwarf label attribute data and value.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000362///
Devang Patelc50078e2009-11-21 02:48:08 +0000363void DwarfDebug::addObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000364 const std::string &Label) {
Devang Patel1233f912009-11-21 00:31:03 +0000365 DIEValue *Value = new DIEObjectLabel(Label);
Devang Patelc50078e2009-11-21 02:48:08 +0000366 DIEValues.push_back(Value);
367 Die->addValue(Attribute, Form, Value);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000368}
369
Devang Patelc50078e2009-11-21 02:48:08 +0000370/// addSectionOffset - Add a section offset label attribute data and value.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000371///
Devang Patelc50078e2009-11-21 02:48:08 +0000372void DwarfDebug::addSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000373 const DWLabel &Label, const DWLabel &Section,
374 bool isEH, bool useSet) {
Devang Patel1233f912009-11-21 00:31:03 +0000375 DIEValue *Value = new DIESectionOffset(Label, Section, isEH, useSet);
Devang Patelc50078e2009-11-21 02:48:08 +0000376 DIEValues.push_back(Value);
377 Die->addValue(Attribute, Form, Value);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000378}
379
Devang Patelc50078e2009-11-21 02:48:08 +0000380/// addDelta - Add a label delta attribute data and value.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000381///
Devang Patelc50078e2009-11-21 02:48:08 +0000382void DwarfDebug::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000383 const DWLabel &Hi, const DWLabel &Lo) {
Devang Patel1233f912009-11-21 00:31:03 +0000384 DIEValue *Value = new DIEDelta(Hi, Lo);
Devang Patelc50078e2009-11-21 02:48:08 +0000385 DIEValues.push_back(Value);
386 Die->addValue(Attribute, Form, Value);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000387}
388
Devang Patelc50078e2009-11-21 02:48:08 +0000389/// addBlock - Add block data.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000390///
Devang Patelc50078e2009-11-21 02:48:08 +0000391void DwarfDebug::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000392 DIEBlock *Block) {
393 Block->ComputeSize(TD);
Devang Patelc50078e2009-11-21 02:48:08 +0000394 DIEValues.push_back(Block);
395 Die->addValue(Attribute, Block->BestForm(), Block);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000396}
397
Devang Patelc50078e2009-11-21 02:48:08 +0000398/// addSourceLine - Add location information to specified debug information
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000399/// entry.
Devang Patelc50078e2009-11-21 02:48:08 +0000400void DwarfDebug::addSourceLine(DIE *Die, const DIVariable *V) {
Bill Wendlingb12b3d72009-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 Patelb9f2c6b2009-12-11 21:37:07 +0000406 unsigned FileID = findCompileUnit(V->getCompileUnit())->getID();
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000407 assert(FileID && "Invalid file id");
Devang Patelc50078e2009-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 Wendlingb12b3d72009-05-15 09:23:25 +0000410}
411
Devang Patelc50078e2009-11-21 02:48:08 +0000412/// addSourceLine - Add location information to specified debug information
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000413/// entry.
Devang Patelc50078e2009-11-21 02:48:08 +0000414void DwarfDebug::addSourceLine(DIE *Die, const DIGlobal *G) {
Bill Wendlingb12b3d72009-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 Patelb9f2c6b2009-12-11 21:37:07 +0000420 unsigned FileID = findCompileUnit(G->getCompileUnit())->getID();
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000421 assert(FileID && "Invalid file id");
Devang Patelc50078e2009-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 Wendlingb12b3d72009-05-15 09:23:25 +0000424}
Devang Patel318d70d2009-08-31 22:47:13 +0000425
Devang Patelc50078e2009-11-21 02:48:08 +0000426/// addSourceLine - Add location information to specified debug information
Devang Patel318d70d2009-08-31 22:47:13 +0000427/// entry.
Devang Patelc50078e2009-11-21 02:48:08 +0000428void DwarfDebug::addSourceLine(DIE *Die, const DISubprogram *SP) {
Devang Patel318d70d2009-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 Tice9da96d82009-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 Patel318d70d2009-08-31 22:47:13 +0000436
437 unsigned Line = SP->getLineNumber();
Devang Patelb9f2c6b2009-12-11 21:37:07 +0000438 unsigned FileID = findCompileUnit(SP->getCompileUnit())->getID();
Devang Patel318d70d2009-08-31 22:47:13 +0000439 assert(FileID && "Invalid file id");
Devang Patelc50078e2009-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 Patel318d70d2009-08-31 22:47:13 +0000442}
443
Devang Patelc50078e2009-11-21 02:48:08 +0000444/// addSourceLine - Add location information to specified debug information
Devang Patel318d70d2009-08-31 22:47:13 +0000445/// entry.
Devang Patelc50078e2009-11-21 02:48:08 +0000446void DwarfDebug::addSourceLine(DIE *Die, const DIType *Ty) {
Bill Wendlingb12b3d72009-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 Patelb9f2c6b2009-12-11 21:37:07 +0000453 unsigned FileID = findCompileUnit(CU)->getID();
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000454 assert(FileID && "Invalid file id");
Devang Patelc50078e2009-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 Wendlingb12b3d72009-05-15 09:23:25 +0000457}
458
Devang Patel8287d662009-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 Tice248d5572009-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 Patelc50078e2009-11-21 02:48:08 +0000499 value of the variable. The function addBlockByrefType does this. */
Caroline Tice248d5572009-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 Patelc50078e2009-11-21 02:48:08 +0000504DIType DwarfDebug::getBlockByrefType(DIType Ty, std::string Name) {
Caroline Tice248d5572009-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 Stumpb22cd0f2009-09-30 00:08:22 +0000510 DIDerivedType DTy = DIDerivedType(Ty.getNode());
Caroline Tice248d5572009-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 Patel7f75bbe2009-11-25 17:36:49 +0000524 if (Name == DT.getName())
Caroline Tice248d5572009-08-31 21:19:37 +0000525 return (DT.getTypeDerivedFrom());
526 }
527
528 return Ty;
529}
530
Devang Patelc50078e2009-11-21 02:48:08 +0000531/// addComplexAddress - Start with the address based on the location provided,
Mike Stumpb22cd0f2009-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 Patelc50078e2009-11-21 02:48:08 +0000536void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stumpb22cd0f2009-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 Patelc50078e2009-11-21 02:48:08 +0000549 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stumpb22cd0f2009-09-30 00:08:22 +0000550 } else {
551 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patelc50078e2009-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 Stumpb22cd0f2009-09-30 00:08:22 +0000554 }
555 } else {
556 if (Reg < 32)
Devang Patelc50078e2009-11-21 02:48:08 +0000557 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stumpb22cd0f2009-09-30 00:08:22 +0000558 else {
Devang Patelc50078e2009-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 Stumpb22cd0f2009-09-30 00:08:22 +0000561 }
562
Devang Patelc50078e2009-11-21 02:48:08 +0000563 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stumpb22cd0f2009-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 Patelc50078e2009-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 Stumpb22cd0f2009-09-30 00:08:22 +0000572 } else if (Element == DIFactory::OpDeref) {
Devang Patelc50078e2009-11-21 02:48:08 +0000573 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Mike Stumpb22cd0f2009-09-30 00:08:22 +0000574 } else llvm_unreachable("unknown DIFactory Opcode");
575 }
576
577 // Now attach the location information to the DIE.
Devang Patelc50078e2009-11-21 02:48:08 +0000578 addBlock(Die, Attribute, 0, Block);
Mike Stumpb22cd0f2009-09-30 00:08:22 +0000579}
580
Caroline Tice248d5572009-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 Patelc50078e2009-11-21 02:48:08 +0000590 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Tice248d5572009-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 Dunbar41716322009-09-19 20:40:05 +0000595 expression that explains to the debugger how to navigate through the
Caroline Tice248d5572009-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 Patelc50078e2009-11-21 02:48:08 +0000635/// addBlockByrefAddress - Start with the address based on the location
Caroline Tice248d5572009-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 Patelc50078e2009-11-21 02:48:08 +0000641void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000642 unsigned Attribute,
643 const MachineLocation &Location) {
Caroline Tice248d5572009-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 Patel7f75bbe2009-11-25 17:36:49 +0000650 StringRef varName = VD.getName();
Caroline Tice248d5572009-08-31 21:19:37 +0000651
652 if (Tag == dwarf::DW_TAG_pointer_type) {
Mike Stumpb22cd0f2009-09-30 00:08:22 +0000653 DIDerivedType DTy = DIDerivedType(Ty.getNode());
Caroline Tice248d5572009-08-31 21:19:37 +0000654 TmpTy = DTy.getTypeDerivedFrom();
655 isPointer = true;
656 }
657
658 DICompositeType blockStruct = DICompositeType(TmpTy.getNode());
659
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000660 // Find the __forwarding field and the variable field in the __Block_byref
661 // struct.
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000662 DIArray Fields = blockStruct.getTypeArray();
663 DIDescriptor varField = DIDescriptor();
664 DIDescriptor forwardingField = DIDescriptor();
Caroline Tice248d5572009-08-31 21:19:37 +0000665
666
Daniel Dunbar19f1d442009-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 Patel7f75bbe2009-11-25 17:36:49 +0000670 StringRef fieldName = DT.getName();
671 if (fieldName == "__forwarding")
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000672 forwardingField = Element;
Devang Patel7f75bbe2009-11-25 17:36:49 +0000673 else if (fieldName == varName)
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000674 varField = Element;
675 }
Daniel Dunbar41716322009-09-19 20:40:05 +0000676
Mike Stump2fd84e22009-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 Tice248d5572009-08-31 21:19:37 +0000680
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000681 // Get the offsets for the forwarding field and the variable field.
Daniel Dunbar19f1d442009-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 Tice248d5572009-08-31 21:19:37 +0000686
Mike Stump2fd84e22009-09-24 23:21:26 +0000687 // Decode the original location, and use that as the start of the byref
688 // variable's location.
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000689 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
690 DIEBlock *Block = new DIEBlock();
Caroline Tice248d5572009-08-31 21:19:37 +0000691
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000692 if (Location.isReg()) {
693 if (Reg < 32)
Devang Patelc50078e2009-11-21 02:48:08 +0000694 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000695 else {
696 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patelc50078e2009-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 Dunbar19f1d442009-09-19 20:40:14 +0000699 }
700 } else {
701 if (Reg < 32)
Devang Patelc50078e2009-11-21 02:48:08 +0000702 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000703 else {
Devang Patelc50078e2009-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 Dunbar19f1d442009-09-19 20:40:14 +0000706 }
Caroline Tice248d5572009-08-31 21:19:37 +0000707
Devang Patelc50078e2009-11-21 02:48:08 +0000708 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000709 }
Caroline Tice248d5572009-08-31 21:19:37 +0000710
Mike Stump2fd84e22009-09-24 23:21:26 +0000711 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000712 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000713 if (isPointer)
Devang Patelc50078e2009-11-21 02:48:08 +0000714 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Tice248d5572009-08-31 21:19:37 +0000715
Daniel Dunbar19f1d442009-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 Dunbar19f1d442009-09-19 20:40:14 +0000719 if (forwardingFieldOffset > 0) {
Devang Patelc50078e2009-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 Dunbar19f1d442009-09-19 20:40:14 +0000722 }
Caroline Tice248d5572009-08-31 21:19:37 +0000723
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000724 // Now dereference the __forwarding field to get to the real __Block_byref
725 // struct: DW_OP_deref.
Devang Patelc50078e2009-11-21 02:48:08 +0000726 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Tice248d5572009-08-31 21:19:37 +0000727
Daniel Dunbar19f1d442009-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 Dunbar19f1d442009-09-19 20:40:14 +0000731 if (varFieldOffset > 0) {
Devang Patelc50078e2009-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 Dunbar19f1d442009-09-19 20:40:14 +0000734 }
Caroline Tice248d5572009-08-31 21:19:37 +0000735
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000736 // Now attach the location information to the DIE.
Devang Patelc50078e2009-11-21 02:48:08 +0000737 addBlock(Die, Attribute, 0, Block);
Caroline Tice248d5572009-08-31 21:19:37 +0000738}
739
Devang Patelc50078e2009-11-21 02:48:08 +0000740/// addAddress - Add an address attribute to a die based on the location
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000741/// provided.
Devang Patelc50078e2009-11-21 02:48:08 +0000742void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendlingb12b3d72009-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 Patelc50078e2009-11-21 02:48:08 +0000749 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000750 } else {
Devang Patelc50078e2009-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 Wendlingb12b3d72009-05-15 09:23:25 +0000753 }
754 } else {
755 if (Reg < 32) {
Devang Patelc50078e2009-11-21 02:48:08 +0000756 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000757 } else {
Devang Patelc50078e2009-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 Wendlingb12b3d72009-05-15 09:23:25 +0000760 }
761
Devang Patelc50078e2009-11-21 02:48:08 +0000762 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000763 }
764
Devang Patelc50078e2009-11-21 02:48:08 +0000765 addBlock(Die, Attribute, 0, Block);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000766}
767
Devang Patel1a8f9a82009-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 Patel8287d662009-12-15 19:16:48 +0000775 } else if (Context.isNameSpace()) {
776 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context.getNode()));
777 ContextDIE->addChild(Die);
Devang Patel1a8f9a82009-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 Patel7f139c12009-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 Patel1a8f9a82009-12-10 19:14:49 +0000803 addToContextOwner(TyDIE, Ty.getContext());
Devang Patel7f139c12009-12-10 18:05:33 +0000804 return TyDIE;
805}
806
Devang Patelc50078e2009-11-21 02:48:08 +0000807/// addType - Add a new type attribute to the specified entity.
Devang Patelfe0be132009-12-09 18:24:21 +0000808void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000809 if (Ty.isNull())
810 return;
811
812 // Check for pre-existence.
Devang Patelfe0be132009-12-09 18:24:21 +0000813 DIEEntry *Entry = ModuleCU->getDIEEntry(Ty.getNode());
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000814 // If it exists then use the existing value.
Devang Patelc50078e2009-11-21 02:48:08 +0000815 if (Entry) {
816 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000817 return;
818 }
819
820 // Set up proxy.
Devang Patelc50078e2009-11-21 02:48:08 +0000821 Entry = createDIEEntry();
Devang Patelfe0be132009-12-09 18:24:21 +0000822 ModuleCU->insertDIEEntry(Ty.getNode(), Entry);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000823
824 // Construct type.
Devang Patel7f139c12009-12-10 18:05:33 +0000825 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000826
Devang Patelc50078e2009-11-21 02:48:08 +0000827 Entry->setEntry(Buffer);
828 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000829}
830
Devang Patelc50078e2009-11-21 02:48:08 +0000831/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patelfe0be132009-12-09 18:24:21 +0000832void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000833 // Get core information.
Devang Patel7f75bbe2009-11-25 17:36:49 +0000834 StringRef Name = BTy.getName();
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000835 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patelc50078e2009-11-21 02:48:08 +0000836 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000837 BTy.getEncoding());
838
839 // Add name if not anonymous or intermediate type.
Devang Patel7f75bbe2009-11-25 17:36:49 +0000840 if (!Name.empty())
Devang Patelc50078e2009-11-21 02:48:08 +0000841 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000842 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patelc50078e2009-11-21 02:48:08 +0000843 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000844}
845
Devang Patelc50078e2009-11-21 02:48:08 +0000846/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patelfe0be132009-12-09 18:24:21 +0000847void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000848 // Get core information.
Devang Patel7f75bbe2009-11-25 17:36:49 +0000849 StringRef Name = DTy.getName();
Bill Wendlingb12b3d72009-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 Patelfe0be132009-12-09 18:24:21 +0000860 addType(&Buffer, FromTy);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000861
862 // Add name if not anonymous or intermediate type.
Devang Patel76b80672009-11-30 23:56:56 +0000863 if (!Name.empty())
Devang Patelc50078e2009-11-21 02:48:08 +0000864 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000865
866 // Add size if non-zero (derived types might be zero-sized.)
867 if (Size)
Devang Patelc50078e2009-11-21 02:48:08 +0000868 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000869
870 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patelb125c6e2009-11-23 18:43:37 +0000871 if (!DTy.isForwardDecl())
Devang Patelc50078e2009-11-21 02:48:08 +0000872 addSourceLine(&Buffer, &DTy);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000873}
874
Devang Patelc50078e2009-11-21 02:48:08 +0000875/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patelfe0be132009-12-09 18:24:21 +0000876void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000877 // Get core information.
Devang Patel7f75bbe2009-11-25 17:36:49 +0000878 StringRef Name = CTy.getName();
Bill Wendlingb12b3d72009-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 Patelfe0be132009-12-09 18:24:21 +0000887 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendlingb12b3d72009-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 Patel15e723d2009-08-28 23:24:31 +0000895 DIEnumerator Enum(Elements.getElement(i).getNode());
Devang Patelfb812752009-10-09 17:51:49 +0000896 if (!Enum.isNull()) {
Devang Patelfe0be132009-12-09 18:24:21 +0000897 ElemDie = constructEnumTypeDIE(&Enum);
Devang Patelc50078e2009-11-21 02:48:08 +0000898 Buffer.addChild(ElemDie);
Devang Patelfb812752009-10-09 17:51:49 +0000899 }
Bill Wendlingb12b3d72009-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 Patelfe0be132009-12-09 18:24:21 +0000907 addType(&Buffer, DIType(RTy.getNode()));
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000908
909 // Add prototype flag.
Devang Patelc50078e2009-11-21 02:48:08 +0000910 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendlingb12b3d72009-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 Patelfe0be132009-12-09 18:24:21 +0000916 addType(Arg, DIType(Ty.getNode()));
Devang Patelc50078e2009-11-21 02:48:08 +0000917 Buffer.addChild(Arg);
Bill Wendlingb12b3d72009-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 Patel15e723d2009-08-28 23:24:31 +0000934 if (Element.isNull())
935 continue;
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000936 DIE *ElemDie = NULL;
937 if (Element.getTag() == dwarf::DW_TAG_subprogram)
Devang Patel814a12c2009-12-14 16:18:45 +0000938 ElemDie = createSubprogramDIE(DISubprogram(Element.getNode()));
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000939 else
Devang Patelfe0be132009-12-09 18:24:21 +0000940 ElemDie = createMemberDIE(DIDerivedType(Element.getNode()));
Devang Patelc50078e2009-11-21 02:48:08 +0000941 Buffer.addChild(ElemDie);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000942 }
943
Devang Patel20b32102009-08-27 23:51:51 +0000944 if (CTy.isAppleBlockExtension())
Devang Patelc50078e2009-11-21 02:48:08 +0000945 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000946
947 unsigned RLang = CTy.getRunTimeLang();
948 if (RLang)
Devang Patelc50078e2009-11-21 02:48:08 +0000949 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendlingb12b3d72009-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 Patel7f75bbe2009-11-25 17:36:49 +0000958 if (!Name.empty())
Devang Patelc50078e2009-11-21 02:48:08 +0000959 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendlingb12b3d72009-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 Patelc50078e2009-11-21 02:48:08 +0000965 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000966 else {
967 // Add zero size if it is not a forward declaration.
968 if (CTy.isForwardDecl())
Devang Patelc50078e2009-11-21 02:48:08 +0000969 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000970 else
Devang Patelc50078e2009-11-21 02:48:08 +0000971 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000972 }
973
974 // Add source line info if available.
975 if (!CTy.isForwardDecl())
Devang Patelc50078e2009-11-21 02:48:08 +0000976 addSourceLine(&Buffer, &CTy);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000977 }
978}
979
Devang Patelc50078e2009-11-21 02:48:08 +0000980/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
981void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendlingb12b3d72009-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 Patelc50078e2009-11-21 02:48:08 +0000986 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patele7ff5092009-08-14 20:59:16 +0000987 if (L)
Devang Patelc50078e2009-11-21 02:48:08 +0000988 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Pateld3df6972009-12-04 23:10:24 +0000989 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000990
Devang Patelc50078e2009-11-21 02:48:08 +0000991 Buffer.addChild(DW_Subrange);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000992}
993
Devang Patelc50078e2009-11-21 02:48:08 +0000994/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patelfe0be132009-12-09 18:24:21 +0000995void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendlingb12b3d72009-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 Patelc50078e2009-11-21 02:48:08 +0000999 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001000
1001 // Emit derived type.
Devang Patelfe0be132009-12-09 18:24:21 +00001002 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001003 DIArray Elements = CTy->getTypeArray();
1004
Devang Patel1233f912009-11-21 00:31:03 +00001005 // Get an anonymous type for index type.
Devang Patelfe0be132009-12-09 18:24:21 +00001006 DIE *IdxTy = ModuleCU->getIndexTyDie();
Devang Patel1233f912009-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 Patelc50078e2009-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 Patel1233f912009-11-21 00:31:03 +00001012 dwarf::DW_ATE_signed);
Devang Patelfe0be132009-12-09 18:24:21 +00001013 ModuleCU->addDie(IdxTy);
1014 ModuleCU->setIndexTyDie(IdxTy);
Devang Patel1233f912009-11-21 00:31:03 +00001015 }
Bill Wendlingb12b3d72009-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 Patelc50078e2009-11-21 02:48:08 +00001021 constructSubrangeDIE(Buffer, DISubrange(Element.getNode()), IdxTy);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001022 }
1023}
1024
Devang Patelc50078e2009-11-21 02:48:08 +00001025/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patelfe0be132009-12-09 18:24:21 +00001026DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator *ETy) {
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001027 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel7f75bbe2009-11-25 17:36:49 +00001028 StringRef Name = ETy->getName();
Devang Patelc50078e2009-11-21 02:48:08 +00001029 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001030 int64_t Value = ETy->getEnumValue();
Devang Patelc50078e2009-11-21 02:48:08 +00001031 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001032 return Enumerator;
1033}
1034
Devang Patel141e1c42010-01-05 01:46:14 +00001035/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
1036/// printer to not emit usual symbol prefix before the symbol name is used then
1037/// return linkage name after skipping this special LLVM prefix.
1038static StringRef getRealLinkageName(StringRef LinkageName) {
1039 char One = '\1';
1040 if (LinkageName.startswith(StringRef(&One, 1)))
1041 return LinkageName.substr(1);
1042 return LinkageName;
1043}
1044
Devang Patelc50078e2009-11-21 02:48:08 +00001045/// createGlobalVariableDIE - Create new DIE using GV.
Devang Patelfe0be132009-12-09 18:24:21 +00001046DIE *DwarfDebug::createGlobalVariableDIE(const DIGlobalVariable &GV) {
Jim Grosbachb23f2422009-11-22 19:20:36 +00001047 // If the global variable was optmized out then no need to create debug info
1048 // entry.
Devang Patel83e42c72009-11-06 17:58:12 +00001049 if (!GV.getGlobal()) return NULL;
Devang Patel7f75bbe2009-11-25 17:36:49 +00001050 if (GV.getDisplayName().empty()) return NULL;
Devang Patelfabc47c2009-11-06 01:30:04 +00001051
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001052 DIE *GVDie = new DIE(dwarf::DW_TAG_variable);
Jim Grosbach652b7432009-11-21 23:12:12 +00001053 addString(GVDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
Devang Patelaaf012e2009-09-29 18:40:58 +00001054 GV.getDisplayName());
1055
Devang Patel7f75bbe2009-11-25 17:36:49 +00001056 StringRef LinkageName = GV.getLinkageName();
Devang Patel141e1c42010-01-05 01:46:14 +00001057 if (!LinkageName.empty())
Devang Patelc50078e2009-11-21 02:48:08 +00001058 addString(GVDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel141e1c42010-01-05 01:46:14 +00001059 getRealLinkageName(LinkageName));
1060
Devang Patelfe0be132009-12-09 18:24:21 +00001061 addType(GVDie, GV.getType());
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001062 if (!GV.isLocalToUnit())
Devang Patelc50078e2009-11-21 02:48:08 +00001063 addUInt(GVDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1064 addSourceLine(GVDie, &GV);
Devang Patel6bd5cc82009-10-05 23:22:08 +00001065
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001066 return GVDie;
1067}
1068
Devang Patelc50078e2009-11-21 02:48:08 +00001069/// createMemberDIE - Create new member DIE.
Devang Patelfe0be132009-12-09 18:24:21 +00001070DIE *DwarfDebug::createMemberDIE(const DIDerivedType &DT) {
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001071 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel7f75bbe2009-11-25 17:36:49 +00001072 StringRef Name = DT.getName();
1073 if (!Name.empty())
Devang Patelc50078e2009-11-21 02:48:08 +00001074 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel7f75bbe2009-11-25 17:36:49 +00001075
Devang Patelfe0be132009-12-09 18:24:21 +00001076 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001077
Devang Patelc50078e2009-11-21 02:48:08 +00001078 addSourceLine(MemberDie, &DT);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001079
Devang Patel7d9fe582009-11-04 22:06:12 +00001080 DIEBlock *MemLocationDie = new DIEBlock();
Devang Patelc50078e2009-11-21 02:48:08 +00001081 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel7d9fe582009-11-04 22:06:12 +00001082
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001083 uint64_t Size = DT.getSizeInBits();
Devang Patel71842a92009-11-04 23:48:00 +00001084 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001085
1086 if (Size != FieldSize) {
1087 // Handle bitfield.
Devang Patelc50078e2009-11-21 02:48:08 +00001088 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1089 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001090
1091 uint64_t Offset = DT.getOffsetInBits();
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001092 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1093 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer631e3e32010-01-07 17:50:57 +00001094 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001095 Offset -= FieldOffset;
1096
1097 // Maybe we need to work from the other end.
1098 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
Devang Patelc50078e2009-11-21 02:48:08 +00001099 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001100
Devang Patel7d9fe582009-11-04 22:06:12 +00001101 // Here WD_AT_data_member_location points to the anonymous
1102 // field that includes this bit field.
Devang Patelc50078e2009-11-21 02:48:08 +00001103 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel7d9fe582009-11-04 22:06:12 +00001104
1105 } else
1106 // This is not a bitfield.
Devang Patelc50078e2009-11-21 02:48:08 +00001107 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel7d9fe582009-11-04 22:06:12 +00001108
Devang Patelc50078e2009-11-21 02:48:08 +00001109 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001110
1111 if (DT.isProtected())
Devang Patel188c85d2009-12-03 19:11:07 +00001112 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001113 dwarf::DW_ACCESS_protected);
1114 else if (DT.isPrivate())
Devang Patel188c85d2009-12-03 19:11:07 +00001115 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001116 dwarf::DW_ACCESS_private);
Devang Patel188c85d2009-12-03 19:11:07 +00001117 else if (DT.getTag() == dwarf::DW_TAG_inheritance)
1118 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1119 dwarf::DW_ACCESS_public);
1120 if (DT.isVirtual())
1121 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1122 dwarf::DW_VIRTUALITY_virtual);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001123 return MemberDie;
1124}
1125
Devang Patel814a12c2009-12-14 16:18:45 +00001126/// createSubprogramDIE - Create new DIE using SP.
1127DIE *DwarfDebug::createSubprogramDIE(const DISubprogram &SP, bool MakeDecl) {
1128 DIE *SPDie = ModuleCU->getDIE(SP.getNode());
1129 if (SPDie)
1130 return SPDie;
1131
1132 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patel7f75bbe2009-11-25 17:36:49 +00001133 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001134
Devang Patel7f75bbe2009-11-25 17:36:49 +00001135 StringRef LinkageName = SP.getLinkageName();
Devang Patel141e1c42010-01-05 01:46:14 +00001136 if (!LinkageName.empty())
Devang Patelc50078e2009-11-21 02:48:08 +00001137 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel141e1c42010-01-05 01:46:14 +00001138 getRealLinkageName(LinkageName));
1139
Devang Patelc50078e2009-11-21 02:48:08 +00001140 addSourceLine(SPDie, &SP);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001141
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001142 // Add prototyped tag, if C or ObjC.
1143 unsigned Lang = SP.getCompileUnit().getLanguage();
1144 if (Lang == dwarf::DW_LANG_C99 || Lang == dwarf::DW_LANG_C89 ||
1145 Lang == dwarf::DW_LANG_ObjC)
Devang Patelc50078e2009-11-21 02:48:08 +00001146 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001147
1148 // Add Return Type.
Devang Patelc1df8792009-12-03 01:25:38 +00001149 DICompositeType SPTy = SP.getType();
1150 DIArray Args = SPTy.getTypeArray();
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001151 unsigned SPTag = SPTy.getTag();
Devang Patel188c85d2009-12-03 19:11:07 +00001152
Devang Patelc1df8792009-12-03 01:25:38 +00001153 if (Args.isNull() || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patelfe0be132009-12-09 18:24:21 +00001154 addType(SPDie, SPTy);
Devang Patelc1df8792009-12-03 01:25:38 +00001155 else
Devang Patelfe0be132009-12-09 18:24:21 +00001156 addType(SPDie, DIType(Args.getElement(0).getNode()));
Devang Patelc1df8792009-12-03 01:25:38 +00001157
Devang Patel188c85d2009-12-03 19:11:07 +00001158 unsigned VK = SP.getVirtuality();
1159 if (VK) {
1160 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
1161 DIEBlock *Block = new DIEBlock();
1162 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1163 addUInt(Block, 0, dwarf::DW_FORM_data1, SP.getVirtualIndex());
1164 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
1165 ContainingTypeMap.insert(std::make_pair(SPDie, WeakVH(SP.getContainingType().getNode())));
1166 }
1167
Devang Patel814a12c2009-12-14 16:18:45 +00001168 if (MakeDecl || !SP.isDefinition()) {
Devang Patelc50078e2009-11-21 02:48:08 +00001169 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001170
1171 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patelc1df8792009-12-03 01:25:38 +00001172 // be handled while processing variables.
1173 DICompositeType SPTy = SP.getType();
1174 DIArray Args = SPTy.getTypeArray();
1175 unsigned SPTag = SPTy.getTag();
1176
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001177 if (SPTag == dwarf::DW_TAG_subroutine_type)
1178 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1179 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelfe0be132009-12-09 18:24:21 +00001180 addType(Arg, DIType(Args.getElement(i).getNode()));
Devang Patelc50078e2009-11-21 02:48:08 +00001181 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1); // ??
1182 SPDie->addChild(Arg);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001183 }
1184 }
1185
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001186 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patelfe0be132009-12-09 18:24:21 +00001187 ModuleCU->insertDIE(SP.getNode(), SPDie);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001188 return SPDie;
1189}
1190
Devang Patelc50078e2009-11-21 02:48:08 +00001191/// findCompileUnit - Get the compile unit for the given descriptor.
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001192///
Devang Patelb9f2c6b2009-12-11 21:37:07 +00001193CompileUnit *DwarfDebug::findCompileUnit(DICompileUnit Unit) {
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001194 DenseMap<Value *, CompileUnit *>::const_iterator I =
Devang Patel15e723d2009-08-28 23:24:31 +00001195 CompileUnitMap.find(Unit.getNode());
Devang Patelb9f2c6b2009-12-11 21:37:07 +00001196 if (I == CompileUnitMap.end())
1197 return constructCompileUnit(Unit.getNode());
1198 return I->second;
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001199}
1200
Devang Patel90a0fe32009-11-10 23:06:00 +00001201/// getUpdatedDbgScope - Find or create DbgScope assicated with the instruction.
1202/// Initialize scope and update scope hierarchy.
1203DbgScope *DwarfDebug::getUpdatedDbgScope(MDNode *N, const MachineInstr *MI,
1204 MDNode *InlinedAt) {
1205 assert (N && "Invalid Scope encoding!");
1206 assert (MI && "Missing machine instruction!");
1207 bool GetConcreteScope = (MI && InlinedAt);
1208
1209 DbgScope *NScope = NULL;
1210
1211 if (InlinedAt)
1212 NScope = DbgScopeMap.lookup(InlinedAt);
1213 else
1214 NScope = DbgScopeMap.lookup(N);
1215 assert (NScope && "Unable to find working scope!");
1216
1217 if (NScope->getFirstInsn())
1218 return NScope;
Devang Patel6a260102009-10-01 20:31:14 +00001219
1220 DbgScope *Parent = NULL;
Devang Patel90a0fe32009-11-10 23:06:00 +00001221 if (GetConcreteScope) {
Devang Pateldd7bb432009-10-14 21:08:09 +00001222 DILocation IL(InlinedAt);
Jim Grosbach652b7432009-11-21 23:12:12 +00001223 Parent = getUpdatedDbgScope(IL.getScope().getNode(), MI,
Devang Patel90a0fe32009-11-10 23:06:00 +00001224 IL.getOrigLocation().getNode());
1225 assert (Parent && "Unable to find Parent scope!");
1226 NScope->setParent(Parent);
Devang Patelc50078e2009-11-21 02:48:08 +00001227 Parent->addScope(NScope);
Devang Patel90a0fe32009-11-10 23:06:00 +00001228 } else if (DIDescriptor(N).isLexicalBlock()) {
1229 DILexicalBlock DB(N);
1230 if (!DB.getContext().isNull()) {
1231 Parent = getUpdatedDbgScope(DB.getContext().getNode(), MI, InlinedAt);
1232 NScope->setParent(Parent);
Devang Patelc50078e2009-11-21 02:48:08 +00001233 Parent->addScope(NScope);
Devang Patel90a0fe32009-11-10 23:06:00 +00001234 }
Devang Pateldd7bb432009-10-14 21:08:09 +00001235 }
Devang Patel6a260102009-10-01 20:31:14 +00001236
Devang Patelf5278f22009-10-27 20:47:17 +00001237 NScope->setFirstInsn(MI);
Devang Patel6a260102009-10-01 20:31:14 +00001238
Devang Patel90a0fe32009-11-10 23:06:00 +00001239 if (!Parent && !InlinedAt) {
Devang Patelce8986f2009-11-11 00:31:36 +00001240 StringRef SPName = DISubprogram(N).getLinkageName();
1241 if (SPName == MF->getFunction()->getName())
1242 CurrentFnDbgScope = NScope;
Devang Patel90a0fe32009-11-10 23:06:00 +00001243 }
Devang Patel6a260102009-10-01 20:31:14 +00001244
Devang Patel90a0fe32009-11-10 23:06:00 +00001245 if (GetConcreteScope) {
1246 ConcreteScopes[InlinedAt] = NScope;
1247 getOrCreateAbstractScope(N);
1248 }
1249
Devang Patelf5278f22009-10-27 20:47:17 +00001250 return NScope;
Devang Patel6a260102009-10-01 20:31:14 +00001251}
1252
Devang Patel90a0fe32009-11-10 23:06:00 +00001253DbgScope *DwarfDebug::getOrCreateAbstractScope(MDNode *N) {
1254 assert (N && "Invalid Scope encoding!");
1255
1256 DbgScope *AScope = AbstractScopes.lookup(N);
1257 if (AScope)
1258 return AScope;
Jim Grosbach652b7432009-11-21 23:12:12 +00001259
Devang Patel90a0fe32009-11-10 23:06:00 +00001260 DbgScope *Parent = NULL;
1261
1262 DIDescriptor Scope(N);
1263 if (Scope.isLexicalBlock()) {
1264 DILexicalBlock DB(N);
1265 DIDescriptor ParentDesc = DB.getContext();
1266 if (!ParentDesc.isNull())
1267 Parent = getOrCreateAbstractScope(ParentDesc.getNode());
1268 }
1269
1270 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1271
1272 if (Parent)
Devang Patelc50078e2009-11-21 02:48:08 +00001273 Parent->addScope(AScope);
Devang Patel90a0fe32009-11-10 23:06:00 +00001274 AScope->setAbstractScope();
1275 AbstractScopes[N] = AScope;
1276 if (DIDescriptor(N).isSubprogram())
1277 AbstractScopesList.push_back(AScope);
1278 return AScope;
1279}
Devang Patel6a260102009-10-01 20:31:14 +00001280
Jim Grosbach652b7432009-11-21 23:12:12 +00001281/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patelc50078e2009-11-21 02:48:08 +00001282/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1283/// If there are global variables in this scope then create and insert
1284/// DIEs for these variables.
1285DIE *DwarfDebug::updateSubprogramScopeDIE(MDNode *SPNode) {
Devang Patel90a0fe32009-11-10 23:06:00 +00001286
Devang Pateld90672c2009-11-20 21:37:22 +00001287 DIE *SPDie = ModuleCU->getDIE(SPNode);
Devang Patel90a0fe32009-11-10 23:06:00 +00001288 assert (SPDie && "Unable to find subprogram DIE!");
Devang Patel814a12c2009-12-14 16:18:45 +00001289 DISubprogram SP(SPNode);
1290 if (SP.isDefinition() && !SP.getContext().isCompileUnit()) {
1291 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1292 // Add arguments.
1293 DICompositeType SPTy = SP.getType();
1294 DIArray Args = SPTy.getTypeArray();
1295 unsigned SPTag = SPTy.getTag();
1296 if (SPTag == dwarf::DW_TAG_subroutine_type)
1297 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1298 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1299 addType(Arg, DIType(Args.getElement(i).getNode()));
1300 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1); // ??
1301 SPDie->addChild(Arg);
1302 }
1303 DIE *SPDeclDie = SPDie;
1304 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1305 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
1306 SPDeclDie);
Devang Patel814a12c2009-12-14 16:18:45 +00001307 ModuleCU->addDie(SPDie);
1308 }
1309
Devang Patelc50078e2009-11-21 02:48:08 +00001310 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Devang Patel90a0fe32009-11-10 23:06:00 +00001311 DWLabel("func_begin", SubprogramCount));
Devang Patelc50078e2009-11-21 02:48:08 +00001312 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Devang Patel90a0fe32009-11-10 23:06:00 +00001313 DWLabel("func_end", SubprogramCount));
1314 MachineLocation Location(RI->getFrameRegister(*MF));
Devang Patelc50078e2009-11-21 02:48:08 +00001315 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Jim Grosbach652b7432009-11-21 23:12:12 +00001316
Devang Patel90a0fe32009-11-10 23:06:00 +00001317 if (!DISubprogram(SPNode).isLocalToUnit())
Devang Patelc50078e2009-11-21 02:48:08 +00001318 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patel90a0fe32009-11-10 23:06:00 +00001319
Devang Patel90a0fe32009-11-10 23:06:00 +00001320 return SPDie;
1321}
1322
Jim Grosbach652b7432009-11-21 23:12:12 +00001323/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patelc50078e2009-11-21 02:48:08 +00001324/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1325DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Patel90a0fe32009-11-10 23:06:00 +00001326 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1327 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
1328
1329 // Ignore empty scopes.
1330 if (StartID == EndID && StartID != 0)
1331 return NULL;
1332
1333 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1334 if (Scope->isAbstractScope())
1335 return ScopeDIE;
1336
Devang Patelc50078e2009-11-21 02:48:08 +00001337 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Jim Grosbach652b7432009-11-21 23:12:12 +00001338 StartID ?
1339 DWLabel("label", StartID)
Devang Patel90a0fe32009-11-10 23:06:00 +00001340 : DWLabel("func_begin", SubprogramCount));
Devang Patelc50078e2009-11-21 02:48:08 +00001341 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Jim Grosbach652b7432009-11-21 23:12:12 +00001342 EndID ?
1343 DWLabel("label", EndID)
Devang Patel90a0fe32009-11-10 23:06:00 +00001344 : DWLabel("func_end", SubprogramCount));
1345
1346
1347
1348 return ScopeDIE;
1349}
1350
Devang Patelc50078e2009-11-21 02:48:08 +00001351/// constructInlinedScopeDIE - This scope represents inlined body of
1352/// a function. Construct DIE to represent this concrete inlined copy
1353/// of the function.
1354DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Patel90a0fe32009-11-10 23:06:00 +00001355 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1356 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
1357 assert (StartID && "Invalid starting label for an inlined scope!");
1358 assert (EndID && "Invalid end label for an inlined scope!");
1359 // Ignore empty scopes.
1360 if (StartID == EndID && StartID != 0)
1361 return NULL;
1362
1363 DIScope DS(Scope->getScopeNode());
1364 if (DS.isNull())
1365 return NULL;
1366 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1367
1368 DISubprogram InlinedSP = getDISubprogram(DS.getNode());
Devang Pateld90672c2009-11-20 21:37:22 +00001369 DIE *OriginDIE = ModuleCU->getDIE(InlinedSP.getNode());
Devang Patel90a0fe32009-11-10 23:06:00 +00001370 assert (OriginDIE && "Unable to find Origin DIE!");
Devang Patelc50078e2009-11-21 02:48:08 +00001371 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patel90a0fe32009-11-10 23:06:00 +00001372 dwarf::DW_FORM_ref4, OriginDIE);
1373
Devang Patelc50078e2009-11-21 02:48:08 +00001374 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Devang Patel90a0fe32009-11-10 23:06:00 +00001375 DWLabel("label", StartID));
Devang Patelc50078e2009-11-21 02:48:08 +00001376 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Devang Patel90a0fe32009-11-10 23:06:00 +00001377 DWLabel("label", EndID));
1378
1379 InlinedSubprogramDIEs.insert(OriginDIE);
1380
1381 // Track the start label for this inlined function.
1382 ValueMap<MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
1383 I = InlineInfo.find(InlinedSP.getNode());
1384
1385 if (I == InlineInfo.end()) {
Jim Grosbachb23f2422009-11-22 19:20:36 +00001386 InlineInfo[InlinedSP.getNode()].push_back(std::make_pair(StartID,
1387 ScopeDIE));
Devang Patel90a0fe32009-11-10 23:06:00 +00001388 InlinedSPNodes.push_back(InlinedSP.getNode());
1389 } else
1390 I->second.push_back(std::make_pair(StartID, ScopeDIE));
1391
1392 StringPool.insert(InlinedSP.getName());
Devang Patel141e1c42010-01-05 01:46:14 +00001393 StringPool.insert(getRealLinkageName(InlinedSP.getLinkageName()));
1394
Devang Patel90a0fe32009-11-10 23:06:00 +00001395 DILocation DL(Scope->getInlinedAt());
Devang Patelc50078e2009-11-21 02:48:08 +00001396 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, ModuleCU->getID());
1397 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patel90a0fe32009-11-10 23:06:00 +00001398
1399 return ScopeDIE;
1400}
1401
Devang Patelc50078e2009-11-21 02:48:08 +00001402
1403/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patelfe0be132009-12-09 18:24:21 +00001404DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel90a0fe32009-11-10 23:06:00 +00001405 // Get the descriptor.
1406 const DIVariable &VD = DV->getVariable();
Devang Patel7f75bbe2009-11-25 17:36:49 +00001407 StringRef Name = VD.getName();
1408 if (Name.empty())
Devang Patelab9a0682009-11-13 02:25:26 +00001409 return NULL;
Devang Patel90a0fe32009-11-10 23:06:00 +00001410
1411 // Translate tag to proper Dwarf tag. The result variable is dropped for
1412 // now.
1413 unsigned Tag;
1414 switch (VD.getTag()) {
1415 case dwarf::DW_TAG_return_variable:
1416 return NULL;
1417 case dwarf::DW_TAG_arg_variable:
1418 Tag = dwarf::DW_TAG_formal_parameter;
1419 break;
1420 case dwarf::DW_TAG_auto_variable: // fall thru
1421 default:
1422 Tag = dwarf::DW_TAG_variable;
1423 break;
1424 }
1425
1426 // Define variable debug information entry.
1427 DIE *VariableDie = new DIE(Tag);
1428
1429
1430 DIE *AbsDIE = NULL;
1431 if (DbgVariable *AV = DV->getAbstractVariable())
1432 AbsDIE = AV->getDIE();
Jim Grosbach652b7432009-11-21 23:12:12 +00001433
Devang Patel90a0fe32009-11-10 23:06:00 +00001434 if (AbsDIE) {
1435 DIScope DS(Scope->getScopeNode());
1436 DISubprogram InlinedSP = getDISubprogram(DS.getNode());
Devang Pateld90672c2009-11-20 21:37:22 +00001437 DIE *OriginSPDIE = ModuleCU->getDIE(InlinedSP.getNode());
Daniel Dunbarc9f2d242009-11-11 03:09:50 +00001438 (void) OriginSPDIE;
Devang Patel90a0fe32009-11-10 23:06:00 +00001439 assert (OriginSPDIE && "Unable to find Origin DIE for the SP!");
1440 DIE *AbsDIE = DV->getAbstractVariable()->getDIE();
1441 assert (AbsDIE && "Unable to find Origin DIE for the Variable!");
Devang Patelc50078e2009-11-21 02:48:08 +00001442 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patel90a0fe32009-11-10 23:06:00 +00001443 dwarf::DW_FORM_ref4, AbsDIE);
1444 }
1445 else {
Devang Patelc50078e2009-11-21 02:48:08 +00001446 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
1447 addSourceLine(VariableDie, &VD);
Devang Patel90a0fe32009-11-10 23:06:00 +00001448
1449 // Add variable type.
Jim Grosbach652b7432009-11-21 23:12:12 +00001450 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
Devang Patel90a0fe32009-11-10 23:06:00 +00001451 // addresses instead.
1452 if (VD.isBlockByrefVariable())
Devang Patelfe0be132009-12-09 18:24:21 +00001453 addType(VariableDie, getBlockByrefType(VD.getType(), Name));
Devang Patel90a0fe32009-11-10 23:06:00 +00001454 else
Devang Patelfe0be132009-12-09 18:24:21 +00001455 addType(VariableDie, VD.getType());
Devang Patel90a0fe32009-11-10 23:06:00 +00001456 }
1457
1458 // Add variable address.
1459 if (!Scope->isAbstractScope()) {
1460 MachineLocation Location;
Jim Grosbach587d4882009-11-22 20:14:00 +00001461 unsigned FrameReg;
1462 int Offset = RI->getFrameIndexReference(*MF, DV->getFrameIndex(), FrameReg);
1463 Location.set(FrameReg, Offset);
Jim Grosbach652b7432009-11-21 23:12:12 +00001464
Devang Patel90a0fe32009-11-10 23:06:00 +00001465 if (VD.hasComplexAddress())
Devang Patelc50078e2009-11-21 02:48:08 +00001466 addComplexAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
Devang Patel90a0fe32009-11-10 23:06:00 +00001467 else if (VD.isBlockByrefVariable())
Devang Patelc50078e2009-11-21 02:48:08 +00001468 addBlockByrefAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
Devang Patel90a0fe32009-11-10 23:06:00 +00001469 else
Devang Patelc50078e2009-11-21 02:48:08 +00001470 addAddress(VariableDie, dwarf::DW_AT_location, Location);
Devang Patel90a0fe32009-11-10 23:06:00 +00001471 }
1472 DV->setDIE(VariableDie);
1473 return VariableDie;
1474
1475}
Devang Patelc50078e2009-11-21 02:48:08 +00001476
Devang Patelec13b4f2009-11-24 01:14:22 +00001477void DwarfDebug::addPubTypes(DISubprogram SP) {
1478 DICompositeType SPTy = SP.getType();
1479 unsigned SPTag = SPTy.getTag();
1480 if (SPTag != dwarf::DW_TAG_subroutine_type)
1481 return;
1482
1483 DIArray Args = SPTy.getTypeArray();
1484 if (Args.isNull())
1485 return;
1486
1487 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
1488 DIType ATy(Args.getElement(i).getNode());
1489 if (ATy.isNull())
1490 continue;
1491 DICompositeType CATy = getDICompositeType(ATy);
Devang Patel7f75bbe2009-11-25 17:36:49 +00001492 if (!CATy.isNull() && !CATy.getName().empty()) {
Devang Patelec13b4f2009-11-24 01:14:22 +00001493 if (DIEEntry *Entry = ModuleCU->getDIEEntry(CATy.getNode()))
1494 ModuleCU->addGlobalType(CATy.getName(), Entry->getEntry());
1495 }
1496 }
1497}
1498
Devang Patelc50078e2009-11-21 02:48:08 +00001499/// constructScopeDIE - Construct a DIE for this scope.
1500DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel90a0fe32009-11-10 23:06:00 +00001501 if (!Scope)
1502 return NULL;
1503 DIScope DS(Scope->getScopeNode());
1504 if (DS.isNull())
1505 return NULL;
1506
1507 DIE *ScopeDIE = NULL;
1508 if (Scope->getInlinedAt())
Devang Patelc50078e2009-11-21 02:48:08 +00001509 ScopeDIE = constructInlinedScopeDIE(Scope);
Devang Patel90a0fe32009-11-10 23:06:00 +00001510 else if (DS.isSubprogram()) {
1511 if (Scope->isAbstractScope())
Devang Pateld90672c2009-11-20 21:37:22 +00001512 ScopeDIE = ModuleCU->getDIE(DS.getNode());
Devang Patel90a0fe32009-11-10 23:06:00 +00001513 else
Devang Patelc50078e2009-11-21 02:48:08 +00001514 ScopeDIE = updateSubprogramScopeDIE(DS.getNode());
Devang Patel90a0fe32009-11-10 23:06:00 +00001515 }
1516 else {
Devang Patelc50078e2009-11-21 02:48:08 +00001517 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patel90a0fe32009-11-10 23:06:00 +00001518 if (!ScopeDIE) return NULL;
1519 }
1520
1521 // Add variables to scope.
1522 SmallVector<DbgVariable *, 8> &Variables = Scope->getVariables();
1523 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Devang Patelfe0be132009-12-09 18:24:21 +00001524 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
Jim Grosbach652b7432009-11-21 23:12:12 +00001525 if (VariableDIE)
Devang Patelc50078e2009-11-21 02:48:08 +00001526 ScopeDIE->addChild(VariableDIE);
Devang Patel90a0fe32009-11-10 23:06:00 +00001527 }
1528
1529 // Add nested scopes.
1530 SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
1531 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1532 // Define the Scope debug information entry.
Devang Patelc50078e2009-11-21 02:48:08 +00001533 DIE *NestedDIE = constructScopeDIE(Scopes[j]);
Jim Grosbach652b7432009-11-21 23:12:12 +00001534 if (NestedDIE)
Devang Patelc50078e2009-11-21 02:48:08 +00001535 ScopeDIE->addChild(NestedDIE);
Devang Patel90a0fe32009-11-10 23:06:00 +00001536 }
Devang Patelec13b4f2009-11-24 01:14:22 +00001537
1538 if (DS.isSubprogram())
1539 addPubTypes(DISubprogram(DS.getNode()));
1540
1541 return ScopeDIE;
Devang Patel90a0fe32009-11-10 23:06:00 +00001542}
1543
Bill Wendlingf5839192009-05-20 23:19:06 +00001544/// GetOrCreateSourceID - Look up the source id with the given directory and
1545/// source file names. If none currently exists, create a new id and insert it
1546/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1547/// maps as well.
Devang Patel7f75bbe2009-11-25 17:36:49 +00001548unsigned DwarfDebug::GetOrCreateSourceID(StringRef DirName, StringRef FileName) {
Bill Wendlingf5839192009-05-20 23:19:06 +00001549 unsigned DId;
1550 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
1551 if (DI != DirectoryIdMap.end()) {
1552 DId = DI->getValue();
1553 } else {
1554 DId = DirectoryNames.size() + 1;
1555 DirectoryIdMap[DirName] = DId;
1556 DirectoryNames.push_back(DirName);
1557 }
1558
1559 unsigned FId;
1560 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
1561 if (FI != SourceFileIdMap.end()) {
1562 FId = FI->getValue();
1563 } else {
1564 FId = SourceFileNames.size() + 1;
1565 SourceFileIdMap[FileName] = FId;
1566 SourceFileNames.push_back(FileName);
1567 }
1568
1569 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
1570 SourceIdMap.find(std::make_pair(DId, FId));
1571 if (SI != SourceIdMap.end())
1572 return SI->second;
1573
1574 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0.
1575 SourceIdMap[std::make_pair(DId, FId)] = SrcId;
1576 SourceIds.push_back(std::make_pair(DId, FId));
1577
1578 return SrcId;
1579}
1580
Devang Patel8287d662009-12-15 19:16:48 +00001581/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1582DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
1583 DIE *NDie = ModuleCU->getDIE(NS.getNode());
1584 if (NDie)
1585 return NDie;
1586 NDie = new DIE(dwarf::DW_TAG_namespace);
1587 ModuleCU->insertDIE(NS.getNode(), NDie);
1588 if (!NS.getName().empty())
1589 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
1590 addSourceLine(NDie, &NS);
1591 addToContextOwner(NDie, NS.getContext());
1592 return NDie;
1593}
1594
Devang Patelb9f2c6b2009-12-11 21:37:07 +00001595CompileUnit *DwarfDebug::constructCompileUnit(MDNode *N) {
Devang Patel15e723d2009-08-28 23:24:31 +00001596 DICompileUnit DIUnit(N);
Devang Patel7f75bbe2009-11-25 17:36:49 +00001597 StringRef FN = DIUnit.getFilename();
1598 StringRef Dir = DIUnit.getDirectory();
Devang Patelaaf012e2009-09-29 18:40:58 +00001599 unsigned ID = GetOrCreateSourceID(Dir, FN);
Bill Wendlingf5839192009-05-20 23:19:06 +00001600
1601 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patelc50078e2009-11-21 02:48:08 +00001602 addSectionOffset(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
Bill Wendlingf5839192009-05-20 23:19:06 +00001603 DWLabel("section_line", 0), DWLabel("section_line", 0),
1604 false);
Devang Patelc50078e2009-11-21 02:48:08 +00001605 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patelaaf012e2009-09-29 18:40:58 +00001606 DIUnit.getProducer());
Devang Patelc50078e2009-11-21 02:48:08 +00001607 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendlingf5839192009-05-20 23:19:06 +00001608 DIUnit.getLanguage());
Devang Patelc50078e2009-11-21 02:48:08 +00001609 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Bill Wendlingf5839192009-05-20 23:19:06 +00001610
Devang Patel7f75bbe2009-11-25 17:36:49 +00001611 if (!Dir.empty())
Devang Patelc50078e2009-11-21 02:48:08 +00001612 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendlingf5839192009-05-20 23:19:06 +00001613 if (DIUnit.isOptimized())
Devang Patelc50078e2009-11-21 02:48:08 +00001614 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendlingf5839192009-05-20 23:19:06 +00001615
Devang Patel7f75bbe2009-11-25 17:36:49 +00001616 StringRef Flags = DIUnit.getFlags();
1617 if (!Flags.empty())
Devang Patelc50078e2009-11-21 02:48:08 +00001618 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendlingf5839192009-05-20 23:19:06 +00001619
1620 unsigned RVer = DIUnit.getRunTimeVersion();
1621 if (RVer)
Devang Patelc50078e2009-11-21 02:48:08 +00001622 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf5839192009-05-20 23:19:06 +00001623 dwarf::DW_FORM_data1, RVer);
1624
1625 CompileUnit *Unit = new CompileUnit(ID, Die);
Devang Patel5a3d37f2009-06-29 20:45:18 +00001626 if (!ModuleCU && DIUnit.isMain()) {
Devang Patelf97a05a2009-06-29 20:38:13 +00001627 // Use first compile unit marked as isMain as the compile unit
1628 // for this module.
Devang Patel5a3d37f2009-06-29 20:45:18 +00001629 ModuleCU = Unit;
Devang Patelf97a05a2009-06-29 20:38:13 +00001630 }
Bill Wendlingf5839192009-05-20 23:19:06 +00001631
Devang Patel15e723d2009-08-28 23:24:31 +00001632 CompileUnitMap[DIUnit.getNode()] = Unit;
Bill Wendlingf5839192009-05-20 23:19:06 +00001633 CompileUnits.push_back(Unit);
Devang Patelb9f2c6b2009-12-11 21:37:07 +00001634 return Unit;
Bill Wendlingf5839192009-05-20 23:19:06 +00001635}
1636
Devang Patelc50078e2009-11-21 02:48:08 +00001637void DwarfDebug::constructGlobalVariableDIE(MDNode *N) {
Devang Patel15e723d2009-08-28 23:24:31 +00001638 DIGlobalVariable DI_GV(N);
Daniel Dunbar41716322009-09-19 20:40:05 +00001639
Devang Patel0c03f062009-09-04 23:59:07 +00001640 // If debug information is malformed then ignore it.
1641 if (DI_GV.Verify() == false)
1642 return;
Bill Wendlingf5839192009-05-20 23:19:06 +00001643
1644 // Check for pre-existence.
Devang Pateld90672c2009-11-20 21:37:22 +00001645 if (ModuleCU->getDIE(DI_GV.getNode()))
Devang Patel166f8432009-06-26 01:49:18 +00001646 return;
Bill Wendlingf5839192009-05-20 23:19:06 +00001647
Devang Patelfe0be132009-12-09 18:24:21 +00001648 DIE *VariableDie = createGlobalVariableDIE(DI_GV);
Devang Patel6d479632009-12-10 23:25:41 +00001649 if (!VariableDie)
1650 return;
Bill Wendlingf5839192009-05-20 23:19:06 +00001651
Bill Wendlingf5839192009-05-20 23:19:06 +00001652 // Add to map.
Devang Pateld90672c2009-11-20 21:37:22 +00001653 ModuleCU->insertDIE(N, VariableDie);
Bill Wendlingf5839192009-05-20 23:19:06 +00001654
1655 // Add to context owner.
Devang Patel8287d662009-12-15 19:16:48 +00001656 if (DI_GV.isDefinition()
1657 && !DI_GV.getContext().isCompileUnit()) {
1658 // Create specification DIE.
1659 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1660 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1661 dwarf::DW_FORM_ref4, VariableDie);
1662 DIEBlock *Block = new DIEBlock();
1663 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1664 addObjectLabel(Block, 0, dwarf::DW_FORM_udata,
1665 Asm->Mang->getMangledName(DI_GV.getGlobal()));
1666 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
1667 ModuleCU->addDie(VariableSpecDIE);
1668 } else {
1669 DIEBlock *Block = new DIEBlock();
1670 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1671 addObjectLabel(Block, 0, dwarf::DW_FORM_udata,
1672 Asm->Mang->getMangledName(DI_GV.getGlobal()));
1673 addBlock(VariableDie, dwarf::DW_AT_location, 0, Block);
1674 }
Devang Patel1a8f9a82009-12-10 19:14:49 +00001675 addToContextOwner(VariableDie, DI_GV.getContext());
1676
Bill Wendlingf5839192009-05-20 23:19:06 +00001677 // Expose as global. FIXME - need to check external flag.
Devang Patelc50078e2009-11-21 02:48:08 +00001678 ModuleCU->addGlobal(DI_GV.getName(), VariableDie);
Devang Patelec13b4f2009-11-24 01:14:22 +00001679
1680 DIType GTy = DI_GV.getType();
Devang Patel7f75bbe2009-11-25 17:36:49 +00001681 if (GTy.isCompositeType() && !GTy.getName().empty()) {
Devang Patelec13b4f2009-11-24 01:14:22 +00001682 DIEEntry *Entry = ModuleCU->getDIEEntry(GTy.getNode());
1683 assert (Entry && "Missing global type!");
1684 ModuleCU->addGlobalType(GTy.getName(), Entry->getEntry());
1685 }
Devang Patel166f8432009-06-26 01:49:18 +00001686 return;
Bill Wendlingf5839192009-05-20 23:19:06 +00001687}
1688
Devang Patelc50078e2009-11-21 02:48:08 +00001689void DwarfDebug::constructSubprogramDIE(MDNode *N) {
Devang Patel15e723d2009-08-28 23:24:31 +00001690 DISubprogram SP(N);
Bill Wendlingf5839192009-05-20 23:19:06 +00001691
1692 // Check for pre-existence.
Devang Pateld90672c2009-11-20 21:37:22 +00001693 if (ModuleCU->getDIE(N))
Devang Patel166f8432009-06-26 01:49:18 +00001694 return;
Bill Wendlingf5839192009-05-20 23:19:06 +00001695
1696 if (!SP.isDefinition())
1697 // This is a method declaration which will be handled while constructing
1698 // class type.
Devang Patel166f8432009-06-26 01:49:18 +00001699 return;
Bill Wendlingf5839192009-05-20 23:19:06 +00001700
Devang Patelfe0be132009-12-09 18:24:21 +00001701 DIE *SubprogramDie = createSubprogramDIE(SP);
Bill Wendlingf5839192009-05-20 23:19:06 +00001702
1703 // Add to map.
Devang Pateld90672c2009-11-20 21:37:22 +00001704 ModuleCU->insertDIE(N, SubprogramDie);
Bill Wendlingf5839192009-05-20 23:19:06 +00001705
1706 // Add to context owner.
Devang Patel8287d662009-12-15 19:16:48 +00001707 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patelde2d3682009-12-08 23:21:45 +00001708
Bill Wendlingf5839192009-05-20 23:19:06 +00001709 // Expose as global.
Devang Patelc50078e2009-11-21 02:48:08 +00001710 ModuleCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patelec13b4f2009-11-24 01:14:22 +00001711
Devang Patel166f8432009-06-26 01:49:18 +00001712 return;
Bill Wendlingf5839192009-05-20 23:19:06 +00001713}
1714
Devang Patelc50078e2009-11-21 02:48:08 +00001715/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbar19f1d442009-09-19 20:40:14 +00001716/// content. Create global DIEs and emit initial debug info sections.
1717/// This is inovked by the target AsmPrinter.
Devang Patelc50078e2009-11-21 02:48:08 +00001718void DwarfDebug::beginModule(Module *M, MachineModuleInfo *mmi) {
Devang Patel59a1d422009-06-25 22:36:02 +00001719 this->M = M;
1720
Bill Wendlingf5839192009-05-20 23:19:06 +00001721 if (TimePassesIsEnabled)
1722 DebugTimer->startTimer();
1723
Devang Patel1b4d6832009-11-11 19:55:08 +00001724 if (!MAI->doesSupportDebugInformation())
1725 return;
1726
Devang Patelfda766d2009-07-30 18:56:46 +00001727 DebugInfoFinder DbgFinder;
1728 DbgFinder.processModule(*M);
Devang Patel166f8432009-06-26 01:49:18 +00001729
Bill Wendlingf5839192009-05-20 23:19:06 +00001730 // Create all the compile unit DIEs.
Devang Patelfda766d2009-07-30 18:56:46 +00001731 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1732 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patelc50078e2009-11-21 02:48:08 +00001733 constructCompileUnit(*I);
Bill Wendlingf5839192009-05-20 23:19:06 +00001734
1735 if (CompileUnits.empty()) {
1736 if (TimePassesIsEnabled)
1737 DebugTimer->stopTimer();
1738
1739 return;
1740 }
1741
Devang Patelf97a05a2009-06-29 20:38:13 +00001742 // If main compile unit for this module is not seen than randomly
1743 // select first compile unit.
Devang Patel5a3d37f2009-06-29 20:45:18 +00001744 if (!ModuleCU)
1745 ModuleCU = CompileUnits[0];
Devang Patelf97a05a2009-06-29 20:38:13 +00001746
Devang Patel90a0fe32009-11-10 23:06:00 +00001747 // Create DIEs for each subprogram.
Devang Patelfda766d2009-07-30 18:56:46 +00001748 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
1749 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patelc50078e2009-11-21 02:48:08 +00001750 constructSubprogramDIE(*I);
Devang Patel166f8432009-06-26 01:49:18 +00001751
Devang Patel1a8f9a82009-12-10 19:14:49 +00001752 // Create DIEs for each global variable.
1753 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
1754 E = DbgFinder.global_variable_end(); I != E; ++I)
1755 constructGlobalVariableDIE(*I);
1756
Bill Wendlingf5839192009-05-20 23:19:06 +00001757 MMI = mmi;
1758 shouldEmit = true;
1759 MMI->setDebugInfoAvailability(true);
1760
1761 // Prime section data.
Chris Lattnerc4c40a92009-07-28 03:13:23 +00001762 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf5839192009-05-20 23:19:06 +00001763
1764 // Print out .file directives to specify files for .loc directives. These are
1765 // printed out early so that they precede any .loc directives.
Chris Lattnera5ef4d32009-08-22 21:43:10 +00001766 if (MAI->hasDotLocAndDotFile()) {
Bill Wendlingf5839192009-05-20 23:19:06 +00001767 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
1768 // Remember source id starts at 1.
1769 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
1770 sys::Path FullPath(getSourceDirectoryName(Id.first));
1771 bool AppendOk =
1772 FullPath.appendComponent(getSourceFileName(Id.second));
1773 assert(AppendOk && "Could not append filename to directory!");
1774 AppendOk = false;
Chris Lattnerb1aa85b2009-08-23 22:45:37 +00001775 Asm->EmitFile(i, FullPath.str());
Bill Wendlingf5839192009-05-20 23:19:06 +00001776 Asm->EOL();
1777 }
1778 }
1779
1780 // Emit initial sections
Devang Patelc50078e2009-11-21 02:48:08 +00001781 emitInitial();
Bill Wendlingf5839192009-05-20 23:19:06 +00001782
1783 if (TimePassesIsEnabled)
1784 DebugTimer->stopTimer();
1785}
1786
Devang Patelc50078e2009-11-21 02:48:08 +00001787/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendlingf5839192009-05-20 23:19:06 +00001788///
Devang Patelc50078e2009-11-21 02:48:08 +00001789void DwarfDebug::endModule() {
Devang Patel95d477e2009-10-06 00:03:14 +00001790 if (!ModuleCU)
Bill Wendlingf5839192009-05-20 23:19:06 +00001791 return;
1792
1793 if (TimePassesIsEnabled)
1794 DebugTimer->startTimer();
1795
Devang Patel90a0fe32009-11-10 23:06:00 +00001796 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1797 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
1798 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
1799 DIE *ISP = *AI;
Devang Patelc50078e2009-11-21 02:48:08 +00001800 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel90a0fe32009-11-10 23:06:00 +00001801 }
1802
Devang Patelc1df8792009-12-03 01:25:38 +00001803 // Insert top level DIEs.
1804 for (SmallVector<DIE *, 4>::iterator TI = TopLevelDIEsVector.begin(),
1805 TE = TopLevelDIEsVector.end(); TI != TE; ++TI)
1806 ModuleCU->getCUDie()->addChild(*TI);
1807
Devang Patel188c85d2009-12-03 19:11:07 +00001808 for (DenseMap<DIE *, WeakVH>::iterator CI = ContainingTypeMap.begin(),
1809 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
1810 DIE *SPDie = CI->first;
1811 MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
1812 if (!N) continue;
1813 DIE *NDie = ModuleCU->getDIE(N);
1814 if (!NDie) continue;
1815 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Patel69aae432010-01-15 00:26:31 +00001816 // FIXME - This is not the correct approach.
1817 // addDIEEntry(NDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Patel188c85d2009-12-03 19:11:07 +00001818 }
1819
Bill Wendlingf5839192009-05-20 23:19:06 +00001820 // Standard sections final addresses.
Chris Lattner73266f92009-08-19 05:49:37 +00001821 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf5839192009-05-20 23:19:06 +00001822 EmitLabel("text_end", 0);
Chris Lattner73266f92009-08-19 05:49:37 +00001823 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Bill Wendlingf5839192009-05-20 23:19:06 +00001824 EmitLabel("data_end", 0);
1825
1826 // End text sections.
1827 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner73266f92009-08-19 05:49:37 +00001828 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Bill Wendlingf5839192009-05-20 23:19:06 +00001829 EmitLabel("section_end", i);
1830 }
1831
1832 // Emit common frame information.
Devang Patelc50078e2009-11-21 02:48:08 +00001833 emitCommonDebugFrame();
Bill Wendlingf5839192009-05-20 23:19:06 +00001834
1835 // Emit function debug frame information
1836 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
1837 E = DebugFrames.end(); I != E; ++I)
Devang Patelc50078e2009-11-21 02:48:08 +00001838 emitFunctionDebugFrame(*I);
Bill Wendlingf5839192009-05-20 23:19:06 +00001839
1840 // Compute DIE offsets and sizes.
Devang Patelc50078e2009-11-21 02:48:08 +00001841 computeSizeAndOffsets();
Bill Wendlingf5839192009-05-20 23:19:06 +00001842
1843 // Emit all the DIEs into a debug info section
Devang Patelc50078e2009-11-21 02:48:08 +00001844 emitDebugInfo();
Bill Wendlingf5839192009-05-20 23:19:06 +00001845
1846 // Corresponding abbreviations into a abbrev section.
Devang Patelc50078e2009-11-21 02:48:08 +00001847 emitAbbreviations();
Bill Wendlingf5839192009-05-20 23:19:06 +00001848
1849 // Emit source line correspondence into a debug line section.
Devang Patelc50078e2009-11-21 02:48:08 +00001850 emitDebugLines();
Bill Wendlingf5839192009-05-20 23:19:06 +00001851
1852 // Emit info into a debug pubnames section.
Devang Patelc50078e2009-11-21 02:48:08 +00001853 emitDebugPubNames();
Bill Wendlingf5839192009-05-20 23:19:06 +00001854
Devang Patelec13b4f2009-11-24 01:14:22 +00001855 // Emit info into a debug pubtypes section.
1856 emitDebugPubTypes();
1857
Bill Wendlingf5839192009-05-20 23:19:06 +00001858 // Emit info into a debug str section.
Devang Patelc50078e2009-11-21 02:48:08 +00001859 emitDebugStr();
Bill Wendlingf5839192009-05-20 23:19:06 +00001860
1861 // Emit info into a debug loc section.
Devang Patelc50078e2009-11-21 02:48:08 +00001862 emitDebugLoc();
Bill Wendlingf5839192009-05-20 23:19:06 +00001863
1864 // Emit info into a debug aranges section.
1865 EmitDebugARanges();
1866
1867 // Emit info into a debug ranges section.
Devang Patelc50078e2009-11-21 02:48:08 +00001868 emitDebugRanges();
Bill Wendlingf5839192009-05-20 23:19:06 +00001869
1870 // Emit info into a debug macinfo section.
Devang Patelc50078e2009-11-21 02:48:08 +00001871 emitDebugMacInfo();
Bill Wendlingf5839192009-05-20 23:19:06 +00001872
1873 // Emit inline info.
Devang Patelc50078e2009-11-21 02:48:08 +00001874 emitDebugInlineInfo();
Bill Wendlingf5839192009-05-20 23:19:06 +00001875
1876 if (TimePassesIsEnabled)
1877 DebugTimer->stopTimer();
1878}
1879
Devang Patel90a0fe32009-11-10 23:06:00 +00001880/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbachb23f2422009-11-22 19:20:36 +00001881DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
1882 unsigned FrameIdx,
Devang Patel90a0fe32009-11-10 23:06:00 +00001883 DILocation &ScopeLoc) {
1884
1885 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var.getNode());
1886 if (AbsDbgVariable)
1887 return AbsDbgVariable;
1888
1889 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope().getNode());
1890 if (!Scope)
1891 return NULL;
1892
1893 AbsDbgVariable = new DbgVariable(Var, FrameIdx);
Devang Patelc50078e2009-11-21 02:48:08 +00001894 Scope->addVariable(AbsDbgVariable);
Devang Patel90a0fe32009-11-10 23:06:00 +00001895 AbstractVariables[Var.getNode()] = AbsDbgVariable;
1896 return AbsDbgVariable;
1897}
1898
Devang Patelc50078e2009-11-21 02:48:08 +00001899/// collectVariableInfo - Populate DbgScope entries with variables' info.
1900void DwarfDebug::collectVariableInfo() {
Devang Patel40c80212009-10-09 22:42:28 +00001901 if (!MMI) return;
Devang Patel90a0fe32009-11-10 23:06:00 +00001902
Devang Patel84139992009-10-06 01:26:37 +00001903 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1904 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1905 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel40c80212009-10-09 22:42:28 +00001906 MetadataBase *MB = VI->first;
1907 MDNode *Var = dyn_cast_or_null<MDNode>(MB);
Devang Patel90a0fe32009-11-10 23:06:00 +00001908 if (!Var) continue;
Devang Patel6882dff2009-10-08 18:48:03 +00001909 DIVariable DV (Var);
Devang Patel90a0fe32009-11-10 23:06:00 +00001910 std::pair< unsigned, MDNode *> VP = VI->second;
1911 DILocation ScopeLoc(VP.second);
1912
1913 DbgScope *Scope =
1914 ConcreteScopes.lookup(ScopeLoc.getOrigLocation().getNode());
1915 if (!Scope)
Jim Grosbach652b7432009-11-21 23:12:12 +00001916 Scope = DbgScopeMap.lookup(ScopeLoc.getScope().getNode());
Devang Patelbad42262009-11-10 23:20:04 +00001917 // If variable scope is not found then skip this variable.
1918 if (!Scope)
1919 continue;
Devang Patel90a0fe32009-11-10 23:06:00 +00001920
1921 DbgVariable *RegVar = new DbgVariable(DV, VP.first);
Devang Patelc50078e2009-11-21 02:48:08 +00001922 Scope->addVariable(RegVar);
Jim Grosbachb23f2422009-11-22 19:20:36 +00001923 if (DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.first,
1924 ScopeLoc))
Devang Patel90a0fe32009-11-10 23:06:00 +00001925 RegVar->setAbstractVariable(AbsDbgVariable);
Devang Patel84139992009-10-06 01:26:37 +00001926 }
1927}
1928
Devang Patelc50078e2009-11-21 02:48:08 +00001929/// beginScope - Process beginning of a scope starting at Label.
1930void DwarfDebug::beginScope(const MachineInstr *MI, unsigned Label) {
Devang Patel393a46d2009-10-06 01:50:42 +00001931 InsnToDbgScopeMapTy::iterator I = DbgScopeBeginMap.find(MI);
1932 if (I == DbgScopeBeginMap.end())
1933 return;
Dan Gohman8d34f972009-11-23 21:30:55 +00001934 ScopeVector &SD = I->second;
Devang Patel90a0fe32009-11-10 23:06:00 +00001935 for (ScopeVector::iterator SDI = SD.begin(), SDE = SD.end();
Jim Grosbach652b7432009-11-21 23:12:12 +00001936 SDI != SDE; ++SDI)
Devang Patel393a46d2009-10-06 01:50:42 +00001937 (*SDI)->setStartLabelID(Label);
1938}
1939
Devang Patelc50078e2009-11-21 02:48:08 +00001940/// endScope - Process end of a scope.
1941void DwarfDebug::endScope(const MachineInstr *MI) {
Devang Patel393a46d2009-10-06 01:50:42 +00001942 InsnToDbgScopeMapTy::iterator I = DbgScopeEndMap.find(MI);
Devang Patelf4348892009-10-06 03:15:38 +00001943 if (I == DbgScopeEndMap.end())
Devang Patel393a46d2009-10-06 01:50:42 +00001944 return;
Devang Patel90a0fe32009-11-10 23:06:00 +00001945
1946 unsigned Label = MMI->NextLabelID();
1947 Asm->printLabel(Label);
Dan Gohmancfca6e32009-12-05 01:42:34 +00001948 O << '\n';
Devang Patel90a0fe32009-11-10 23:06:00 +00001949
Devang Patel393a46d2009-10-06 01:50:42 +00001950 SmallVector<DbgScope *, 2> &SD = I->second;
1951 for (SmallVector<DbgScope *, 2>::iterator SDI = SD.begin(), SDE = SD.end();
Jim Grosbach652b7432009-11-21 23:12:12 +00001952 SDI != SDE; ++SDI)
Devang Patel393a46d2009-10-06 01:50:42 +00001953 (*SDI)->setEndLabelID(Label);
Devang Patel90a0fe32009-11-10 23:06:00 +00001954 return;
1955}
1956
1957/// createDbgScope - Create DbgScope for the scope.
1958void DwarfDebug::createDbgScope(MDNode *Scope, MDNode *InlinedAt) {
1959
1960 if (!InlinedAt) {
1961 DbgScope *WScope = DbgScopeMap.lookup(Scope);
1962 if (WScope)
1963 return;
1964 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
1965 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Jim Grosbach652b7432009-11-21 23:12:12 +00001966 if (DIDescriptor(Scope).isLexicalBlock())
Devang Patel53addbf2009-11-11 00:18:40 +00001967 createDbgScope(DILexicalBlock(Scope).getContext().getNode(), NULL);
Devang Patel90a0fe32009-11-10 23:06:00 +00001968 return;
1969 }
1970
1971 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
1972 if (WScope)
1973 return;
1974
1975 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
1976 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
1977 DILocation DL(InlinedAt);
1978 createDbgScope(DL.getScope().getNode(), DL.getOrigLocation().getNode());
Devang Patel393a46d2009-10-06 01:50:42 +00001979}
1980
Devang Patelc50078e2009-11-21 02:48:08 +00001981/// extractScopeInformation - Scan machine instructions in this function
Devang Patel6a260102009-10-01 20:31:14 +00001982/// and collect DbgScopes. Return true, if atleast one scope was found.
Devang Patelc50078e2009-11-21 02:48:08 +00001983bool DwarfDebug::extractScopeInformation(MachineFunction *MF) {
Devang Patel6a260102009-10-01 20:31:14 +00001984 // If scope information was extracted using .dbg intrinsics then there is not
1985 // any need to extract these information by scanning each instruction.
1986 if (!DbgScopeMap.empty())
1987 return false;
1988
Devang Patel98e77302010-01-04 20:44:00 +00001989 DenseMap<const MachineInstr *, unsigned> MIIndexMap;
1990 unsigned MIIndex = 0;
Devang Patel90a0fe32009-11-10 23:06:00 +00001991 // Scan each instruction and create scopes. First build working set of scopes.
Devang Patel6a260102009-10-01 20:31:14 +00001992 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
1993 I != E; ++I) {
1994 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1995 II != IE; ++II) {
1996 const MachineInstr *MInsn = II;
Devang Patel98e77302010-01-04 20:44:00 +00001997 MIIndexMap[MInsn] = MIIndex++;
Devang Patel6a260102009-10-01 20:31:14 +00001998 DebugLoc DL = MInsn->getDebugLoc();
Devang Patel90a0fe32009-11-10 23:06:00 +00001999 if (DL.isUnknown()) continue;
Devang Patel6a260102009-10-01 20:31:14 +00002000 DebugLocTuple DLT = MF->getDebugLocTuple(DL);
Devang Patel90a0fe32009-11-10 23:06:00 +00002001 if (!DLT.Scope) continue;
Devang Patel6a260102009-10-01 20:31:14 +00002002 // There is no need to create another DIE for compile unit. For all
Jim Grosbach652b7432009-11-21 23:12:12 +00002003 // other scopes, create one DbgScope now. This will be translated
Devang Patel6a260102009-10-01 20:31:14 +00002004 // into a scope DIE at the end.
Devang Patel90a0fe32009-11-10 23:06:00 +00002005 if (DIDescriptor(DLT.Scope).isCompileUnit()) continue;
2006 createDbgScope(DLT.Scope, DLT.InlinedAtLoc);
2007 }
2008 }
2009
2010
2011 // Build scope hierarchy using working set of scopes.
2012 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2013 I != E; ++I) {
2014 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2015 II != IE; ++II) {
2016 const MachineInstr *MInsn = II;
2017 DebugLoc DL = MInsn->getDebugLoc();
2018 if (DL.isUnknown()) continue;
2019 DebugLocTuple DLT = MF->getDebugLocTuple(DL);
2020 if (!DLT.Scope) continue;
2021 // There is no need to create another DIE for compile unit. For all
Jim Grosbach652b7432009-11-21 23:12:12 +00002022 // other scopes, create one DbgScope now. This will be translated
Devang Patel90a0fe32009-11-10 23:06:00 +00002023 // into a scope DIE at the end.
2024 if (DIDescriptor(DLT.Scope).isCompileUnit()) continue;
2025 DbgScope *Scope = getUpdatedDbgScope(DLT.Scope, MInsn, DLT.InlinedAtLoc);
2026 Scope->setLastInsn(MInsn);
Devang Patel6a260102009-10-01 20:31:14 +00002027 }
2028 }
2029
Devang Patel98e77302010-01-04 20:44:00 +00002030 if (!CurrentFnDbgScope)
2031 return false;
2032
2033 CurrentFnDbgScope->fixInstructionMarkers(MIIndexMap);
Devang Patel6a260102009-10-01 20:31:14 +00002034
2035 // Each scope has first instruction and last instruction to mark beginning
2036 // and end of a scope respectively. Create an inverse map that list scopes
2037 // starts (and ends) with an instruction. One instruction may start (or end)
2038 // multiple scopes.
Devang Patelf5278f22009-10-27 20:47:17 +00002039 for (ValueMap<MDNode *, DbgScope *>::iterator DI = DbgScopeMap.begin(),
Devang Patel6a260102009-10-01 20:31:14 +00002040 DE = DbgScopeMap.end(); DI != DE; ++DI) {
2041 DbgScope *S = DI->second;
Devang Patel90a0fe32009-11-10 23:06:00 +00002042 if (S->isAbstractScope())
2043 continue;
Devang Patel6a260102009-10-01 20:31:14 +00002044 const MachineInstr *MI = S->getFirstInsn();
2045 assert (MI && "DbgScope does not have first instruction!");
2046
2047 InsnToDbgScopeMapTy::iterator IDI = DbgScopeBeginMap.find(MI);
2048 if (IDI != DbgScopeBeginMap.end())
2049 IDI->second.push_back(S);
2050 else
Devang Patel90a0fe32009-11-10 23:06:00 +00002051 DbgScopeBeginMap[MI].push_back(S);
Devang Patel6a260102009-10-01 20:31:14 +00002052
2053 MI = S->getLastInsn();
2054 assert (MI && "DbgScope does not have last instruction!");
2055 IDI = DbgScopeEndMap.find(MI);
2056 if (IDI != DbgScopeEndMap.end())
2057 IDI->second.push_back(S);
2058 else
Devang Patel90a0fe32009-11-10 23:06:00 +00002059 DbgScopeEndMap[MI].push_back(S);
Devang Patel6a260102009-10-01 20:31:14 +00002060 }
2061
2062 return !DbgScopeMap.empty();
2063}
2064
Devang Patelc50078e2009-11-21 02:48:08 +00002065/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendlingf5839192009-05-20 23:19:06 +00002066/// emitted immediately after the function entry point.
Devang Patelc50078e2009-11-21 02:48:08 +00002067void DwarfDebug::beginFunction(MachineFunction *MF) {
Bill Wendlingf5839192009-05-20 23:19:06 +00002068 this->MF = MF;
2069
2070 if (!ShouldEmitDwarfDebug()) return;
2071
2072 if (TimePassesIsEnabled)
2073 DebugTimer->startTimer();
2074
Devang Patelc50078e2009-11-21 02:48:08 +00002075 if (!extractScopeInformation(MF))
Devang Patel0feae422009-10-06 18:37:31 +00002076 return;
Devang Patelc50078e2009-11-21 02:48:08 +00002077
2078 collectVariableInfo();
Devang Patel0feae422009-10-06 18:37:31 +00002079
Bill Wendlingf5839192009-05-20 23:19:06 +00002080 // Begin accumulating function debug information.
2081 MMI->BeginFunction(MF);
2082
2083 // Assumes in correct section after the entry point.
2084 EmitLabel("func_begin", ++SubprogramCount);
2085
2086 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2087 // function.
Devang Patel40c80212009-10-09 22:42:28 +00002088 DebugLoc FDL = MF->getDefaultDebugLoc();
2089 if (!FDL.isUnknown()) {
2090 DebugLocTuple DLT = MF->getDebugLocTuple(FDL);
2091 unsigned LabelID = 0;
Devang Patelfc1df342009-10-13 23:28:53 +00002092 DISubprogram SP = getDISubprogram(DLT.Scope);
Devang Patel40c80212009-10-09 22:42:28 +00002093 if (!SP.isNull())
Devang Patelc50078e2009-11-21 02:48:08 +00002094 LabelID = recordSourceLine(SP.getLineNumber(), 0, DLT.Scope);
Devang Patel40c80212009-10-09 22:42:28 +00002095 else
Devang Patelc50078e2009-11-21 02:48:08 +00002096 LabelID = recordSourceLine(DLT.Line, DLT.Col, DLT.Scope);
Devang Patel40c80212009-10-09 22:42:28 +00002097 Asm->printLabel(LabelID);
2098 O << '\n';
Bill Wendlingf5839192009-05-20 23:19:06 +00002099 }
Bill Wendlingf5839192009-05-20 23:19:06 +00002100 if (TimePassesIsEnabled)
2101 DebugTimer->stopTimer();
2102}
2103
Devang Patelc50078e2009-11-21 02:48:08 +00002104/// endFunction - Gather and emit post-function debug information.
Bill Wendlingf5839192009-05-20 23:19:06 +00002105///
Devang Patelc50078e2009-11-21 02:48:08 +00002106void DwarfDebug::endFunction(MachineFunction *MF) {
Bill Wendlingf5839192009-05-20 23:19:06 +00002107 if (!ShouldEmitDwarfDebug()) return;
2108
2109 if (TimePassesIsEnabled)
2110 DebugTimer->startTimer();
2111
Devang Patel40c80212009-10-09 22:42:28 +00002112 if (DbgScopeMap.empty())
2113 return;
Devang Patel4a7ef8d2009-11-12 19:02:56 +00002114
Devang Patel98e77302010-01-04 20:44:00 +00002115 if (CurrentFnDbgScope) {
2116 // Define end label for subprogram.
2117 EmitLabel("func_end", SubprogramCount);
2118
2119 // Get function line info.
2120 if (!Lines.empty()) {
2121 // Get section line info.
2122 unsigned ID = SectionMap.insert(Asm->getCurrentSection());
2123 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2124 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2125 // Append the function info to section info.
2126 SectionLineInfos.insert(SectionLineInfos.end(),
2127 Lines.begin(), Lines.end());
2128 }
2129
2130 // Construct abstract scopes.
2131 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
2132 AE = AbstractScopesList.end(); AI != AE; ++AI)
2133 constructScopeDIE(*AI);
2134
2135 constructScopeDIE(CurrentFnDbgScope);
2136
2137 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
2138 MMI->getFrameMoves()));
Bill Wendlingf5839192009-05-20 23:19:06 +00002139 }
2140
Bill Wendlingf5839192009-05-20 23:19:06 +00002141 // Clear debug info
Devang Patelb7074b02010-01-11 18:52:33 +00002142 if (CurrentFnDbgScope) {
2143 CurrentFnDbgScope = NULL;
2144 DbgScopeMap.clear();
2145 DbgScopeBeginMap.clear();
2146 DbgScopeEndMap.clear();
2147 ConcreteScopes.clear();
2148 AbstractScopesList.clear();
2149 }
Bill Wendlingf5839192009-05-20 23:19:06 +00002150 Lines.clear();
Devang Patel67533ab2009-12-01 18:13:48 +00002151
Bill Wendlingf5839192009-05-20 23:19:06 +00002152 if (TimePassesIsEnabled)
2153 DebugTimer->stopTimer();
2154}
2155
Devang Patelc50078e2009-11-21 02:48:08 +00002156/// recordSourceLine - Records location information and associates it with a
Bill Wendlingf5839192009-05-20 23:19:06 +00002157/// label. Returns a unique label ID used to generate a label and provide
2158/// correspondence to the source line list.
Jim Grosbach652b7432009-11-21 23:12:12 +00002159unsigned DwarfDebug::recordSourceLine(unsigned Line, unsigned Col,
Devang Patel946d0ae2009-10-05 18:03:19 +00002160 MDNode *S) {
Devang Patel15e723d2009-08-28 23:24:31 +00002161 if (!MMI)
2162 return 0;
2163
Bill Wendlingf5839192009-05-20 23:19:06 +00002164 if (TimePassesIsEnabled)
2165 DebugTimer->startTimer();
2166
Devang Patel7f75bbe2009-11-25 17:36:49 +00002167 StringRef Dir;
2168 StringRef Fn;
Devang Patel946d0ae2009-10-05 18:03:19 +00002169
2170 DIDescriptor Scope(S);
2171 if (Scope.isCompileUnit()) {
2172 DICompileUnit CU(S);
2173 Dir = CU.getDirectory();
2174 Fn = CU.getFilename();
2175 } else if (Scope.isSubprogram()) {
2176 DISubprogram SP(S);
2177 Dir = SP.getDirectory();
2178 Fn = SP.getFilename();
2179 } else if (Scope.isLexicalBlock()) {
2180 DILexicalBlock DB(S);
2181 Dir = DB.getDirectory();
2182 Fn = DB.getFilename();
2183 } else
2184 assert (0 && "Unexpected scope info");
2185
2186 unsigned Src = GetOrCreateSourceID(Dir, Fn);
Bill Wendlingf5839192009-05-20 23:19:06 +00002187 unsigned ID = MMI->NextLabelID();
2188 Lines.push_back(SrcLineInfo(Line, Col, Src, ID));
2189
2190 if (TimePassesIsEnabled)
2191 DebugTimer->stopTimer();
2192
2193 return ID;
2194}
2195
2196/// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be
2197/// timed. Look up the source id with the given directory and source file
2198/// names. If none currently exists, create a new id and insert it in the
2199/// SourceIds map. This can update DirectoryNames and SourceFileNames maps as
2200/// well.
2201unsigned DwarfDebug::getOrCreateSourceID(const std::string &DirName,
2202 const std::string &FileName) {
2203 if (TimePassesIsEnabled)
2204 DebugTimer->startTimer();
2205
Devang Patelaaf012e2009-09-29 18:40:58 +00002206 unsigned SrcId = GetOrCreateSourceID(DirName.c_str(), FileName.c_str());
Bill Wendlingf5839192009-05-20 23:19:06 +00002207
2208 if (TimePassesIsEnabled)
2209 DebugTimer->stopTimer();
2210
2211 return SrcId;
2212}
2213
Bill Wendlinge1a5bbb2009-05-20 23:22:40 +00002214//===----------------------------------------------------------------------===//
2215// Emit Methods
2216//===----------------------------------------------------------------------===//
2217
Devang Patelc50078e2009-11-21 02:48:08 +00002218/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling55fccda2009-05-20 23:21:38 +00002219///
Jim Grosbachb23f2422009-11-22 19:20:36 +00002220unsigned
2221DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling55fccda2009-05-20 23:21:38 +00002222 // Get the children.
2223 const std::vector<DIE *> &Children = Die->getChildren();
2224
2225 // If not last sibling and has children then add sibling offset attribute.
Devang Patelc50078e2009-11-21 02:48:08 +00002226 if (!Last && !Children.empty()) Die->addSiblingOffset();
Bill Wendling55fccda2009-05-20 23:21:38 +00002227
2228 // Record the abbreviation.
Devang Patelc50078e2009-11-21 02:48:08 +00002229 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling55fccda2009-05-20 23:21:38 +00002230
2231 // Get the abbreviation for this DIE.
2232 unsigned AbbrevNumber = Die->getAbbrevNumber();
2233 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2234
2235 // Set DIE offset
2236 Die->setOffset(Offset);
2237
2238 // Start the size with the size of abbreviation code.
Chris Lattner621c44d2009-08-22 20:48:53 +00002239 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling55fccda2009-05-20 23:21:38 +00002240
2241 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2242 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2243
2244 // Size the DIE attribute values.
2245 for (unsigned i = 0, N = Values.size(); i < N; ++i)
2246 // Size attribute value.
2247 Offset += Values[i]->SizeOf(TD, AbbrevData[i].getForm());
2248
2249 // Size the DIE children if any.
2250 if (!Children.empty()) {
2251 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
2252 "Children flag not set");
2253
2254 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patelc50078e2009-11-21 02:48:08 +00002255 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling55fccda2009-05-20 23:21:38 +00002256
2257 // End of children marker.
2258 Offset += sizeof(int8_t);
2259 }
2260
2261 Die->setSize(Offset - Die->getOffset());
2262 return Offset;
2263}
2264
Devang Patelc50078e2009-11-21 02:48:08 +00002265/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling55fccda2009-05-20 23:21:38 +00002266///
Devang Patelc50078e2009-11-21 02:48:08 +00002267void DwarfDebug::computeSizeAndOffsets() {
Bill Wendling55fccda2009-05-20 23:21:38 +00002268 // Compute size of compile unit header.
2269 static unsigned Offset =
2270 sizeof(int32_t) + // Length of Compilation Unit Info
2271 sizeof(int16_t) + // DWARF version number
2272 sizeof(int32_t) + // Offset Into Abbrev. Section
2273 sizeof(int8_t); // Pointer Size (in bytes)
2274
Devang Patelc50078e2009-11-21 02:48:08 +00002275 computeSizeAndOffset(ModuleCU->getCUDie(), Offset, true);
Devang Patel5a3d37f2009-06-29 20:45:18 +00002276 CompileUnitOffsets[ModuleCU] = 0;
Bill Wendling55fccda2009-05-20 23:21:38 +00002277}
2278
Devang Patelc50078e2009-11-21 02:48:08 +00002279/// emitInitial - Emit initial Dwarf declarations. This is necessary for cc
Bill Wendling55fccda2009-05-20 23:21:38 +00002280/// tools to recognize the object file contains Dwarf information.
Devang Patelc50078e2009-11-21 02:48:08 +00002281void DwarfDebug::emitInitial() {
Bill Wendling55fccda2009-05-20 23:21:38 +00002282 // Check to see if we already emitted intial headers.
2283 if (didInitial) return;
2284 didInitial = true;
2285
Chris Lattner73266f92009-08-19 05:49:37 +00002286 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbar41716322009-09-19 20:40:05 +00002287
Bill Wendling55fccda2009-05-20 23:21:38 +00002288 // Dwarf sections base addresses.
Chris Lattnera5ef4d32009-08-22 21:43:10 +00002289 if (MAI->doesDwarfRequireFrameSection()) {
Chris Lattner73266f92009-08-19 05:49:37 +00002290 Asm->OutStreamer.SwitchSection(TLOF.getDwarfFrameSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002291 EmitLabel("section_debug_frame", 0);
2292 }
2293
Chris Lattner73266f92009-08-19 05:49:37 +00002294 Asm->OutStreamer.SwitchSection(TLOF.getDwarfInfoSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002295 EmitLabel("section_info", 0);
Chris Lattner73266f92009-08-19 05:49:37 +00002296 Asm->OutStreamer.SwitchSection(TLOF.getDwarfAbbrevSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002297 EmitLabel("section_abbrev", 0);
Chris Lattner73266f92009-08-19 05:49:37 +00002298 Asm->OutStreamer.SwitchSection(TLOF.getDwarfARangesSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002299 EmitLabel("section_aranges", 0);
2300
Chris Lattner73266f92009-08-19 05:49:37 +00002301 if (const MCSection *LineInfoDirective = TLOF.getDwarfMacroInfoSection()) {
2302 Asm->OutStreamer.SwitchSection(LineInfoDirective);
Bill Wendling55fccda2009-05-20 23:21:38 +00002303 EmitLabel("section_macinfo", 0);
2304 }
2305
Chris Lattner73266f92009-08-19 05:49:37 +00002306 Asm->OutStreamer.SwitchSection(TLOF.getDwarfLineSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002307 EmitLabel("section_line", 0);
Chris Lattner73266f92009-08-19 05:49:37 +00002308 Asm->OutStreamer.SwitchSection(TLOF.getDwarfLocSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002309 EmitLabel("section_loc", 0);
Chris Lattner73266f92009-08-19 05:49:37 +00002310 Asm->OutStreamer.SwitchSection(TLOF.getDwarfPubNamesSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002311 EmitLabel("section_pubnames", 0);
Devang Patelec13b4f2009-11-24 01:14:22 +00002312 Asm->OutStreamer.SwitchSection(TLOF.getDwarfPubTypesSection());
2313 EmitLabel("section_pubtypes", 0);
Chris Lattner73266f92009-08-19 05:49:37 +00002314 Asm->OutStreamer.SwitchSection(TLOF.getDwarfStrSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002315 EmitLabel("section_str", 0);
Chris Lattner73266f92009-08-19 05:49:37 +00002316 Asm->OutStreamer.SwitchSection(TLOF.getDwarfRangesSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002317 EmitLabel("section_ranges", 0);
2318
Chris Lattner73266f92009-08-19 05:49:37 +00002319 Asm->OutStreamer.SwitchSection(TLOF.getTextSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002320 EmitLabel("text_begin", 0);
Chris Lattner73266f92009-08-19 05:49:37 +00002321 Asm->OutStreamer.SwitchSection(TLOF.getDataSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002322 EmitLabel("data_begin", 0);
2323}
2324
Devang Patelc50078e2009-11-21 02:48:08 +00002325/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling55fccda2009-05-20 23:21:38 +00002326///
Devang Patelc50078e2009-11-21 02:48:08 +00002327void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling55fccda2009-05-20 23:21:38 +00002328 // Get the abbreviation for this DIE.
2329 unsigned AbbrevNumber = Die->getAbbrevNumber();
2330 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2331
2332 Asm->EOL();
2333
2334 // Emit the code (index) for the abbreviation.
2335 Asm->EmitULEB128Bytes(AbbrevNumber);
2336
2337 if (Asm->isVerbose())
2338 Asm->EOL(std::string("Abbrev [" +
2339 utostr(AbbrevNumber) +
2340 "] 0x" + utohexstr(Die->getOffset()) +
2341 ":0x" + utohexstr(Die->getSize()) + " " +
2342 dwarf::TagString(Abbrev->getTag())));
2343 else
2344 Asm->EOL();
2345
2346 SmallVector<DIEValue*, 32> &Values = Die->getValues();
2347 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2348
2349 // Emit the DIE attribute values.
2350 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2351 unsigned Attr = AbbrevData[i].getAttribute();
2352 unsigned Form = AbbrevData[i].getForm();
2353 assert(Form && "Too many attributes for DIE (check abbreviation)");
2354
2355 switch (Attr) {
2356 case dwarf::DW_AT_sibling:
Devang Patelc50078e2009-11-21 02:48:08 +00002357 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling55fccda2009-05-20 23:21:38 +00002358 break;
2359 case dwarf::DW_AT_abstract_origin: {
2360 DIEEntry *E = cast<DIEEntry>(Values[i]);
2361 DIE *Origin = E->getEntry();
Devang Patel90a0fe32009-11-10 23:06:00 +00002362 unsigned Addr = Origin->getOffset();
Bill Wendling55fccda2009-05-20 23:21:38 +00002363 Asm->EmitInt32(Addr);
2364 break;
2365 }
2366 default:
2367 // Emit an attribute using the defined form.
2368 Values[i]->EmitValue(this, Form);
2369 break;
2370 }
2371
2372 Asm->EOL(dwarf::AttributeString(Attr));
2373 }
2374
2375 // Emit the DIE children if any.
2376 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2377 const std::vector<DIE *> &Children = Die->getChildren();
2378
2379 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patelc50078e2009-11-21 02:48:08 +00002380 emitDIE(Children[j]);
Bill Wendling55fccda2009-05-20 23:21:38 +00002381
2382 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2383 }
2384}
2385
Devang Patelfe0be132009-12-09 18:24:21 +00002386/// emitDebugInfo - Emit the debug info section.
Bill Wendling55fccda2009-05-20 23:21:38 +00002387///
Devang Patelfe0be132009-12-09 18:24:21 +00002388void DwarfDebug::emitDebugInfo() {
2389 // Start debug info section.
2390 Asm->OutStreamer.SwitchSection(
2391 Asm->getObjFileLowering().getDwarfInfoSection());
2392 DIE *Die = ModuleCU->getCUDie();
Bill Wendling55fccda2009-05-20 23:21:38 +00002393
2394 // Emit the compile units header.
Devang Patelfe0be132009-12-09 18:24:21 +00002395 EmitLabel("info_begin", ModuleCU->getID());
Bill Wendling55fccda2009-05-20 23:21:38 +00002396
2397 // Emit size of content not including length itself
2398 unsigned ContentSize = Die->getSize() +
2399 sizeof(int16_t) + // DWARF version number
2400 sizeof(int32_t) + // Offset Into Abbrev. Section
2401 sizeof(int8_t) + // Pointer Size (in bytes)
2402 sizeof(int32_t); // FIXME - extra pad for gdb bug.
2403
2404 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2405 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF version number");
2406 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2407 Asm->EOL("Offset Into Abbrev. Section");
2408 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2409
Devang Patelc50078e2009-11-21 02:48:08 +00002410 emitDIE(Die);
Bill Wendling55fccda2009-05-20 23:21:38 +00002411 // FIXME - extra padding for gdb bug.
2412 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2413 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2414 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2415 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
Devang Patelfe0be132009-12-09 18:24:21 +00002416 EmitLabel("info_end", ModuleCU->getID());
Bill Wendling55fccda2009-05-20 23:21:38 +00002417
2418 Asm->EOL();
Bill Wendling55fccda2009-05-20 23:21:38 +00002419}
2420
Devang Patelc50078e2009-11-21 02:48:08 +00002421/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling55fccda2009-05-20 23:21:38 +00002422///
Devang Patelc50078e2009-11-21 02:48:08 +00002423void DwarfDebug::emitAbbreviations() const {
Bill Wendling55fccda2009-05-20 23:21:38 +00002424 // Check to see if it is worth the effort.
2425 if (!Abbreviations.empty()) {
2426 // Start the debug abbrev section.
Chris Lattner73266f92009-08-19 05:49:37 +00002427 Asm->OutStreamer.SwitchSection(
2428 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002429
2430 EmitLabel("abbrev_begin", 0);
2431
2432 // For each abbrevation.
2433 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2434 // Get abbreviation data
2435 const DIEAbbrev *Abbrev = Abbreviations[i];
2436
2437 // Emit the abbrevations code (base 1 index.)
2438 Asm->EmitULEB128Bytes(Abbrev->getNumber());
2439 Asm->EOL("Abbreviation Code");
2440
2441 // Emit the abbreviations data.
2442 Abbrev->Emit(Asm);
2443
2444 Asm->EOL();
2445 }
2446
2447 // Mark end of abbreviations.
2448 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2449
2450 EmitLabel("abbrev_end", 0);
2451 Asm->EOL();
2452 }
2453}
2454
Devang Patelc50078e2009-11-21 02:48:08 +00002455/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling55fccda2009-05-20 23:21:38 +00002456/// the line matrix.
2457///
Devang Patelc50078e2009-11-21 02:48:08 +00002458void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling55fccda2009-05-20 23:21:38 +00002459 // Define last address of section.
2460 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2461 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2462 Asm->EmitInt8(dwarf::DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2463 EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2464
2465 // Mark end of matrix.
2466 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2467 Asm->EmitULEB128Bytes(1); Asm->EOL();
2468 Asm->EmitInt8(1); Asm->EOL();
2469}
2470
Devang Patelc50078e2009-11-21 02:48:08 +00002471/// emitDebugLines - Emit source line information.
Bill Wendling55fccda2009-05-20 23:21:38 +00002472///
Devang Patelc50078e2009-11-21 02:48:08 +00002473void DwarfDebug::emitDebugLines() {
Bill Wendling55fccda2009-05-20 23:21:38 +00002474 // If the target is using .loc/.file, the assembler will be emitting the
2475 // .debug_line table automatically.
Chris Lattnera5ef4d32009-08-22 21:43:10 +00002476 if (MAI->hasDotLocAndDotFile())
Bill Wendling55fccda2009-05-20 23:21:38 +00002477 return;
2478
2479 // Minimum line delta, thus ranging from -10..(255-10).
2480 const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
2481 // Maximum line delta, thus ranging from -10..(255-10).
2482 const int MaxLineDelta = 255 + MinLineDelta;
2483
2484 // Start the dwarf line section.
Chris Lattner73266f92009-08-19 05:49:37 +00002485 Asm->OutStreamer.SwitchSection(
2486 Asm->getObjFileLowering().getDwarfLineSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002487
2488 // Construct the section header.
2489 EmitDifference("line_end", 0, "line_begin", 0, true);
2490 Asm->EOL("Length of Source Line Info");
2491 EmitLabel("line_begin", 0);
2492
2493 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF version number");
2494
2495 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2496 Asm->EOL("Prolog Length");
2497 EmitLabel("line_prolog_begin", 0);
2498
2499 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2500
2501 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2502
2503 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
2504
2505 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2506
2507 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
2508
2509 // Line number standard opcode encodings argument count
2510 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2511 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2512 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2513 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2514 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2515 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2516 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2517 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2518 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2519
2520 // Emit directories.
2521 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
2522 Asm->EmitString(getSourceDirectoryName(DI));
2523 Asm->EOL("Directory");
2524 }
2525
2526 Asm->EmitInt8(0); Asm->EOL("End of directories");
2527
2528 // Emit files.
2529 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
2530 // Remember source id starts at 1.
2531 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
2532 Asm->EmitString(getSourceFileName(Id.second));
2533 Asm->EOL("Source");
2534 Asm->EmitULEB128Bytes(Id.first);
2535 Asm->EOL("Directory #");
2536 Asm->EmitULEB128Bytes(0);
2537 Asm->EOL("Mod date");
2538 Asm->EmitULEB128Bytes(0);
2539 Asm->EOL("File size");
2540 }
2541
2542 Asm->EmitInt8(0); Asm->EOL("End of files");
2543
2544 EmitLabel("line_prolog_end", 0);
2545
2546 // A sequence for each text section.
2547 unsigned SecSrcLinesSize = SectionSourceLines.size();
2548
2549 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
2550 // Isolate current sections line info.
2551 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
2552
Chris Lattner26aabb92009-08-08 23:39:42 +00002553 /*if (Asm->isVerbose()) {
Chris Lattnere6ad12f2009-07-31 18:48:30 +00002554 const MCSection *S = SectionMap[j + 1];
Chris Lattnera5ef4d32009-08-22 21:43:10 +00002555 O << '\t' << MAI->getCommentString() << " Section"
Bill Wendling55fccda2009-05-20 23:21:38 +00002556 << S->getName() << '\n';
Chris Lattner26aabb92009-08-08 23:39:42 +00002557 }*/
2558 Asm->EOL();
Bill Wendling55fccda2009-05-20 23:21:38 +00002559
2560 // Dwarf assumes we start with first line of first source file.
2561 unsigned Source = 1;
2562 unsigned Line = 1;
2563
2564 // Construct rows of the address, source, line, column matrix.
2565 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2566 const SrcLineInfo &LineInfo = LineInfos[i];
2567 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2568 if (!LabelID) continue;
2569
Caroline Tice9da96d82009-09-11 18:25:54 +00002570 if (LineInfo.getLine() == 0) continue;
2571
Bill Wendling55fccda2009-05-20 23:21:38 +00002572 if (!Asm->isVerbose())
2573 Asm->EOL();
2574 else {
2575 std::pair<unsigned, unsigned> SourceID =
2576 getSourceDirectoryAndFileIds(LineInfo.getSourceID());
Chris Lattnera5ef4d32009-08-22 21:43:10 +00002577 O << '\t' << MAI->getCommentString() << ' '
Dan Gohman1792bc62009-12-05 02:00:34 +00002578 << getSourceDirectoryName(SourceID.first) << '/'
Bill Wendling55fccda2009-05-20 23:21:38 +00002579 << getSourceFileName(SourceID.second)
Dan Gohman1792bc62009-12-05 02:00:34 +00002580 << ':' << utostr_32(LineInfo.getLine()) << '\n';
Bill Wendling55fccda2009-05-20 23:21:38 +00002581 }
2582
2583 // Define the line address.
2584 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2585 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2586 Asm->EmitInt8(dwarf::DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2587 EmitReference("label", LabelID); Asm->EOL("Location label");
2588
2589 // If change of source, then switch to the new source.
2590 if (Source != LineInfo.getSourceID()) {
2591 Source = LineInfo.getSourceID();
2592 Asm->EmitInt8(dwarf::DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2593 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2594 }
2595
2596 // If change of line.
2597 if (Line != LineInfo.getLine()) {
2598 // Determine offset.
2599 int Offset = LineInfo.getLine() - Line;
2600 int Delta = Offset - MinLineDelta;
2601
2602 // Update line.
2603 Line = LineInfo.getLine();
2604
2605 // If delta is small enough and in range...
2606 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2607 // ... then use fast opcode.
2608 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2609 } else {
2610 // ... otherwise use long hand.
2611 Asm->EmitInt8(dwarf::DW_LNS_advance_line);
2612 Asm->EOL("DW_LNS_advance_line");
2613 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2614 Asm->EmitInt8(dwarf::DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2615 }
2616 } else {
2617 // Copy the previous row (different address or source)
2618 Asm->EmitInt8(dwarf::DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2619 }
2620 }
2621
Devang Patelc50078e2009-11-21 02:48:08 +00002622 emitEndOfLineMatrix(j + 1);
Bill Wendling55fccda2009-05-20 23:21:38 +00002623 }
2624
2625 if (SecSrcLinesSize == 0)
2626 // Because we're emitting a debug_line section, we still need a line
2627 // table. The linker and friends expect it to exist. If there's nothing to
2628 // put into it, emit an empty table.
Devang Patelc50078e2009-11-21 02:48:08 +00002629 emitEndOfLineMatrix(1);
Bill Wendling55fccda2009-05-20 23:21:38 +00002630
2631 EmitLabel("line_end", 0);
2632 Asm->EOL();
2633}
2634
Devang Patelc50078e2009-11-21 02:48:08 +00002635/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling55fccda2009-05-20 23:21:38 +00002636///
Devang Patelc50078e2009-11-21 02:48:08 +00002637void DwarfDebug::emitCommonDebugFrame() {
Chris Lattnera5ef4d32009-08-22 21:43:10 +00002638 if (!MAI->doesDwarfRequireFrameSection())
Bill Wendling55fccda2009-05-20 23:21:38 +00002639 return;
2640
2641 int stackGrowth =
2642 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2643 TargetFrameInfo::StackGrowsUp ?
2644 TD->getPointerSize() : -TD->getPointerSize();
2645
2646 // Start the dwarf frame section.
Chris Lattner73266f92009-08-19 05:49:37 +00002647 Asm->OutStreamer.SwitchSection(
2648 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002649
2650 EmitLabel("debug_frame_common", 0);
2651 EmitDifference("debug_frame_common_end", 0,
2652 "debug_frame_common_begin", 0, true);
2653 Asm->EOL("Length of Common Information Entry");
2654
2655 EmitLabel("debug_frame_common_begin", 0);
2656 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
2657 Asm->EOL("CIE Identifier Tag");
2658 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
2659 Asm->EOL("CIE Version");
2660 Asm->EmitString("");
2661 Asm->EOL("CIE Augmentation");
2662 Asm->EmitULEB128Bytes(1);
2663 Asm->EOL("CIE Code Alignment Factor");
2664 Asm->EmitSLEB128Bytes(stackGrowth);
2665 Asm->EOL("CIE Data Alignment Factor");
2666 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
2667 Asm->EOL("CIE RA Column");
2668
2669 std::vector<MachineMove> Moves;
2670 RI->getInitialFrameState(Moves);
2671
2672 EmitFrameMoves(NULL, 0, Moves, false);
2673
2674 Asm->EmitAlignment(2, 0, 0, false);
2675 EmitLabel("debug_frame_common_end", 0);
2676
2677 Asm->EOL();
2678}
2679
Devang Patelc50078e2009-11-21 02:48:08 +00002680/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling55fccda2009-05-20 23:21:38 +00002681/// section.
2682void
Devang Patelc50078e2009-11-21 02:48:08 +00002683DwarfDebug::emitFunctionDebugFrame(const FunctionDebugFrameInfo&DebugFrameInfo){
Chris Lattnera5ef4d32009-08-22 21:43:10 +00002684 if (!MAI->doesDwarfRequireFrameSection())
Bill Wendling55fccda2009-05-20 23:21:38 +00002685 return;
2686
2687 // Start the dwarf frame section.
Chris Lattner73266f92009-08-19 05:49:37 +00002688 Asm->OutStreamer.SwitchSection(
2689 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002690
2691 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2692 "debug_frame_begin", DebugFrameInfo.Number, true);
2693 Asm->EOL("Length of Frame Information Entry");
2694
2695 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2696
2697 EmitSectionOffset("debug_frame_common", "section_debug_frame",
2698 0, 0, true, false);
2699 Asm->EOL("FDE CIE offset");
2700
2701 EmitReference("func_begin", DebugFrameInfo.Number);
2702 Asm->EOL("FDE initial location");
2703 EmitDifference("func_end", DebugFrameInfo.Number,
2704 "func_begin", DebugFrameInfo.Number);
2705 Asm->EOL("FDE address range");
2706
2707 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves,
2708 false);
2709
2710 Asm->EmitAlignment(2, 0, 0, false);
2711 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2712
2713 Asm->EOL();
2714}
2715
Devang Patelfe0be132009-12-09 18:24:21 +00002716/// emitDebugPubNames - Emit visible names into a debug pubnames section.
2717///
2718void DwarfDebug::emitDebugPubNames() {
2719 // Start the dwarf pubnames section.
2720 Asm->OutStreamer.SwitchSection(
2721 Asm->getObjFileLowering().getDwarfPubNamesSection());
2722
2723 EmitDifference("pubnames_end", ModuleCU->getID(),
2724 "pubnames_begin", ModuleCU->getID(), true);
Bill Wendling55fccda2009-05-20 23:21:38 +00002725 Asm->EOL("Length of Public Names Info");
2726
Devang Patelfe0be132009-12-09 18:24:21 +00002727 EmitLabel("pubnames_begin", ModuleCU->getID());
Bill Wendling55fccda2009-05-20 23:21:38 +00002728
2729 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF Version");
2730
2731 EmitSectionOffset("info_begin", "section_info",
Devang Patelfe0be132009-12-09 18:24:21 +00002732 ModuleCU->getID(), 0, true, false);
Bill Wendling55fccda2009-05-20 23:21:38 +00002733 Asm->EOL("Offset of Compilation Unit Info");
2734
Devang Patelfe0be132009-12-09 18:24:21 +00002735 EmitDifference("info_end", ModuleCU->getID(), "info_begin", ModuleCU->getID(),
Bill Wendling55fccda2009-05-20 23:21:38 +00002736 true);
2737 Asm->EOL("Compilation Unit Length");
2738
Devang Patelfe0be132009-12-09 18:24:21 +00002739 const StringMap<DIE*> &Globals = ModuleCU->getGlobals();
Bill Wendling55fccda2009-05-20 23:21:38 +00002740 for (StringMap<DIE*>::const_iterator
2741 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2742 const char *Name = GI->getKeyData();
2743 DIE * Entity = GI->second;
2744
2745 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2746 Asm->EmitString(Name, strlen(Name)); Asm->EOL("External Name");
2747 }
2748
2749 Asm->EmitInt32(0); Asm->EOL("End Mark");
Devang Patelfe0be132009-12-09 18:24:21 +00002750 EmitLabel("pubnames_end", ModuleCU->getID());
Bill Wendling55fccda2009-05-20 23:21:38 +00002751
2752 Asm->EOL();
2753}
2754
Devang Patelec13b4f2009-11-24 01:14:22 +00002755void DwarfDebug::emitDebugPubTypes() {
Devang Patel6f2bdd52009-11-24 19:18:41 +00002756 // Start the dwarf pubnames section.
2757 Asm->OutStreamer.SwitchSection(
2758 Asm->getObjFileLowering().getDwarfPubTypesSection());
Devang Patelec13b4f2009-11-24 01:14:22 +00002759 EmitDifference("pubtypes_end", ModuleCU->getID(),
2760 "pubtypes_begin", ModuleCU->getID(), true);
2761 Asm->EOL("Length of Public Types Info");
2762
2763 EmitLabel("pubtypes_begin", ModuleCU->getID());
2764
2765 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF Version");
2766
2767 EmitSectionOffset("info_begin", "section_info",
2768 ModuleCU->getID(), 0, true, false);
2769 Asm->EOL("Offset of Compilation ModuleCU Info");
2770
2771 EmitDifference("info_end", ModuleCU->getID(), "info_begin", ModuleCU->getID(),
2772 true);
2773 Asm->EOL("Compilation ModuleCU Length");
2774
2775 const StringMap<DIE*> &Globals = ModuleCU->getGlobalTypes();
2776 for (StringMap<DIE*>::const_iterator
2777 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2778 const char *Name = GI->getKeyData();
2779 DIE * Entity = GI->second;
2780
2781 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2782 Asm->EmitString(Name, strlen(Name)); Asm->EOL("External Name");
2783 }
2784
2785 Asm->EmitInt32(0); Asm->EOL("End Mark");
2786 EmitLabel("pubtypes_end", ModuleCU->getID());
2787
2788 Asm->EOL();
2789}
2790
Devang Patelc50078e2009-11-21 02:48:08 +00002791/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling55fccda2009-05-20 23:21:38 +00002792///
Devang Patelc50078e2009-11-21 02:48:08 +00002793void DwarfDebug::emitDebugStr() {
Bill Wendling55fccda2009-05-20 23:21:38 +00002794 // Check to see if it is worth the effort.
2795 if (!StringPool.empty()) {
2796 // Start the dwarf str section.
Chris Lattner73266f92009-08-19 05:49:37 +00002797 Asm->OutStreamer.SwitchSection(
2798 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002799
2800 // For each of strings in the string pool.
2801 for (unsigned StringID = 1, N = StringPool.size();
2802 StringID <= N; ++StringID) {
2803 // Emit a label for reference from debug information entries.
2804 EmitLabel("string", StringID);
2805
2806 // Emit the string itself.
2807 const std::string &String = StringPool[StringID];
2808 Asm->EmitString(String); Asm->EOL();
2809 }
2810
2811 Asm->EOL();
2812 }
2813}
2814
Devang Patelc50078e2009-11-21 02:48:08 +00002815/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling55fccda2009-05-20 23:21:38 +00002816///
Devang Patelc50078e2009-11-21 02:48:08 +00002817void DwarfDebug::emitDebugLoc() {
Bill Wendling55fccda2009-05-20 23:21:38 +00002818 // Start the dwarf loc section.
Chris Lattner73266f92009-08-19 05:49:37 +00002819 Asm->OutStreamer.SwitchSection(
2820 Asm->getObjFileLowering().getDwarfLocSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002821 Asm->EOL();
2822}
2823
2824/// EmitDebugARanges - Emit visible names into a debug aranges section.
2825///
2826void DwarfDebug::EmitDebugARanges() {
2827 // Start the dwarf aranges section.
Chris Lattner73266f92009-08-19 05:49:37 +00002828 Asm->OutStreamer.SwitchSection(
2829 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002830
2831 // FIXME - Mock up
2832#if 0
2833 CompileUnit *Unit = GetBaseCompileUnit();
2834
2835 // Don't include size of length
2836 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
2837
2838 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("Dwarf Version");
2839
2840 EmitReference("info_begin", Unit->getID());
2841 Asm->EOL("Offset of Compilation Unit Info");
2842
2843 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
2844
2845 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2846
2847 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
2848 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
2849
2850 // Range 1
2851 EmitReference("text_begin", 0); Asm->EOL("Address");
2852 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2853
2854 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2855 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
2856#endif
2857
2858 Asm->EOL();
2859}
2860
Devang Patelc50078e2009-11-21 02:48:08 +00002861/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling55fccda2009-05-20 23:21:38 +00002862///
Devang Patelc50078e2009-11-21 02:48:08 +00002863void DwarfDebug::emitDebugRanges() {
Bill Wendling55fccda2009-05-20 23:21:38 +00002864 // Start the dwarf ranges section.
Chris Lattner73266f92009-08-19 05:49:37 +00002865 Asm->OutStreamer.SwitchSection(
2866 Asm->getObjFileLowering().getDwarfRangesSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002867 Asm->EOL();
2868}
2869
Devang Patelc50078e2009-11-21 02:48:08 +00002870/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling55fccda2009-05-20 23:21:38 +00002871///
Devang Patelc50078e2009-11-21 02:48:08 +00002872void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbar41716322009-09-19 20:40:05 +00002873 if (const MCSection *LineInfo =
Chris Lattner72d228d2009-08-02 07:24:22 +00002874 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling55fccda2009-05-20 23:21:38 +00002875 // Start the dwarf macinfo section.
Chris Lattner73266f92009-08-19 05:49:37 +00002876 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling55fccda2009-05-20 23:21:38 +00002877 Asm->EOL();
2878 }
2879}
2880
Devang Patelc50078e2009-11-21 02:48:08 +00002881/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling55fccda2009-05-20 23:21:38 +00002882/// Section Header:
2883/// 1. length of section
2884/// 2. Dwarf version number
2885/// 3. address size.
2886///
2887/// Entries (one "entry" for each function that was inlined):
2888///
2889/// 1. offset into __debug_str section for MIPS linkage name, if exists;
2890/// otherwise offset into __debug_str for regular function name.
2891/// 2. offset into __debug_str section for regular function name.
2892/// 3. an unsigned LEB128 number indicating the number of distinct inlining
2893/// instances for the function.
2894///
2895/// The rest of the entry consists of a {die_offset, low_pc} pair for each
2896/// inlined instance; the die_offset points to the inlined_subroutine die in the
2897/// __debug_info section, and the low_pc is the starting address for the
2898/// inlining instance.
Devang Patelc50078e2009-11-21 02:48:08 +00002899void DwarfDebug::emitDebugInlineInfo() {
Chris Lattnera5ef4d32009-08-22 21:43:10 +00002900 if (!MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling55fccda2009-05-20 23:21:38 +00002901 return;
2902
Devang Patel5a3d37f2009-06-29 20:45:18 +00002903 if (!ModuleCU)
Bill Wendling55fccda2009-05-20 23:21:38 +00002904 return;
2905
Chris Lattner73266f92009-08-19 05:49:37 +00002906 Asm->OutStreamer.SwitchSection(
2907 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002908 Asm->EOL();
2909 EmitDifference("debug_inlined_end", 1,
2910 "debug_inlined_begin", 1, true);
2911 Asm->EOL("Length of Debug Inlined Information Entry");
2912
2913 EmitLabel("debug_inlined_begin", 1);
2914
2915 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("Dwarf Version");
2916 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2917
Devang Patel90a0fe32009-11-10 23:06:00 +00002918 for (SmallVector<MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
2919 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach652b7432009-11-21 23:12:12 +00002920
Devang Patel90a0fe32009-11-10 23:06:00 +00002921 MDNode *Node = *I;
Jim Grosbachb23f2422009-11-22 19:20:36 +00002922 ValueMap<MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
2923 = InlineInfo.find(Node);
Devang Patel90a0fe32009-11-10 23:06:00 +00002924 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patel15e723d2009-08-28 23:24:31 +00002925 DISubprogram SP(Node);
Devang Patel7f75bbe2009-11-25 17:36:49 +00002926 StringRef LName = SP.getLinkageName();
2927 StringRef Name = SP.getName();
Bill Wendling55fccda2009-05-20 23:21:38 +00002928
Devang Patel7f75bbe2009-11-25 17:36:49 +00002929 if (LName.empty())
Devang Patel76031e82009-07-16 01:01:22 +00002930 Asm->EmitString(Name);
Devang Patel141e1c42010-01-05 01:46:14 +00002931 else
Devang Patel90a0fe32009-11-10 23:06:00 +00002932 EmitSectionOffset("string", "section_str",
Devang Patel141e1c42010-01-05 01:46:14 +00002933 StringPool.idFor(getRealLinkageName(LName)), false, true);
Devang Patel90a0fe32009-11-10 23:06:00 +00002934
Bill Wendling55fccda2009-05-20 23:21:38 +00002935 Asm->EOL("MIPS linkage name");
Devang Patel90a0fe32009-11-10 23:06:00 +00002936 EmitSectionOffset("string", "section_str",
2937 StringPool.idFor(Name), false, true);
2938 Asm->EOL("Function name");
Bill Wendling55fccda2009-05-20 23:21:38 +00002939 Asm->EmitULEB128Bytes(Labels.size()); Asm->EOL("Inline count");
2940
Devang Patel90a0fe32009-11-10 23:06:00 +00002941 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling55fccda2009-05-20 23:21:38 +00002942 LE = Labels.end(); LI != LE; ++LI) {
Devang Patel90a0fe32009-11-10 23:06:00 +00002943 DIE *SP = LI->second;
Bill Wendling55fccda2009-05-20 23:21:38 +00002944 Asm->EmitInt32(SP->getOffset()); Asm->EOL("DIE offset");
2945
2946 if (TD->getPointerSize() == sizeof(int32_t))
Chris Lattnera5ef4d32009-08-22 21:43:10 +00002947 O << MAI->getData32bitsDirective();
Bill Wendling55fccda2009-05-20 23:21:38 +00002948 else
Chris Lattnera5ef4d32009-08-22 21:43:10 +00002949 O << MAI->getData64bitsDirective();
Bill Wendling55fccda2009-05-20 23:21:38 +00002950
Devang Patel90a0fe32009-11-10 23:06:00 +00002951 PrintLabelName("label", LI->first); Asm->EOL("low_pc");
Bill Wendling55fccda2009-05-20 23:21:38 +00002952 }
2953 }
2954
2955 EmitLabel("debug_inlined_end", 1);
2956 Asm->EOL();
2957}