blob: 7717922305f20fecf426e0cb6fd6aded99ceb10d [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"
Chris Lattner31a54742010-01-16 21:57:06 +000021#include "llvm/Target/Mangler.h"
Bill Wendlingb12b3d72009-05-15 09:23:25 +000022#include "llvm/Target/TargetData.h"
23#include "llvm/Target/TargetFrameInfo.h"
Chris Lattnerc4c40a92009-07-28 03:13:23 +000024#include "llvm/Target/TargetLoweringObjectFile.h"
25#include "llvm/Target/TargetRegisterInfo.h"
Chris Lattnerf5377682009-08-24 03:52:50 +000026#include "llvm/ADT/StringExtras.h"
Daniel Dunbarc74255d2009-10-13 06:47:08 +000027#include "llvm/Support/Debug.h"
28#include "llvm/Support/ErrorHandling.h"
Chris Lattnerad653482010-01-22 22:09:00 +000029#include "llvm/Support/FormattedStream.h"
Chris Lattnere6ad12f2009-07-31 18:48:30 +000030#include "llvm/Support/Timer.h"
31#include "llvm/System/Path.h"
Bill Wendlingb12b3d72009-05-15 09:23:25 +000032using namespace llvm;
33
Bill Wendlingb12b3d72009-05-15 09:23:25 +000034//===----------------------------------------------------------------------===//
35
36/// Configuration values for initial hash set sizes (log2).
37///
Bill Wendlingb12b3d72009-05-15 09:23:25 +000038static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
Bill Wendlingb12b3d72009-05-15 09:23:25 +000039
40namespace llvm {
41
42//===----------------------------------------------------------------------===//
43/// CompileUnit - This dwarf writer support class manages information associate
44/// with a source file.
Nick Lewyckyee68f452009-11-17 08:11:44 +000045class CompileUnit {
Bill Wendlingb12b3d72009-05-15 09:23:25 +000046 /// ID - File identifier for source.
47 ///
48 unsigned ID;
49
50 /// Die - Compile unit debug information entry.
51 ///
Devang Patelc50078e2009-11-21 02:48:08 +000052 DIE *CUDie;
Bill Wendlingb12b3d72009-05-15 09:23:25 +000053
Devang Patel1233f912009-11-21 00:31:03 +000054 /// IndexTyDie - An anonymous type for index type.
55 DIE *IndexTyDie;
56
Bill Wendlingb12b3d72009-05-15 09:23:25 +000057 /// GVToDieMap - Tracks the mapping of unit level debug informaton
58 /// variables to debug information entries.
Devang Patel15e723d2009-08-28 23:24:31 +000059 /// FIXME : Rename GVToDieMap -> NodeToDieMap
Devang Patel7d707f92010-01-19 06:19:05 +000060 DenseMap<MDNode *, DIE *> GVToDieMap;
Bill Wendlingb12b3d72009-05-15 09:23:25 +000061
62 /// GVToDIEEntryMap - Tracks the mapping of unit level debug informaton
63 /// descriptors to debug information entries using a DIEEntry proxy.
Devang Patel15e723d2009-08-28 23:24:31 +000064 /// FIXME : Rename
Devang Patel7d707f92010-01-19 06:19:05 +000065 DenseMap<MDNode *, DIEEntry *> GVToDIEEntryMap;
Bill Wendlingb12b3d72009-05-15 09:23:25 +000066
67 /// Globals - A map of globally visible named entities for this unit.
68 ///
69 StringMap<DIE*> Globals;
70
Devang Patelec13b4f2009-11-24 01:14:22 +000071 /// GlobalTypes - A map of globally visible types for this unit.
72 ///
73 StringMap<DIE*> GlobalTypes;
74
Bill Wendlingb12b3d72009-05-15 09:23:25 +000075public:
76 CompileUnit(unsigned I, DIE *D)
Devang Patelc50078e2009-11-21 02:48:08 +000077 : ID(I), CUDie(D), IndexTyDie(0) {}
78 ~CompileUnit() { delete CUDie; delete IndexTyDie; }
Bill Wendlingb12b3d72009-05-15 09:23:25 +000079
80 // Accessors.
Devang Patelec13b4f2009-11-24 01:14:22 +000081 unsigned getID() const { return ID; }
82 DIE* getCUDie() const { return CUDie; }
83 const StringMap<DIE*> &getGlobals() const { return Globals; }
84 const StringMap<DIE*> &getGlobalTypes() const { return GlobalTypes; }
Bill Wendlingb12b3d72009-05-15 09:23:25 +000085
86 /// hasContent - Return true if this compile unit has something to write out.
87 ///
Devang Patelc50078e2009-11-21 02:48:08 +000088 bool hasContent() const { return !CUDie->getChildren().empty(); }
Bill Wendlingb12b3d72009-05-15 09:23:25 +000089
Devang Patelc50078e2009-11-21 02:48:08 +000090 /// addGlobal - Add a new global entity to the compile unit.
Bill Wendlingb12b3d72009-05-15 09:23:25 +000091 ///
Devang Patelc50078e2009-11-21 02:48:08 +000092 void addGlobal(const std::string &Name, DIE *Die) { Globals[Name] = Die; }
Bill Wendlingb12b3d72009-05-15 09:23:25 +000093
Devang Patelec13b4f2009-11-24 01:14:22 +000094 /// addGlobalType - Add a new global type to the compile unit.
95 ///
96 void addGlobalType(const std::string &Name, DIE *Die) {
97 GlobalTypes[Name] = Die;
98 }
99
Devang Pateld90672c2009-11-20 21:37:22 +0000100 /// getDIE - Returns the debug information entry map slot for the
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000101 /// specified debug variable.
Devang Pateld90672c2009-11-20 21:37:22 +0000102 DIE *getDIE(MDNode *N) { return GVToDieMap.lookup(N); }
Jim Grosbach652b7432009-11-21 23:12:12 +0000103
Devang Pateld90672c2009-11-20 21:37:22 +0000104 /// insertDIE - Insert DIE into the map.
105 void insertDIE(MDNode *N, DIE *D) {
106 GVToDieMap.insert(std::make_pair(N, D));
107 }
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000108
Devang Pateld90672c2009-11-20 21:37:22 +0000109 /// getDIEEntry - Returns the debug information entry for the speciefied
110 /// debug variable.
Devang Patel8287d662009-12-15 19:16:48 +0000111 DIEEntry *getDIEEntry(MDNode *N) {
Devang Patel7d707f92010-01-19 06:19:05 +0000112 DenseMap<MDNode *, DIEEntry *>::iterator I = GVToDIEEntryMap.find(N);
Devang Patel8287d662009-12-15 19:16:48 +0000113 if (I == GVToDIEEntryMap.end())
114 return NULL;
115 return I->second;
116 }
Devang Pateld90672c2009-11-20 21:37:22 +0000117
118 /// insertDIEEntry - Insert debug information entry into the map.
119 void insertDIEEntry(MDNode *N, DIEEntry *E) {
120 GVToDIEEntryMap.insert(std::make_pair(N, E));
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000121 }
122
Devang Patelc50078e2009-11-21 02:48:08 +0000123 /// addDie - Adds or interns the DIE to the compile unit.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000124 ///
Devang Patelc50078e2009-11-21 02:48:08 +0000125 void addDie(DIE *Buffer) {
126 this->CUDie->addChild(Buffer);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000127 }
Devang Patel1233f912009-11-21 00:31:03 +0000128
129 // getIndexTyDie - Get an anonymous type for index type.
130 DIE *getIndexTyDie() {
131 return IndexTyDie;
132 }
133
Jim Grosbachb23f2422009-11-22 19:20:36 +0000134 // setIndexTyDie - Set D as anonymous type for index which can be reused
135 // later.
Devang Patel1233f912009-11-21 00:31:03 +0000136 void setIndexTyDie(DIE *D) {
137 IndexTyDie = D;
138 }
139
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000140};
141
142//===----------------------------------------------------------------------===//
143/// DbgVariable - This class is used to track local variable information.
144///
Devang Patel4cb32c32009-11-16 21:53:40 +0000145class DbgVariable {
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000146 DIVariable Var; // Variable Descriptor.
147 unsigned FrameIndex; // Variable frame index.
Devang Patel90a0fe32009-11-10 23:06:00 +0000148 DbgVariable *AbstractVar; // Abstract variable for this variable.
149 DIE *TheDIE;
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000150public:
Devang Patel90a0fe32009-11-10 23:06:00 +0000151 DbgVariable(DIVariable V, unsigned I)
152 : Var(V), FrameIndex(I), AbstractVar(0), TheDIE(0) {}
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000153
154 // Accessors.
Devang Patel90a0fe32009-11-10 23:06:00 +0000155 DIVariable getVariable() const { return Var; }
156 unsigned getFrameIndex() const { return FrameIndex; }
157 void setAbstractVariable(DbgVariable *V) { AbstractVar = V; }
158 DbgVariable *getAbstractVariable() const { return AbstractVar; }
159 void setDIE(DIE *D) { TheDIE = D; }
160 DIE *getDIE() const { return TheDIE; }
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000161};
162
163//===----------------------------------------------------------------------===//
164/// DbgScope - This class is used to track scope information.
165///
Devang Patel4cb32c32009-11-16 21:53:40 +0000166class DbgScope {
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000167 DbgScope *Parent; // Parent to this scope.
Jim Grosbach652b7432009-11-21 23:12:12 +0000168 DIDescriptor Desc; // Debug info descriptor for scope.
Devang Patel7a165652010-01-16 06:17:40 +0000169 MDNode * InlinedAtLocation; // Location at which scope is inlined.
Devang Patel90a0fe32009-11-10 23:06:00 +0000170 bool AbstractScope; // Abstract Scope
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000171 unsigned StartLabelID; // Label ID of the beginning of scope.
172 unsigned EndLabelID; // Label ID of the end of scope.
Devang Patel90ecd192009-10-01 18:25:23 +0000173 const MachineInstr *LastInsn; // Last instruction of this scope.
174 const MachineInstr *FirstInsn; // First instruction of this scope.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000175 SmallVector<DbgScope *, 4> Scopes; // Scopes defined in scope.
176 SmallVector<DbgVariable *, 8> Variables;// Variables declared in scope.
Daniel Dunbar41716322009-09-19 20:40:05 +0000177
Owen Anderson696d4862009-06-24 22:53:20 +0000178 // Private state for dump()
179 mutable unsigned IndentLevel;
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000180public:
Devang Pateldd7bb432009-10-14 21:08:09 +0000181 DbgScope(DbgScope *P, DIDescriptor D, MDNode *I = 0)
Devang Patel90a0fe32009-11-10 23:06:00 +0000182 : Parent(P), Desc(D), InlinedAtLocation(I), AbstractScope(false),
Jim Grosbach652b7432009-11-21 23:12:12 +0000183 StartLabelID(0), EndLabelID(0),
Devang Pateldd7bb432009-10-14 21:08:09 +0000184 LastInsn(0), FirstInsn(0), IndentLevel(0) {}
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000185 virtual ~DbgScope();
186
187 // Accessors.
188 DbgScope *getParent() const { return Parent; }
Devang Patel90a0fe32009-11-10 23:06:00 +0000189 void setParent(DbgScope *P) { Parent = P; }
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000190 DIDescriptor getDesc() const { return Desc; }
Jim Grosbach652b7432009-11-21 23:12:12 +0000191 MDNode *getInlinedAt() const {
Devang Patel90a0fe32009-11-10 23:06:00 +0000192 return dyn_cast_or_null<MDNode>(InlinedAtLocation);
Devang Pateldd7bb432009-10-14 21:08:09 +0000193 }
Devang Patel90a0fe32009-11-10 23:06:00 +0000194 MDNode *getScopeNode() const { return Desc.getNode(); }
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000195 unsigned getStartLabelID() const { return StartLabelID; }
196 unsigned getEndLabelID() const { return EndLabelID; }
197 SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
198 SmallVector<DbgVariable *, 8> &getVariables() { return Variables; }
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000199 void setStartLabelID(unsigned S) { StartLabelID = S; }
200 void setEndLabelID(unsigned E) { EndLabelID = E; }
Devang Patel90ecd192009-10-01 18:25:23 +0000201 void setLastInsn(const MachineInstr *MI) { LastInsn = MI; }
202 const MachineInstr *getLastInsn() { return LastInsn; }
203 void setFirstInsn(const MachineInstr *MI) { FirstInsn = MI; }
Devang Patel90a0fe32009-11-10 23:06:00 +0000204 void setAbstractScope() { AbstractScope = true; }
205 bool isAbstractScope() const { return AbstractScope; }
Devang Patel90ecd192009-10-01 18:25:23 +0000206 const MachineInstr *getFirstInsn() { return FirstInsn; }
Devang Patel90a0fe32009-11-10 23:06:00 +0000207
Devang Patelc50078e2009-11-21 02:48:08 +0000208 /// addScope - Add a scope to the scope.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000209 ///
Devang Patelc50078e2009-11-21 02:48:08 +0000210 void addScope(DbgScope *S) { Scopes.push_back(S); }
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000211
Devang Patelc50078e2009-11-21 02:48:08 +0000212 /// addVariable - Add a variable to the scope.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000213 ///
Devang Patelc50078e2009-11-21 02:48:08 +0000214 void addVariable(DbgVariable *V) { Variables.push_back(V); }
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000215
Devang Patel98e77302010-01-04 20:44:00 +0000216 void fixInstructionMarkers(DenseMap<const MachineInstr *,
217 unsigned> &MIIndexMap) {
Devang Patel6a260102009-10-01 20:31:14 +0000218 assert (getFirstInsn() && "First instruction is missing!");
Devang Patel98e77302010-01-04 20:44:00 +0000219
220 // Use the end of last child scope as end of this scope.
Devang Patel6a260102009-10-01 20:31:14 +0000221 SmallVector<DbgScope *, 4> &Scopes = getScopes();
Devang Patel3b620bf2010-01-05 16:59:17 +0000222 const MachineInstr *LastInsn = getFirstInsn();
Devang Patel98e77302010-01-04 20:44:00 +0000223 unsigned LIndex = 0;
224 if (Scopes.empty()) {
225 assert (getLastInsn() && "Inner most scope does not have last insn!");
226 return;
227 }
228 for (SmallVector<DbgScope *, 4>::iterator SI = Scopes.begin(),
229 SE = Scopes.end(); SI != SE; ++SI) {
230 DbgScope *DS = *SI;
231 DS->fixInstructionMarkers(MIIndexMap);
232 const MachineInstr *DSLastInsn = DS->getLastInsn();
233 unsigned DSI = MIIndexMap[DSLastInsn];
234 if (DSI > LIndex) {
235 LastInsn = DSLastInsn;
236 LIndex = DSI;
237 }
238 }
239 setLastInsn(LastInsn);
Devang Patel6a260102009-10-01 20:31:14 +0000240 }
241
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000242#ifndef NDEBUG
243 void dump() const;
244#endif
245};
246
247#ifndef NDEBUG
248void DbgScope::dump() const {
David Greenedbc06132009-12-24 00:31:35 +0000249 raw_ostream &err = dbgs();
Chris Lattnerebb8c082009-08-23 00:51:00 +0000250 err.indent(IndentLevel);
Devang Patel90a0fe32009-11-10 23:06:00 +0000251 MDNode *N = Desc.getNode();
252 N->dump();
Chris Lattnerebb8c082009-08-23 00:51:00 +0000253 err << " [" << StartLabelID << ", " << EndLabelID << "]\n";
Devang Patel90a0fe32009-11-10 23:06:00 +0000254 if (AbstractScope)
255 err << "Abstract Scope\n";
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000256
257 IndentLevel += 2;
Devang Patel90a0fe32009-11-10 23:06:00 +0000258 if (!Scopes.empty())
259 err << "Children ...\n";
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000260 for (unsigned i = 0, e = Scopes.size(); i != e; ++i)
261 if (Scopes[i] != this)
262 Scopes[i]->dump();
263
264 IndentLevel -= 2;
265}
266#endif
267
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000268DbgScope::~DbgScope() {
269 for (unsigned i = 0, N = Scopes.size(); i < N; ++i)
270 delete Scopes[i];
271 for (unsigned j = 0, M = Variables.size(); j < M; ++j)
272 delete Variables[j];
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000273}
274
275} // end llvm namespace
276
Chris Lattner621c44d2009-08-22 20:48:53 +0000277DwarfDebug::DwarfDebug(raw_ostream &OS, AsmPrinter *A, const MCAsmInfo *T)
Devang Patel5a3d37f2009-06-29 20:45:18 +0000278 : Dwarf(OS, A, T, "dbg"), ModuleCU(0),
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000279 AbbreviationsSet(InitAbbreviationsSetSize), Abbreviations(),
Devang Patelc50078e2009-11-21 02:48:08 +0000280 DIEValues(), StringPool(),
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000281 SectionSourceLines(), didInitial(false), shouldEmit(false),
Devang Patel90a0fe32009-11-10 23:06:00 +0000282 CurrentFnDbgScope(0), DebugTimer(0) {
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000283 if (TimePassesIsEnabled)
Chris Lattner13bf2e52009-12-28 07:41:18 +0000284 DebugTimer = new Timer("Dwarf Debug Writer");
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000285}
286DwarfDebug::~DwarfDebug() {
Devang Patelc50078e2009-11-21 02:48:08 +0000287 for (unsigned j = 0, M = DIEValues.size(); j < M; ++j)
288 delete DIEValues[j];
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000289
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000290 delete DebugTimer;
291}
292
Devang Patelc50078e2009-11-21 02:48:08 +0000293/// assignAbbrevNumber - Define a unique number for the abbreviation.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000294///
Devang Patelc50078e2009-11-21 02:48:08 +0000295void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000296 // Profile the node so that we can make it unique.
297 FoldingSetNodeID ID;
298 Abbrev.Profile(ID);
299
300 // Check the set for priors.
301 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
302
303 // If it's newly added.
304 if (InSet == &Abbrev) {
305 // Add to abbreviation list.
306 Abbreviations.push_back(&Abbrev);
307
308 // Assign the vector position + 1 as its number.
309 Abbrev.setNumber(Abbreviations.size());
310 } else {
311 // Assign existing abbreviation number.
312 Abbrev.setNumber(InSet->getNumber());
313 }
314}
315
Devang Patelc50078e2009-11-21 02:48:08 +0000316/// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
Bill Wendling0d3db8b2009-05-20 23:24:48 +0000317/// information entry.
Devang Patelc50078e2009-11-21 02:48:08 +0000318DIEEntry *DwarfDebug::createDIEEntry(DIE *Entry) {
Devang Patel1233f912009-11-21 00:31:03 +0000319 DIEEntry *Value = new DIEEntry(Entry);
Devang Patelc50078e2009-11-21 02:48:08 +0000320 DIEValues.push_back(Value);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000321 return Value;
322}
323
Devang Patelc50078e2009-11-21 02:48:08 +0000324/// addUInt - Add an unsigned integer attribute data and value.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000325///
Devang Patelc50078e2009-11-21 02:48:08 +0000326void DwarfDebug::addUInt(DIE *Die, unsigned Attribute,
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000327 unsigned Form, uint64_t Integer) {
328 if (!Form) Form = DIEInteger::BestForm(false, Integer);
Devang Patel1233f912009-11-21 00:31:03 +0000329 DIEValue *Value = new DIEInteger(Integer);
Devang Patelc50078e2009-11-21 02:48:08 +0000330 DIEValues.push_back(Value);
331 Die->addValue(Attribute, Form, Value);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000332}
333
Devang Patelc50078e2009-11-21 02:48:08 +0000334/// addSInt - Add an signed integer attribute data and value.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000335///
Devang Patelc50078e2009-11-21 02:48:08 +0000336void DwarfDebug::addSInt(DIE *Die, unsigned Attribute,
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000337 unsigned Form, int64_t Integer) {
338 if (!Form) Form = DIEInteger::BestForm(true, Integer);
Devang Patel1233f912009-11-21 00:31:03 +0000339 DIEValue *Value = new DIEInteger(Integer);
Devang Patelc50078e2009-11-21 02:48:08 +0000340 DIEValues.push_back(Value);
341 Die->addValue(Attribute, Form, Value);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000342}
343
Devang Pateldf0f2152009-12-02 15:25:16 +0000344/// addString - Add a string attribute data and value. DIEString only
345/// keeps string reference.
Devang Patelc50078e2009-11-21 02:48:08 +0000346void DwarfDebug::addString(DIE *Die, unsigned Attribute, unsigned Form,
Devang Patelc10337d2009-11-24 19:42:17 +0000347 const StringRef String) {
Devang Patel1233f912009-11-21 00:31:03 +0000348 DIEValue *Value = new DIEString(String);
Devang Patelc50078e2009-11-21 02:48:08 +0000349 DIEValues.push_back(Value);
350 Die->addValue(Attribute, Form, Value);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000351}
352
Devang Patelc50078e2009-11-21 02:48:08 +0000353/// addLabel - Add a Dwarf label attribute data and value.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000354///
Devang Patelc50078e2009-11-21 02:48:08 +0000355void DwarfDebug::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000356 const DWLabel &Label) {
Devang Patel1233f912009-11-21 00:31:03 +0000357 DIEValue *Value = new DIEDwarfLabel(Label);
Devang Patelc50078e2009-11-21 02:48:08 +0000358 DIEValues.push_back(Value);
359 Die->addValue(Attribute, Form, Value);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000360}
361
Devang Patelc50078e2009-11-21 02:48:08 +0000362/// addObjectLabel - Add an non-Dwarf label attribute data and value.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000363///
Devang Patelc50078e2009-11-21 02:48:08 +0000364void DwarfDebug::addObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
Chris Lattner41e330f2010-01-16 18:50:28 +0000365 const MCSymbol *Sym) {
366 DIEValue *Value = new DIEObjectLabel(Sym);
Devang Patelc50078e2009-11-21 02:48:08 +0000367 DIEValues.push_back(Value);
368 Die->addValue(Attribute, Form, Value);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000369}
370
Devang Patelc50078e2009-11-21 02:48:08 +0000371/// addSectionOffset - Add a section offset label attribute data and value.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000372///
Devang Patelc50078e2009-11-21 02:48:08 +0000373void DwarfDebug::addSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000374 const DWLabel &Label, const DWLabel &Section,
375 bool isEH, bool useSet) {
Devang Patel1233f912009-11-21 00:31:03 +0000376 DIEValue *Value = new DIESectionOffset(Label, Section, isEH, useSet);
Devang Patelc50078e2009-11-21 02:48:08 +0000377 DIEValues.push_back(Value);
378 Die->addValue(Attribute, Form, Value);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000379}
380
Devang Patelc50078e2009-11-21 02:48:08 +0000381/// addDelta - Add a label delta attribute data and value.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000382///
Devang Patelc50078e2009-11-21 02:48:08 +0000383void DwarfDebug::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000384 const DWLabel &Hi, const DWLabel &Lo) {
Devang Patel1233f912009-11-21 00:31:03 +0000385 DIEValue *Value = new DIEDelta(Hi, Lo);
Devang Patelc50078e2009-11-21 02:48:08 +0000386 DIEValues.push_back(Value);
387 Die->addValue(Attribute, Form, Value);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000388}
389
Devang Patelc50078e2009-11-21 02:48:08 +0000390/// addBlock - Add block data.
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000391///
Devang Patelc50078e2009-11-21 02:48:08 +0000392void DwarfDebug::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000393 DIEBlock *Block) {
394 Block->ComputeSize(TD);
Devang Patelc50078e2009-11-21 02:48:08 +0000395 DIEValues.push_back(Block);
396 Die->addValue(Attribute, Block->BestForm(), Block);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000397}
398
Devang Patelc50078e2009-11-21 02:48:08 +0000399/// addSourceLine - Add location information to specified debug information
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000400/// entry.
Devang Patelc50078e2009-11-21 02:48:08 +0000401void DwarfDebug::addSourceLine(DIE *Die, const DIVariable *V) {
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000402 // If there is no compile unit specified, don't add a line #.
403 if (V->getCompileUnit().isNull())
404 return;
405
406 unsigned Line = V->getLineNumber();
Devang Patelb9f2c6b2009-12-11 21:37:07 +0000407 unsigned FileID = findCompileUnit(V->getCompileUnit())->getID();
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000408 assert(FileID && "Invalid file id");
Devang Patelc50078e2009-11-21 02:48:08 +0000409 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
410 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000411}
412
Devang Patelc50078e2009-11-21 02:48:08 +0000413/// addSourceLine - Add location information to specified debug information
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000414/// entry.
Devang Patelc50078e2009-11-21 02:48:08 +0000415void DwarfDebug::addSourceLine(DIE *Die, const DIGlobal *G) {
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000416 // If there is no compile unit specified, don't add a line #.
417 if (G->getCompileUnit().isNull())
418 return;
419
420 unsigned Line = G->getLineNumber();
Devang Patelb9f2c6b2009-12-11 21:37:07 +0000421 unsigned FileID = findCompileUnit(G->getCompileUnit())->getID();
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000422 assert(FileID && "Invalid file id");
Devang Patelc50078e2009-11-21 02:48:08 +0000423 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
424 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000425}
Devang Patel318d70d2009-08-31 22:47:13 +0000426
Devang Patelc50078e2009-11-21 02:48:08 +0000427/// addSourceLine - Add location information to specified debug information
Devang Patel318d70d2009-08-31 22:47:13 +0000428/// entry.
Devang Patelc50078e2009-11-21 02:48:08 +0000429void DwarfDebug::addSourceLine(DIE *Die, const DISubprogram *SP) {
Devang Patel318d70d2009-08-31 22:47:13 +0000430 // If there is no compile unit specified, don't add a line #.
431 if (SP->getCompileUnit().isNull())
432 return;
Caroline Tice9da96d82009-09-11 18:25:54 +0000433 // If the line number is 0, don't add it.
434 if (SP->getLineNumber() == 0)
435 return;
436
Devang Patel318d70d2009-08-31 22:47:13 +0000437
438 unsigned Line = SP->getLineNumber();
Devang Patelb9f2c6b2009-12-11 21:37:07 +0000439 unsigned FileID = findCompileUnit(SP->getCompileUnit())->getID();
Devang Patel318d70d2009-08-31 22:47:13 +0000440 assert(FileID && "Invalid file id");
Devang Patelc50078e2009-11-21 02:48:08 +0000441 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
442 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Devang Patel318d70d2009-08-31 22:47:13 +0000443}
444
Devang Patelc50078e2009-11-21 02:48:08 +0000445/// addSourceLine - Add location information to specified debug information
Devang Patel318d70d2009-08-31 22:47:13 +0000446/// entry.
Devang Patelc50078e2009-11-21 02:48:08 +0000447void DwarfDebug::addSourceLine(DIE *Die, const DIType *Ty) {
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000448 // If there is no compile unit specified, don't add a line #.
449 DICompileUnit CU = Ty->getCompileUnit();
450 if (CU.isNull())
451 return;
452
453 unsigned Line = Ty->getLineNumber();
Devang Patelb9f2c6b2009-12-11 21:37:07 +0000454 unsigned FileID = findCompileUnit(CU)->getID();
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000455 assert(FileID && "Invalid file id");
Devang Patelc50078e2009-11-21 02:48:08 +0000456 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
457 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000458}
459
Devang Patel8287d662009-12-15 19:16:48 +0000460/// addSourceLine - Add location information to specified debug information
461/// entry.
462void DwarfDebug::addSourceLine(DIE *Die, const DINameSpace *NS) {
463 // If there is no compile unit specified, don't add a line #.
464 if (NS->getCompileUnit().isNull())
465 return;
466
467 unsigned Line = NS->getLineNumber();
468 StringRef FN = NS->getFilename();
469 StringRef Dir = NS->getDirectory();
470
471 unsigned FileID = GetOrCreateSourceID(Dir, FN);
472 assert(FileID && "Invalid file id");
473 addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
474 addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
475}
476
Caroline Tice248d5572009-08-31 21:19:37 +0000477/* Byref variables, in Blocks, are declared by the programmer as
478 "SomeType VarName;", but the compiler creates a
479 __Block_byref_x_VarName struct, and gives the variable VarName
480 either the struct, or a pointer to the struct, as its type. This
481 is necessary for various behind-the-scenes things the compiler
482 needs to do with by-reference variables in blocks.
483
484 However, as far as the original *programmer* is concerned, the
485 variable should still have type 'SomeType', as originally declared.
486
487 The following function dives into the __Block_byref_x_VarName
488 struct to find the original type of the variable. This will be
489 passed back to the code generating the type for the Debug
490 Information Entry for the variable 'VarName'. 'VarName' will then
491 have the original type 'SomeType' in its debug information.
492
493 The original type 'SomeType' will be the type of the field named
494 'VarName' inside the __Block_byref_x_VarName struct.
495
496 NOTE: In order for this to not completely fail on the debugger
497 side, the Debug Information Entry for the variable VarName needs to
498 have a DW_AT_location that tells the debugger how to unwind through
499 the pointers and __Block_byref_x_VarName struct to find the actual
Devang Patelc50078e2009-11-21 02:48:08 +0000500 value of the variable. The function addBlockByrefType does this. */
Caroline Tice248d5572009-08-31 21:19:37 +0000501
502/// Find the type the programmer originally declared the variable to be
503/// and return that type.
504///
Devang Patelc50078e2009-11-21 02:48:08 +0000505DIType DwarfDebug::getBlockByrefType(DIType Ty, std::string Name) {
Caroline Tice248d5572009-08-31 21:19:37 +0000506
507 DIType subType = Ty;
508 unsigned tag = Ty.getTag();
509
510 if (tag == dwarf::DW_TAG_pointer_type) {
Mike Stumpb22cd0f2009-09-30 00:08:22 +0000511 DIDerivedType DTy = DIDerivedType(Ty.getNode());
Caroline Tice248d5572009-08-31 21:19:37 +0000512 subType = DTy.getTypeDerivedFrom();
513 }
514
515 DICompositeType blockStruct = DICompositeType(subType.getNode());
516
517 DIArray Elements = blockStruct.getTypeArray();
518
519 if (Elements.isNull())
520 return Ty;
521
522 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
523 DIDescriptor Element = Elements.getElement(i);
524 DIDerivedType DT = DIDerivedType(Element.getNode());
Devang Patel7f75bbe2009-11-25 17:36:49 +0000525 if (Name == DT.getName())
Caroline Tice248d5572009-08-31 21:19:37 +0000526 return (DT.getTypeDerivedFrom());
527 }
528
529 return Ty;
530}
531
Devang Patelc50078e2009-11-21 02:48:08 +0000532/// addComplexAddress - Start with the address based on the location provided,
Mike Stumpb22cd0f2009-09-30 00:08:22 +0000533/// and generate the DWARF information necessary to find the actual variable
534/// given the extra address information encoded in the DIVariable, starting from
535/// the starting location. Add the DWARF information to the die.
536///
Devang Patelc50078e2009-11-21 02:48:08 +0000537void DwarfDebug::addComplexAddress(DbgVariable *&DV, DIE *Die,
Mike Stumpb22cd0f2009-09-30 00:08:22 +0000538 unsigned Attribute,
539 const MachineLocation &Location) {
540 const DIVariable &VD = DV->getVariable();
541 DIType Ty = VD.getType();
542
543 // Decode the original location, and use that as the start of the byref
544 // variable's location.
545 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
546 DIEBlock *Block = new DIEBlock();
547
548 if (Location.isReg()) {
549 if (Reg < 32) {
Devang Patelc50078e2009-11-21 02:48:08 +0000550 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Mike Stumpb22cd0f2009-09-30 00:08:22 +0000551 } else {
552 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patelc50078e2009-11-21 02:48:08 +0000553 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
554 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stumpb22cd0f2009-09-30 00:08:22 +0000555 }
556 } else {
557 if (Reg < 32)
Devang Patelc50078e2009-11-21 02:48:08 +0000558 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Mike Stumpb22cd0f2009-09-30 00:08:22 +0000559 else {
Devang Patelc50078e2009-11-21 02:48:08 +0000560 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
561 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Mike Stumpb22cd0f2009-09-30 00:08:22 +0000562 }
563
Devang Patelc50078e2009-11-21 02:48:08 +0000564 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Mike Stumpb22cd0f2009-09-30 00:08:22 +0000565 }
566
567 for (unsigned i = 0, N = VD.getNumAddrElements(); i < N; ++i) {
568 uint64_t Element = VD.getAddrElement(i);
569
570 if (Element == DIFactory::OpPlus) {
Devang Patelc50078e2009-11-21 02:48:08 +0000571 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
572 addUInt(Block, 0, dwarf::DW_FORM_udata, VD.getAddrElement(++i));
Mike Stumpb22cd0f2009-09-30 00:08:22 +0000573 } else if (Element == DIFactory::OpDeref) {
Devang Patelc50078e2009-11-21 02:48:08 +0000574 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Mike Stumpb22cd0f2009-09-30 00:08:22 +0000575 } else llvm_unreachable("unknown DIFactory Opcode");
576 }
577
578 // Now attach the location information to the DIE.
Devang Patelc50078e2009-11-21 02:48:08 +0000579 addBlock(Die, Attribute, 0, Block);
Mike Stumpb22cd0f2009-09-30 00:08:22 +0000580}
581
Caroline Tice248d5572009-08-31 21:19:37 +0000582/* Byref variables, in Blocks, are declared by the programmer as "SomeType
583 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
584 gives the variable VarName either the struct, or a pointer to the struct, as
585 its type. This is necessary for various behind-the-scenes things the
586 compiler needs to do with by-reference variables in Blocks.
587
588 However, as far as the original *programmer* is concerned, the variable
589 should still have type 'SomeType', as originally declared.
590
Devang Patelc50078e2009-11-21 02:48:08 +0000591 The function getBlockByrefType dives into the __Block_byref_x_VarName
Caroline Tice248d5572009-08-31 21:19:37 +0000592 struct to find the original type of the variable, which is then assigned to
593 the variable's Debug Information Entry as its real type. So far, so good.
594 However now the debugger will expect the variable VarName to have the type
595 SomeType. So we need the location attribute for the variable to be an
Daniel Dunbar41716322009-09-19 20:40:05 +0000596 expression that explains to the debugger how to navigate through the
Caroline Tice248d5572009-08-31 21:19:37 +0000597 pointers and struct to find the actual variable of type SomeType.
598
599 The following function does just that. We start by getting
600 the "normal" location for the variable. This will be the location
601 of either the struct __Block_byref_x_VarName or the pointer to the
602 struct __Block_byref_x_VarName.
603
604 The struct will look something like:
605
606 struct __Block_byref_x_VarName {
607 ... <various fields>
608 struct __Block_byref_x_VarName *forwarding;
609 ... <various other fields>
610 SomeType VarName;
611 ... <maybe more fields>
612 };
613
614 If we are given the struct directly (as our starting point) we
615 need to tell the debugger to:
616
617 1). Add the offset of the forwarding field.
618
619 2). Follow that pointer to get the the real __Block_byref_x_VarName
620 struct to use (the real one may have been copied onto the heap).
621
622 3). Add the offset for the field VarName, to find the actual variable.
623
624 If we started with a pointer to the struct, then we need to
625 dereference that pointer first, before the other steps.
626 Translating this into DWARF ops, we will need to append the following
627 to the current location description for the variable:
628
629 DW_OP_deref -- optional, if we start with a pointer
630 DW_OP_plus_uconst <forward_fld_offset>
631 DW_OP_deref
632 DW_OP_plus_uconst <varName_fld_offset>
633
634 That is what this function does. */
635
Devang Patelc50078e2009-11-21 02:48:08 +0000636/// addBlockByrefAddress - Start with the address based on the location
Caroline Tice248d5572009-08-31 21:19:37 +0000637/// provided, and generate the DWARF information necessary to find the
638/// actual Block variable (navigating the Block struct) based on the
639/// starting location. Add the DWARF information to the die. For
640/// more information, read large comment just above here.
641///
Devang Patelc50078e2009-11-21 02:48:08 +0000642void DwarfDebug::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000643 unsigned Attribute,
644 const MachineLocation &Location) {
Caroline Tice248d5572009-08-31 21:19:37 +0000645 const DIVariable &VD = DV->getVariable();
646 DIType Ty = VD.getType();
647 DIType TmpTy = Ty;
648 unsigned Tag = Ty.getTag();
649 bool isPointer = false;
650
Devang Patel7f75bbe2009-11-25 17:36:49 +0000651 StringRef varName = VD.getName();
Caroline Tice248d5572009-08-31 21:19:37 +0000652
653 if (Tag == dwarf::DW_TAG_pointer_type) {
Mike Stumpb22cd0f2009-09-30 00:08:22 +0000654 DIDerivedType DTy = DIDerivedType(Ty.getNode());
Caroline Tice248d5572009-08-31 21:19:37 +0000655 TmpTy = DTy.getTypeDerivedFrom();
656 isPointer = true;
657 }
658
659 DICompositeType blockStruct = DICompositeType(TmpTy.getNode());
660
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000661 // Find the __forwarding field and the variable field in the __Block_byref
662 // struct.
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000663 DIArray Fields = blockStruct.getTypeArray();
664 DIDescriptor varField = DIDescriptor();
665 DIDescriptor forwardingField = DIDescriptor();
Caroline Tice248d5572009-08-31 21:19:37 +0000666
667
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000668 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
669 DIDescriptor Element = Fields.getElement(i);
670 DIDerivedType DT = DIDerivedType(Element.getNode());
Devang Patel7f75bbe2009-11-25 17:36:49 +0000671 StringRef fieldName = DT.getName();
672 if (fieldName == "__forwarding")
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000673 forwardingField = Element;
Devang Patel7f75bbe2009-11-25 17:36:49 +0000674 else if (fieldName == varName)
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000675 varField = Element;
676 }
Daniel Dunbar41716322009-09-19 20:40:05 +0000677
Mike Stump2fd84e22009-09-24 23:21:26 +0000678 assert(!varField.isNull() && "Can't find byref variable in Block struct");
679 assert(!forwardingField.isNull()
680 && "Can't find forwarding field in Block struct");
Caroline Tice248d5572009-08-31 21:19:37 +0000681
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000682 // Get the offsets for the forwarding field and the variable field.
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000683 unsigned int forwardingFieldOffset =
684 DIDerivedType(forwardingField.getNode()).getOffsetInBits() >> 3;
685 unsigned int varFieldOffset =
686 DIDerivedType(varField.getNode()).getOffsetInBits() >> 3;
Caroline Tice248d5572009-08-31 21:19:37 +0000687
Mike Stump2fd84e22009-09-24 23:21:26 +0000688 // Decode the original location, and use that as the start of the byref
689 // variable's location.
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000690 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
691 DIEBlock *Block = new DIEBlock();
Caroline Tice248d5572009-08-31 21:19:37 +0000692
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000693 if (Location.isReg()) {
694 if (Reg < 32)
Devang Patelc50078e2009-11-21 02:48:08 +0000695 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000696 else {
697 Reg = Reg - dwarf::DW_OP_reg0;
Devang Patelc50078e2009-11-21 02:48:08 +0000698 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
699 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000700 }
701 } else {
702 if (Reg < 32)
Devang Patelc50078e2009-11-21 02:48:08 +0000703 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000704 else {
Devang Patelc50078e2009-11-21 02:48:08 +0000705 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
706 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000707 }
Caroline Tice248d5572009-08-31 21:19:37 +0000708
Devang Patelc50078e2009-11-21 02:48:08 +0000709 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000710 }
Caroline Tice248d5572009-08-31 21:19:37 +0000711
Mike Stump2fd84e22009-09-24 23:21:26 +0000712 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000713 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000714 if (isPointer)
Devang Patelc50078e2009-11-21 02:48:08 +0000715 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Tice248d5572009-08-31 21:19:37 +0000716
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000717 // Next add the offset for the '__forwarding' field:
718 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
719 // adding the offset if it's 0.
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000720 if (forwardingFieldOffset > 0) {
Devang Patelc50078e2009-11-21 02:48:08 +0000721 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
722 addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000723 }
Caroline Tice248d5572009-08-31 21:19:37 +0000724
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000725 // Now dereference the __forwarding field to get to the real __Block_byref
726 // struct: DW_OP_deref.
Devang Patelc50078e2009-11-21 02:48:08 +0000727 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Tice248d5572009-08-31 21:19:37 +0000728
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000729 // Now that we've got the real __Block_byref... struct, add the offset
730 // for the variable's field to get to the location of the actual variable:
731 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000732 if (varFieldOffset > 0) {
Devang Patelc50078e2009-11-21 02:48:08 +0000733 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
734 addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000735 }
Caroline Tice248d5572009-08-31 21:19:37 +0000736
Daniel Dunbar19f1d442009-09-19 20:40:14 +0000737 // Now attach the location information to the DIE.
Devang Patelc50078e2009-11-21 02:48:08 +0000738 addBlock(Die, Attribute, 0, Block);
Caroline Tice248d5572009-08-31 21:19:37 +0000739}
740
Devang Patelc50078e2009-11-21 02:48:08 +0000741/// addAddress - Add an address attribute to a die based on the location
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000742/// provided.
Devang Patelc50078e2009-11-21 02:48:08 +0000743void DwarfDebug::addAddress(DIE *Die, unsigned Attribute,
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000744 const MachineLocation &Location) {
745 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
746 DIEBlock *Block = new DIEBlock();
747
748 if (Location.isReg()) {
749 if (Reg < 32) {
Devang Patelc50078e2009-11-21 02:48:08 +0000750 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000751 } else {
Devang Patelc50078e2009-11-21 02:48:08 +0000752 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
753 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000754 }
755 } else {
756 if (Reg < 32) {
Devang Patelc50078e2009-11-21 02:48:08 +0000757 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000758 } else {
Devang Patelc50078e2009-11-21 02:48:08 +0000759 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
760 addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000761 }
762
Devang Patelc50078e2009-11-21 02:48:08 +0000763 addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000764 }
765
Devang Patelc50078e2009-11-21 02:48:08 +0000766 addBlock(Die, Attribute, 0, Block);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000767}
768
Devang Patel1a8f9a82009-12-10 19:14:49 +0000769/// addToContextOwner - Add Die into the list of its context owner's children.
770void DwarfDebug::addToContextOwner(DIE *Die, DIDescriptor Context) {
771 if (Context.isNull())
772 ModuleCU->addDie(Die);
773 else if (Context.isType()) {
774 DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context.getNode()));
775 ContextDIE->addChild(Die);
Devang Patel8287d662009-12-15 19:16:48 +0000776 } else if (Context.isNameSpace()) {
777 DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context.getNode()));
778 ContextDIE->addChild(Die);
Devang Patel1a8f9a82009-12-10 19:14:49 +0000779 } else if (DIE *ContextDIE = ModuleCU->getDIE(Context.getNode()))
780 ContextDIE->addChild(Die);
781 else
782 ModuleCU->addDie(Die);
783}
784
Devang Patel7f139c12009-12-10 18:05:33 +0000785/// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
786/// given DIType.
787DIE *DwarfDebug::getOrCreateTypeDIE(DIType Ty) {
788 DIE *TyDIE = ModuleCU->getDIE(Ty.getNode());
789 if (TyDIE)
790 return TyDIE;
791
792 // Create new type.
793 TyDIE = new DIE(dwarf::DW_TAG_base_type);
794 ModuleCU->insertDIE(Ty.getNode(), TyDIE);
795 if (Ty.isBasicType())
796 constructTypeDIE(*TyDIE, DIBasicType(Ty.getNode()));
797 else if (Ty.isCompositeType())
798 constructTypeDIE(*TyDIE, DICompositeType(Ty.getNode()));
799 else {
800 assert(Ty.isDerivedType() && "Unknown kind of DIType");
801 constructTypeDIE(*TyDIE, DIDerivedType(Ty.getNode()));
802 }
803
Devang Patel1a8f9a82009-12-10 19:14:49 +0000804 addToContextOwner(TyDIE, Ty.getContext());
Devang Patel7f139c12009-12-10 18:05:33 +0000805 return TyDIE;
806}
807
Devang Patelc50078e2009-11-21 02:48:08 +0000808/// addType - Add a new type attribute to the specified entity.
Devang Patelfe0be132009-12-09 18:24:21 +0000809void DwarfDebug::addType(DIE *Entity, DIType Ty) {
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000810 if (Ty.isNull())
811 return;
812
813 // Check for pre-existence.
Devang Patelfe0be132009-12-09 18:24:21 +0000814 DIEEntry *Entry = ModuleCU->getDIEEntry(Ty.getNode());
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000815 // If it exists then use the existing value.
Devang Patelc50078e2009-11-21 02:48:08 +0000816 if (Entry) {
817 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000818 return;
819 }
820
821 // Set up proxy.
Devang Patelc50078e2009-11-21 02:48:08 +0000822 Entry = createDIEEntry();
Devang Patelfe0be132009-12-09 18:24:21 +0000823 ModuleCU->insertDIEEntry(Ty.getNode(), Entry);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000824
825 // Construct type.
Devang Patel7f139c12009-12-10 18:05:33 +0000826 DIE *Buffer = getOrCreateTypeDIE(Ty);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000827
Devang Patelc50078e2009-11-21 02:48:08 +0000828 Entry->setEntry(Buffer);
829 Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000830}
831
Devang Patelc50078e2009-11-21 02:48:08 +0000832/// constructTypeDIE - Construct basic type die from DIBasicType.
Devang Patelfe0be132009-12-09 18:24:21 +0000833void DwarfDebug::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000834 // Get core information.
Devang Patel7f75bbe2009-11-25 17:36:49 +0000835 StringRef Name = BTy.getName();
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000836 Buffer.setTag(dwarf::DW_TAG_base_type);
Devang Patelc50078e2009-11-21 02:48:08 +0000837 addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000838 BTy.getEncoding());
839
840 // Add name if not anonymous or intermediate type.
Devang Patel7f75bbe2009-11-25 17:36:49 +0000841 if (!Name.empty())
Devang Patelc50078e2009-11-21 02:48:08 +0000842 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000843 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patelc50078e2009-11-21 02:48:08 +0000844 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000845}
846
Devang Patelc50078e2009-11-21 02:48:08 +0000847/// constructTypeDIE - Construct derived type die from DIDerivedType.
Devang Patelfe0be132009-12-09 18:24:21 +0000848void DwarfDebug::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000849 // Get core information.
Devang Patel7f75bbe2009-11-25 17:36:49 +0000850 StringRef Name = DTy.getName();
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000851 uint64_t Size = DTy.getSizeInBits() >> 3;
852 unsigned Tag = DTy.getTag();
853
854 // FIXME - Workaround for templates.
855 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
856
857 Buffer.setTag(Tag);
858
859 // Map to main type, void will not have a type.
860 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patelfe0be132009-12-09 18:24:21 +0000861 addType(&Buffer, FromTy);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000862
863 // Add name if not anonymous or intermediate type.
Devang Patel76b80672009-11-30 23:56:56 +0000864 if (!Name.empty())
Devang Patelc50078e2009-11-21 02:48:08 +0000865 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000866
867 // Add size if non-zero (derived types might be zero-sized.)
868 if (Size)
Devang Patelc50078e2009-11-21 02:48:08 +0000869 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000870
871 // Add source line info if available and TyDesc is not a forward declaration.
Devang Patelb125c6e2009-11-23 18:43:37 +0000872 if (!DTy.isForwardDecl())
Devang Patelc50078e2009-11-21 02:48:08 +0000873 addSourceLine(&Buffer, &DTy);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000874}
875
Devang Patelc50078e2009-11-21 02:48:08 +0000876/// constructTypeDIE - Construct type DIE from DICompositeType.
Devang Patelfe0be132009-12-09 18:24:21 +0000877void DwarfDebug::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000878 // Get core information.
Devang Patel7f75bbe2009-11-25 17:36:49 +0000879 StringRef Name = CTy.getName();
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000880
881 uint64_t Size = CTy.getSizeInBits() >> 3;
882 unsigned Tag = CTy.getTag();
883 Buffer.setTag(Tag);
884
885 switch (Tag) {
886 case dwarf::DW_TAG_vector_type:
887 case dwarf::DW_TAG_array_type:
Devang Patelfe0be132009-12-09 18:24:21 +0000888 constructArrayTypeDIE(Buffer, &CTy);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000889 break;
890 case dwarf::DW_TAG_enumeration_type: {
891 DIArray Elements = CTy.getTypeArray();
892
893 // Add enumerators to enumeration type.
894 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
895 DIE *ElemDie = NULL;
Devang Patel15e723d2009-08-28 23:24:31 +0000896 DIEnumerator Enum(Elements.getElement(i).getNode());
Devang Patelfb812752009-10-09 17:51:49 +0000897 if (!Enum.isNull()) {
Devang Patelfe0be132009-12-09 18:24:21 +0000898 ElemDie = constructEnumTypeDIE(&Enum);
Devang Patelc50078e2009-11-21 02:48:08 +0000899 Buffer.addChild(ElemDie);
Devang Patelfb812752009-10-09 17:51:49 +0000900 }
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000901 }
902 }
903 break;
904 case dwarf::DW_TAG_subroutine_type: {
905 // Add return type.
906 DIArray Elements = CTy.getTypeArray();
907 DIDescriptor RTy = Elements.getElement(0);
Devang Patelfe0be132009-12-09 18:24:21 +0000908 addType(&Buffer, DIType(RTy.getNode()));
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000909
910 // Add prototype flag.
Devang Patelc50078e2009-11-21 02:48:08 +0000911 addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000912
913 // Add arguments.
914 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
915 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
916 DIDescriptor Ty = Elements.getElement(i);
Devang Patelfe0be132009-12-09 18:24:21 +0000917 addType(Arg, DIType(Ty.getNode()));
Devang Patelc50078e2009-11-21 02:48:08 +0000918 Buffer.addChild(Arg);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000919 }
920 }
921 break;
922 case dwarf::DW_TAG_structure_type:
923 case dwarf::DW_TAG_union_type:
924 case dwarf::DW_TAG_class_type: {
925 // Add elements to structure type.
926 DIArray Elements = CTy.getTypeArray();
927
928 // A forward struct declared type may not have elements available.
929 if (Elements.isNull())
930 break;
931
932 // Add elements to structure type.
933 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
934 DIDescriptor Element = Elements.getElement(i);
Devang Patel15e723d2009-08-28 23:24:31 +0000935 if (Element.isNull())
936 continue;
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000937 DIE *ElemDie = NULL;
938 if (Element.getTag() == dwarf::DW_TAG_subprogram)
Devang Patel814a12c2009-12-14 16:18:45 +0000939 ElemDie = createSubprogramDIE(DISubprogram(Element.getNode()));
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000940 else
Devang Patelfe0be132009-12-09 18:24:21 +0000941 ElemDie = createMemberDIE(DIDerivedType(Element.getNode()));
Devang Patelc50078e2009-11-21 02:48:08 +0000942 Buffer.addChild(ElemDie);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000943 }
944
Devang Patel20b32102009-08-27 23:51:51 +0000945 if (CTy.isAppleBlockExtension())
Devang Patelc50078e2009-11-21 02:48:08 +0000946 addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000947
948 unsigned RLang = CTy.getRunTimeLang();
949 if (RLang)
Devang Patelc50078e2009-11-21 02:48:08 +0000950 addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000951 dwarf::DW_FORM_data1, RLang);
952 break;
953 }
954 default:
955 break;
956 }
957
958 // Add name if not anonymous or intermediate type.
Devang Patel7f75bbe2009-11-25 17:36:49 +0000959 if (!Name.empty())
Devang Patelc50078e2009-11-21 02:48:08 +0000960 addString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000961
962 if (Tag == dwarf::DW_TAG_enumeration_type ||
963 Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type) {
964 // Add size if non-zero (derived types might be zero-sized.)
965 if (Size)
Devang Patelc50078e2009-11-21 02:48:08 +0000966 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000967 else {
968 // Add zero size if it is not a forward declaration.
969 if (CTy.isForwardDecl())
Devang Patelc50078e2009-11-21 02:48:08 +0000970 addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000971 else
Devang Patelc50078e2009-11-21 02:48:08 +0000972 addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000973 }
974
975 // Add source line info if available.
976 if (!CTy.isForwardDecl())
Devang Patelc50078e2009-11-21 02:48:08 +0000977 addSourceLine(&Buffer, &CTy);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000978 }
979}
980
Devang Patelc50078e2009-11-21 02:48:08 +0000981/// constructSubrangeDIE - Construct subrange DIE from DISubrange.
982void DwarfDebug::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000983 int64_t L = SR.getLo();
984 int64_t H = SR.getHi();
985 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
986
Devang Patelc50078e2009-11-21 02:48:08 +0000987 addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
Devang Patele7ff5092009-08-14 20:59:16 +0000988 if (L)
Devang Patelc50078e2009-11-21 02:48:08 +0000989 addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
Devang Pateld3df6972009-12-04 23:10:24 +0000990 addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000991
Devang Patelc50078e2009-11-21 02:48:08 +0000992 Buffer.addChild(DW_Subrange);
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000993}
994
Devang Patelc50078e2009-11-21 02:48:08 +0000995/// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
Devang Patelfe0be132009-12-09 18:24:21 +0000996void DwarfDebug::constructArrayTypeDIE(DIE &Buffer,
Bill Wendlingb12b3d72009-05-15 09:23:25 +0000997 DICompositeType *CTy) {
998 Buffer.setTag(dwarf::DW_TAG_array_type);
999 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
Devang Patelc50078e2009-11-21 02:48:08 +00001000 addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001001
1002 // Emit derived type.
Devang Patelfe0be132009-12-09 18:24:21 +00001003 addType(&Buffer, CTy->getTypeDerivedFrom());
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001004 DIArray Elements = CTy->getTypeArray();
1005
Devang Patel1233f912009-11-21 00:31:03 +00001006 // Get an anonymous type for index type.
Devang Patelfe0be132009-12-09 18:24:21 +00001007 DIE *IdxTy = ModuleCU->getIndexTyDie();
Devang Patel1233f912009-11-21 00:31:03 +00001008 if (!IdxTy) {
1009 // Construct an anonymous type for index type.
1010 IdxTy = new DIE(dwarf::DW_TAG_base_type);
Devang Patelc50078e2009-11-21 02:48:08 +00001011 addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1012 addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
Devang Patel1233f912009-11-21 00:31:03 +00001013 dwarf::DW_ATE_signed);
Devang Patelfe0be132009-12-09 18:24:21 +00001014 ModuleCU->addDie(IdxTy);
1015 ModuleCU->setIndexTyDie(IdxTy);
Devang Patel1233f912009-11-21 00:31:03 +00001016 }
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001017
1018 // Add subranges to array type.
1019 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1020 DIDescriptor Element = Elements.getElement(i);
1021 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patelc50078e2009-11-21 02:48:08 +00001022 constructSubrangeDIE(Buffer, DISubrange(Element.getNode()), IdxTy);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001023 }
1024}
1025
Devang Patelc50078e2009-11-21 02:48:08 +00001026/// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Patelfe0be132009-12-09 18:24:21 +00001027DIE *DwarfDebug::constructEnumTypeDIE(DIEnumerator *ETy) {
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001028 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel7f75bbe2009-11-25 17:36:49 +00001029 StringRef Name = ETy->getName();
Devang Patelc50078e2009-11-21 02:48:08 +00001030 addString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001031 int64_t Value = ETy->getEnumValue();
Devang Patelc50078e2009-11-21 02:48:08 +00001032 addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001033 return Enumerator;
1034}
1035
Devang Patel141e1c42010-01-05 01:46:14 +00001036/// getRealLinkageName - If special LLVM prefix that is used to inform the asm
1037/// printer to not emit usual symbol prefix before the symbol name is used then
1038/// return linkage name after skipping this special LLVM prefix.
1039static StringRef getRealLinkageName(StringRef LinkageName) {
1040 char One = '\1';
1041 if (LinkageName.startswith(StringRef(&One, 1)))
1042 return LinkageName.substr(1);
1043 return LinkageName;
1044}
1045
Devang Patelc50078e2009-11-21 02:48:08 +00001046/// createGlobalVariableDIE - Create new DIE using GV.
Devang Patelfe0be132009-12-09 18:24:21 +00001047DIE *DwarfDebug::createGlobalVariableDIE(const DIGlobalVariable &GV) {
Jim Grosbachb23f2422009-11-22 19:20:36 +00001048 // If the global variable was optmized out then no need to create debug info
1049 // entry.
Devang Patel83e42c72009-11-06 17:58:12 +00001050 if (!GV.getGlobal()) return NULL;
Devang Patel7f75bbe2009-11-25 17:36:49 +00001051 if (GV.getDisplayName().empty()) return NULL;
Devang Patelfabc47c2009-11-06 01:30:04 +00001052
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001053 DIE *GVDie = new DIE(dwarf::DW_TAG_variable);
Jim Grosbach652b7432009-11-21 23:12:12 +00001054 addString(GVDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
Devang Patelaaf012e2009-09-29 18:40:58 +00001055 GV.getDisplayName());
1056
Devang Patel7f75bbe2009-11-25 17:36:49 +00001057 StringRef LinkageName = GV.getLinkageName();
Devang Patel141e1c42010-01-05 01:46:14 +00001058 if (!LinkageName.empty())
Devang Patelc50078e2009-11-21 02:48:08 +00001059 addString(GVDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel141e1c42010-01-05 01:46:14 +00001060 getRealLinkageName(LinkageName));
1061
Devang Patelfe0be132009-12-09 18:24:21 +00001062 addType(GVDie, GV.getType());
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001063 if (!GV.isLocalToUnit())
Devang Patelc50078e2009-11-21 02:48:08 +00001064 addUInt(GVDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1065 addSourceLine(GVDie, &GV);
Devang Patel6bd5cc82009-10-05 23:22:08 +00001066
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001067 return GVDie;
1068}
1069
Devang Patelc50078e2009-11-21 02:48:08 +00001070/// createMemberDIE - Create new member DIE.
Devang Patelfe0be132009-12-09 18:24:21 +00001071DIE *DwarfDebug::createMemberDIE(const DIDerivedType &DT) {
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001072 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel7f75bbe2009-11-25 17:36:49 +00001073 StringRef Name = DT.getName();
1074 if (!Name.empty())
Devang Patelc50078e2009-11-21 02:48:08 +00001075 addString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
Devang Patel7f75bbe2009-11-25 17:36:49 +00001076
Devang Patelfe0be132009-12-09 18:24:21 +00001077 addType(MemberDie, DT.getTypeDerivedFrom());
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001078
Devang Patelc50078e2009-11-21 02:48:08 +00001079 addSourceLine(MemberDie, &DT);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001080
Devang Patel7d9fe582009-11-04 22:06:12 +00001081 DIEBlock *MemLocationDie = new DIEBlock();
Devang Patelc50078e2009-11-21 02:48:08 +00001082 addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
Devang Patel7d9fe582009-11-04 22:06:12 +00001083
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001084 uint64_t Size = DT.getSizeInBits();
Devang Patel71842a92009-11-04 23:48:00 +00001085 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001086
1087 if (Size != FieldSize) {
1088 // Handle bitfield.
Devang Patelc50078e2009-11-21 02:48:08 +00001089 addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1090 addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001091
1092 uint64_t Offset = DT.getOffsetInBits();
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001093 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1094 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
Benjamin Kramer631e3e32010-01-07 17:50:57 +00001095 uint64_t FieldOffset = (HiMark - FieldSize);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001096 Offset -= FieldOffset;
1097
1098 // Maybe we need to work from the other end.
1099 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
Devang Patelc50078e2009-11-21 02:48:08 +00001100 addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001101
Devang Patel7d9fe582009-11-04 22:06:12 +00001102 // Here WD_AT_data_member_location points to the anonymous
1103 // field that includes this bit field.
Devang Patelc50078e2009-11-21 02:48:08 +00001104 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
Devang Patel7d9fe582009-11-04 22:06:12 +00001105
1106 } else
1107 // This is not a bitfield.
Devang Patelc50078e2009-11-21 02:48:08 +00001108 addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
Devang Patel7d9fe582009-11-04 22:06:12 +00001109
Devang Patelc50078e2009-11-21 02:48:08 +00001110 addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001111
1112 if (DT.isProtected())
Devang Patel188c85d2009-12-03 19:11:07 +00001113 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001114 dwarf::DW_ACCESS_protected);
1115 else if (DT.isPrivate())
Devang Patel188c85d2009-12-03 19:11:07 +00001116 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001117 dwarf::DW_ACCESS_private);
Devang Patel188c85d2009-12-03 19:11:07 +00001118 else if (DT.getTag() == dwarf::DW_TAG_inheritance)
1119 addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1120 dwarf::DW_ACCESS_public);
1121 if (DT.isVirtual())
1122 addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1123 dwarf::DW_VIRTUALITY_virtual);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001124 return MemberDie;
1125}
1126
Devang Patel814a12c2009-12-14 16:18:45 +00001127/// createSubprogramDIE - Create new DIE using SP.
1128DIE *DwarfDebug::createSubprogramDIE(const DISubprogram &SP, bool MakeDecl) {
1129 DIE *SPDie = ModuleCU->getDIE(SP.getNode());
1130 if (SPDie)
1131 return SPDie;
1132
1133 SPDie = new DIE(dwarf::DW_TAG_subprogram);
Devang Patel7f75bbe2009-11-25 17:36:49 +00001134 addString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, SP.getName());
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001135
Devang Patel7f75bbe2009-11-25 17:36:49 +00001136 StringRef LinkageName = SP.getLinkageName();
Devang Patel141e1c42010-01-05 01:46:14 +00001137 if (!LinkageName.empty())
Devang Patelc50078e2009-11-21 02:48:08 +00001138 addString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel141e1c42010-01-05 01:46:14 +00001139 getRealLinkageName(LinkageName));
1140
Devang Patelc50078e2009-11-21 02:48:08 +00001141 addSourceLine(SPDie, &SP);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001142
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001143 // Add prototyped tag, if C or ObjC.
1144 unsigned Lang = SP.getCompileUnit().getLanguage();
1145 if (Lang == dwarf::DW_LANG_C99 || Lang == dwarf::DW_LANG_C89 ||
1146 Lang == dwarf::DW_LANG_ObjC)
Devang Patelc50078e2009-11-21 02:48:08 +00001147 addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001148
1149 // Add Return Type.
Devang Patelc1df8792009-12-03 01:25:38 +00001150 DICompositeType SPTy = SP.getType();
1151 DIArray Args = SPTy.getTypeArray();
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001152 unsigned SPTag = SPTy.getTag();
Devang Patel188c85d2009-12-03 19:11:07 +00001153
Devang Patelc1df8792009-12-03 01:25:38 +00001154 if (Args.isNull() || SPTag != dwarf::DW_TAG_subroutine_type)
Devang Patelfe0be132009-12-09 18:24:21 +00001155 addType(SPDie, SPTy);
Devang Patelc1df8792009-12-03 01:25:38 +00001156 else
Devang Patelfe0be132009-12-09 18:24:21 +00001157 addType(SPDie, DIType(Args.getElement(0).getNode()));
Devang Patelc1df8792009-12-03 01:25:38 +00001158
Devang Patel188c85d2009-12-03 19:11:07 +00001159 unsigned VK = SP.getVirtuality();
1160 if (VK) {
1161 addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
1162 DIEBlock *Block = new DIEBlock();
1163 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1164 addUInt(Block, 0, dwarf::DW_FORM_data1, SP.getVirtualIndex());
1165 addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
Devang Patel7d707f92010-01-19 06:19:05 +00001166 ContainingTypeMap.insert(std::make_pair(SPDie,
1167 SP.getContainingType().getNode()));
Devang Patel188c85d2009-12-03 19:11:07 +00001168 }
1169
Devang Patel814a12c2009-12-14 16:18:45 +00001170 if (MakeDecl || !SP.isDefinition()) {
Devang Patelc50078e2009-11-21 02:48:08 +00001171 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001172
1173 // Add arguments. Do not add arguments for subprogram definition. They will
Devang Patelc1df8792009-12-03 01:25:38 +00001174 // be handled while processing variables.
1175 DICompositeType SPTy = SP.getType();
1176 DIArray Args = SPTy.getTypeArray();
1177 unsigned SPTag = SPTy.getTag();
1178
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001179 if (SPTag == dwarf::DW_TAG_subroutine_type)
1180 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1181 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patelfe0be132009-12-09 18:24:21 +00001182 addType(Arg, DIType(Args.getElement(i).getNode()));
Devang Patelc50078e2009-11-21 02:48:08 +00001183 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1); // ??
1184 SPDie->addChild(Arg);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001185 }
1186 }
1187
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001188 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patelfe0be132009-12-09 18:24:21 +00001189 ModuleCU->insertDIE(SP.getNode(), SPDie);
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001190 return SPDie;
1191}
1192
Devang Patelc50078e2009-11-21 02:48:08 +00001193/// findCompileUnit - Get the compile unit for the given descriptor.
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001194///
Devang Patelb9f2c6b2009-12-11 21:37:07 +00001195CompileUnit *DwarfDebug::findCompileUnit(DICompileUnit Unit) {
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001196 DenseMap<Value *, CompileUnit *>::const_iterator I =
Devang Patel15e723d2009-08-28 23:24:31 +00001197 CompileUnitMap.find(Unit.getNode());
Devang Patelb9f2c6b2009-12-11 21:37:07 +00001198 if (I == CompileUnitMap.end())
1199 return constructCompileUnit(Unit.getNode());
1200 return I->second;
Bill Wendlingb12b3d72009-05-15 09:23:25 +00001201}
1202
Devang Patel90a0fe32009-11-10 23:06:00 +00001203/// getUpdatedDbgScope - Find or create DbgScope assicated with the instruction.
1204/// Initialize scope and update scope hierarchy.
1205DbgScope *DwarfDebug::getUpdatedDbgScope(MDNode *N, const MachineInstr *MI,
1206 MDNode *InlinedAt) {
1207 assert (N && "Invalid Scope encoding!");
1208 assert (MI && "Missing machine instruction!");
1209 bool GetConcreteScope = (MI && InlinedAt);
1210
1211 DbgScope *NScope = NULL;
1212
1213 if (InlinedAt)
1214 NScope = DbgScopeMap.lookup(InlinedAt);
1215 else
1216 NScope = DbgScopeMap.lookup(N);
1217 assert (NScope && "Unable to find working scope!");
1218
1219 if (NScope->getFirstInsn())
1220 return NScope;
Devang Patel6a260102009-10-01 20:31:14 +00001221
1222 DbgScope *Parent = NULL;
Devang Patel90a0fe32009-11-10 23:06:00 +00001223 if (GetConcreteScope) {
Devang Pateldd7bb432009-10-14 21:08:09 +00001224 DILocation IL(InlinedAt);
Jim Grosbach652b7432009-11-21 23:12:12 +00001225 Parent = getUpdatedDbgScope(IL.getScope().getNode(), MI,
Devang Patel90a0fe32009-11-10 23:06:00 +00001226 IL.getOrigLocation().getNode());
1227 assert (Parent && "Unable to find Parent scope!");
1228 NScope->setParent(Parent);
Devang Patelc50078e2009-11-21 02:48:08 +00001229 Parent->addScope(NScope);
Devang Patel90a0fe32009-11-10 23:06:00 +00001230 } else if (DIDescriptor(N).isLexicalBlock()) {
1231 DILexicalBlock DB(N);
1232 if (!DB.getContext().isNull()) {
1233 Parent = getUpdatedDbgScope(DB.getContext().getNode(), MI, InlinedAt);
1234 NScope->setParent(Parent);
Devang Patelc50078e2009-11-21 02:48:08 +00001235 Parent->addScope(NScope);
Devang Patel90a0fe32009-11-10 23:06:00 +00001236 }
Devang Pateldd7bb432009-10-14 21:08:09 +00001237 }
Devang Patel6a260102009-10-01 20:31:14 +00001238
Devang Patelf5278f22009-10-27 20:47:17 +00001239 NScope->setFirstInsn(MI);
Devang Patel6a260102009-10-01 20:31:14 +00001240
Devang Patel90a0fe32009-11-10 23:06:00 +00001241 if (!Parent && !InlinedAt) {
Devang Patelce8986f2009-11-11 00:31:36 +00001242 StringRef SPName = DISubprogram(N).getLinkageName();
1243 if (SPName == MF->getFunction()->getName())
1244 CurrentFnDbgScope = NScope;
Devang Patel90a0fe32009-11-10 23:06:00 +00001245 }
Devang Patel6a260102009-10-01 20:31:14 +00001246
Devang Patel90a0fe32009-11-10 23:06:00 +00001247 if (GetConcreteScope) {
1248 ConcreteScopes[InlinedAt] = NScope;
1249 getOrCreateAbstractScope(N);
1250 }
1251
Devang Patelf5278f22009-10-27 20:47:17 +00001252 return NScope;
Devang Patel6a260102009-10-01 20:31:14 +00001253}
1254
Devang Patel90a0fe32009-11-10 23:06:00 +00001255DbgScope *DwarfDebug::getOrCreateAbstractScope(MDNode *N) {
1256 assert (N && "Invalid Scope encoding!");
1257
1258 DbgScope *AScope = AbstractScopes.lookup(N);
1259 if (AScope)
1260 return AScope;
Jim Grosbach652b7432009-11-21 23:12:12 +00001261
Devang Patel90a0fe32009-11-10 23:06:00 +00001262 DbgScope *Parent = NULL;
1263
1264 DIDescriptor Scope(N);
1265 if (Scope.isLexicalBlock()) {
1266 DILexicalBlock DB(N);
1267 DIDescriptor ParentDesc = DB.getContext();
1268 if (!ParentDesc.isNull())
1269 Parent = getOrCreateAbstractScope(ParentDesc.getNode());
1270 }
1271
1272 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1273
1274 if (Parent)
Devang Patelc50078e2009-11-21 02:48:08 +00001275 Parent->addScope(AScope);
Devang Patel90a0fe32009-11-10 23:06:00 +00001276 AScope->setAbstractScope();
1277 AbstractScopes[N] = AScope;
1278 if (DIDescriptor(N).isSubprogram())
1279 AbstractScopesList.push_back(AScope);
1280 return AScope;
1281}
Devang Patel6a260102009-10-01 20:31:14 +00001282
Jim Grosbach652b7432009-11-21 23:12:12 +00001283/// updateSubprogramScopeDIE - Find DIE for the given subprogram and
Devang Patelc50078e2009-11-21 02:48:08 +00001284/// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
1285/// If there are global variables in this scope then create and insert
1286/// DIEs for these variables.
1287DIE *DwarfDebug::updateSubprogramScopeDIE(MDNode *SPNode) {
Devang Patel90a0fe32009-11-10 23:06:00 +00001288
Devang Pateld90672c2009-11-20 21:37:22 +00001289 DIE *SPDie = ModuleCU->getDIE(SPNode);
Devang Patel90a0fe32009-11-10 23:06:00 +00001290 assert (SPDie && "Unable to find subprogram DIE!");
Devang Patel814a12c2009-12-14 16:18:45 +00001291 DISubprogram SP(SPNode);
1292 if (SP.isDefinition() && !SP.getContext().isCompileUnit()) {
1293 addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1294 // Add arguments.
1295 DICompositeType SPTy = SP.getType();
1296 DIArray Args = SPTy.getTypeArray();
1297 unsigned SPTag = SPTy.getTag();
1298 if (SPTag == dwarf::DW_TAG_subroutine_type)
1299 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1300 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1301 addType(Arg, DIType(Args.getElement(i).getNode()));
1302 addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1); // ??
1303 SPDie->addChild(Arg);
1304 }
1305 DIE *SPDeclDie = SPDie;
1306 SPDie = new DIE(dwarf::DW_TAG_subprogram);
1307 addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
1308 SPDeclDie);
Devang Patel814a12c2009-12-14 16:18:45 +00001309 ModuleCU->addDie(SPDie);
1310 }
1311
Devang Patelc50078e2009-11-21 02:48:08 +00001312 addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Devang Patel90a0fe32009-11-10 23:06:00 +00001313 DWLabel("func_begin", SubprogramCount));
Devang Patelc50078e2009-11-21 02:48:08 +00001314 addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Devang Patel90a0fe32009-11-10 23:06:00 +00001315 DWLabel("func_end", SubprogramCount));
1316 MachineLocation Location(RI->getFrameRegister(*MF));
Devang Patelc50078e2009-11-21 02:48:08 +00001317 addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Jim Grosbach652b7432009-11-21 23:12:12 +00001318
Devang Patel90a0fe32009-11-10 23:06:00 +00001319 if (!DISubprogram(SPNode).isLocalToUnit())
Devang Patelc50078e2009-11-21 02:48:08 +00001320 addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
Devang Patel90a0fe32009-11-10 23:06:00 +00001321
Devang Patel90a0fe32009-11-10 23:06:00 +00001322 return SPDie;
1323}
1324
Jim Grosbach652b7432009-11-21 23:12:12 +00001325/// constructLexicalScope - Construct new DW_TAG_lexical_block
Devang Patelc50078e2009-11-21 02:48:08 +00001326/// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
1327DIE *DwarfDebug::constructLexicalScopeDIE(DbgScope *Scope) {
Devang Patel90a0fe32009-11-10 23:06:00 +00001328 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1329 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
1330
1331 // Ignore empty scopes.
1332 if (StartID == EndID && StartID != 0)
1333 return NULL;
1334
1335 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1336 if (Scope->isAbstractScope())
1337 return ScopeDIE;
1338
Devang Patelc50078e2009-11-21 02:48:08 +00001339 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Jim Grosbach652b7432009-11-21 23:12:12 +00001340 StartID ?
1341 DWLabel("label", StartID)
Devang Patel90a0fe32009-11-10 23:06:00 +00001342 : DWLabel("func_begin", SubprogramCount));
Devang Patelc50078e2009-11-21 02:48:08 +00001343 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Jim Grosbach652b7432009-11-21 23:12:12 +00001344 EndID ?
1345 DWLabel("label", EndID)
Devang Patel90a0fe32009-11-10 23:06:00 +00001346 : DWLabel("func_end", SubprogramCount));
1347
1348
1349
1350 return ScopeDIE;
1351}
1352
Devang Patelc50078e2009-11-21 02:48:08 +00001353/// constructInlinedScopeDIE - This scope represents inlined body of
1354/// a function. Construct DIE to represent this concrete inlined copy
1355/// of the function.
1356DIE *DwarfDebug::constructInlinedScopeDIE(DbgScope *Scope) {
Devang Patel90a0fe32009-11-10 23:06:00 +00001357 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1358 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
1359 assert (StartID && "Invalid starting label for an inlined scope!");
1360 assert (EndID && "Invalid end label for an inlined scope!");
1361 // Ignore empty scopes.
1362 if (StartID == EndID && StartID != 0)
1363 return NULL;
1364
1365 DIScope DS(Scope->getScopeNode());
1366 if (DS.isNull())
1367 return NULL;
1368 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1369
1370 DISubprogram InlinedSP = getDISubprogram(DS.getNode());
Devang Pateld90672c2009-11-20 21:37:22 +00001371 DIE *OriginDIE = ModuleCU->getDIE(InlinedSP.getNode());
Devang Patel90a0fe32009-11-10 23:06:00 +00001372 assert (OriginDIE && "Unable to find Origin DIE!");
Devang Patelc50078e2009-11-21 02:48:08 +00001373 addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
Devang Patel90a0fe32009-11-10 23:06:00 +00001374 dwarf::DW_FORM_ref4, OriginDIE);
1375
Devang Patelc50078e2009-11-21 02:48:08 +00001376 addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
Devang Patel90a0fe32009-11-10 23:06:00 +00001377 DWLabel("label", StartID));
Devang Patelc50078e2009-11-21 02:48:08 +00001378 addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
Devang Patel90a0fe32009-11-10 23:06:00 +00001379 DWLabel("label", EndID));
1380
1381 InlinedSubprogramDIEs.insert(OriginDIE);
1382
1383 // Track the start label for this inlined function.
Devang Patel7d707f92010-01-19 06:19:05 +00001384 DenseMap<MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
Devang Patel90a0fe32009-11-10 23:06:00 +00001385 I = InlineInfo.find(InlinedSP.getNode());
1386
1387 if (I == InlineInfo.end()) {
Jim Grosbachb23f2422009-11-22 19:20:36 +00001388 InlineInfo[InlinedSP.getNode()].push_back(std::make_pair(StartID,
1389 ScopeDIE));
Devang Patel90a0fe32009-11-10 23:06:00 +00001390 InlinedSPNodes.push_back(InlinedSP.getNode());
1391 } else
1392 I->second.push_back(std::make_pair(StartID, ScopeDIE));
1393
1394 StringPool.insert(InlinedSP.getName());
Devang Patel141e1c42010-01-05 01:46:14 +00001395 StringPool.insert(getRealLinkageName(InlinedSP.getLinkageName()));
1396
Devang Patel90a0fe32009-11-10 23:06:00 +00001397 DILocation DL(Scope->getInlinedAt());
Devang Patelc50078e2009-11-21 02:48:08 +00001398 addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, ModuleCU->getID());
1399 addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
Devang Patel90a0fe32009-11-10 23:06:00 +00001400
1401 return ScopeDIE;
1402}
1403
Devang Patelc50078e2009-11-21 02:48:08 +00001404
1405/// constructVariableDIE - Construct a DIE for the given DbgVariable.
Devang Patelfe0be132009-12-09 18:24:21 +00001406DIE *DwarfDebug::constructVariableDIE(DbgVariable *DV, DbgScope *Scope) {
Devang Patel90a0fe32009-11-10 23:06:00 +00001407 // Get the descriptor.
1408 const DIVariable &VD = DV->getVariable();
Devang Patel7f75bbe2009-11-25 17:36:49 +00001409 StringRef Name = VD.getName();
1410 if (Name.empty())
Devang Patelab9a0682009-11-13 02:25:26 +00001411 return NULL;
Devang Patel90a0fe32009-11-10 23:06:00 +00001412
1413 // Translate tag to proper Dwarf tag. The result variable is dropped for
1414 // now.
1415 unsigned Tag;
1416 switch (VD.getTag()) {
1417 case dwarf::DW_TAG_return_variable:
1418 return NULL;
1419 case dwarf::DW_TAG_arg_variable:
1420 Tag = dwarf::DW_TAG_formal_parameter;
1421 break;
1422 case dwarf::DW_TAG_auto_variable: // fall thru
1423 default:
1424 Tag = dwarf::DW_TAG_variable;
1425 break;
1426 }
1427
1428 // Define variable debug information entry.
1429 DIE *VariableDie = new DIE(Tag);
1430
1431
1432 DIE *AbsDIE = NULL;
1433 if (DbgVariable *AV = DV->getAbstractVariable())
1434 AbsDIE = AV->getDIE();
Jim Grosbach652b7432009-11-21 23:12:12 +00001435
Devang Patel90a0fe32009-11-10 23:06:00 +00001436 if (AbsDIE) {
1437 DIScope DS(Scope->getScopeNode());
1438 DISubprogram InlinedSP = getDISubprogram(DS.getNode());
Devang Pateld90672c2009-11-20 21:37:22 +00001439 DIE *OriginSPDIE = ModuleCU->getDIE(InlinedSP.getNode());
Daniel Dunbarc9f2d242009-11-11 03:09:50 +00001440 (void) OriginSPDIE;
Devang Patel90a0fe32009-11-10 23:06:00 +00001441 assert (OriginSPDIE && "Unable to find Origin DIE for the SP!");
1442 DIE *AbsDIE = DV->getAbstractVariable()->getDIE();
1443 assert (AbsDIE && "Unable to find Origin DIE for the Variable!");
Devang Patelc50078e2009-11-21 02:48:08 +00001444 addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
Devang Patel90a0fe32009-11-10 23:06:00 +00001445 dwarf::DW_FORM_ref4, AbsDIE);
1446 }
1447 else {
Devang Patelc50078e2009-11-21 02:48:08 +00001448 addString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
1449 addSourceLine(VariableDie, &VD);
Devang Patel90a0fe32009-11-10 23:06:00 +00001450
1451 // Add variable type.
Jim Grosbach652b7432009-11-21 23:12:12 +00001452 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
Devang Patel90a0fe32009-11-10 23:06:00 +00001453 // addresses instead.
1454 if (VD.isBlockByrefVariable())
Devang Patelfe0be132009-12-09 18:24:21 +00001455 addType(VariableDie, getBlockByrefType(VD.getType(), Name));
Devang Patel90a0fe32009-11-10 23:06:00 +00001456 else
Devang Patelfe0be132009-12-09 18:24:21 +00001457 addType(VariableDie, VD.getType());
Devang Patel90a0fe32009-11-10 23:06:00 +00001458 }
1459
1460 // Add variable address.
1461 if (!Scope->isAbstractScope()) {
1462 MachineLocation Location;
Jim Grosbach587d4882009-11-22 20:14:00 +00001463 unsigned FrameReg;
1464 int Offset = RI->getFrameIndexReference(*MF, DV->getFrameIndex(), FrameReg);
1465 Location.set(FrameReg, Offset);
Jim Grosbach652b7432009-11-21 23:12:12 +00001466
Devang Patel90a0fe32009-11-10 23:06:00 +00001467 if (VD.hasComplexAddress())
Devang Patelc50078e2009-11-21 02:48:08 +00001468 addComplexAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
Devang Patel90a0fe32009-11-10 23:06:00 +00001469 else if (VD.isBlockByrefVariable())
Devang Patelc50078e2009-11-21 02:48:08 +00001470 addBlockByrefAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
Devang Patel90a0fe32009-11-10 23:06:00 +00001471 else
Devang Patelc50078e2009-11-21 02:48:08 +00001472 addAddress(VariableDie, dwarf::DW_AT_location, Location);
Devang Patel90a0fe32009-11-10 23:06:00 +00001473 }
1474 DV->setDIE(VariableDie);
1475 return VariableDie;
1476
1477}
Devang Patelc50078e2009-11-21 02:48:08 +00001478
Devang Patelec13b4f2009-11-24 01:14:22 +00001479void DwarfDebug::addPubTypes(DISubprogram SP) {
1480 DICompositeType SPTy = SP.getType();
1481 unsigned SPTag = SPTy.getTag();
1482 if (SPTag != dwarf::DW_TAG_subroutine_type)
1483 return;
1484
1485 DIArray Args = SPTy.getTypeArray();
1486 if (Args.isNull())
1487 return;
1488
1489 for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
1490 DIType ATy(Args.getElement(i).getNode());
1491 if (ATy.isNull())
1492 continue;
1493 DICompositeType CATy = getDICompositeType(ATy);
Devang Patel7f75bbe2009-11-25 17:36:49 +00001494 if (!CATy.isNull() && !CATy.getName().empty()) {
Devang Patelec13b4f2009-11-24 01:14:22 +00001495 if (DIEEntry *Entry = ModuleCU->getDIEEntry(CATy.getNode()))
1496 ModuleCU->addGlobalType(CATy.getName(), Entry->getEntry());
1497 }
1498 }
1499}
1500
Devang Patelc50078e2009-11-21 02:48:08 +00001501/// constructScopeDIE - Construct a DIE for this scope.
1502DIE *DwarfDebug::constructScopeDIE(DbgScope *Scope) {
Devang Patel90a0fe32009-11-10 23:06:00 +00001503 if (!Scope)
1504 return NULL;
1505 DIScope DS(Scope->getScopeNode());
1506 if (DS.isNull())
1507 return NULL;
1508
1509 DIE *ScopeDIE = NULL;
1510 if (Scope->getInlinedAt())
Devang Patelc50078e2009-11-21 02:48:08 +00001511 ScopeDIE = constructInlinedScopeDIE(Scope);
Devang Patel90a0fe32009-11-10 23:06:00 +00001512 else if (DS.isSubprogram()) {
1513 if (Scope->isAbstractScope())
Devang Pateld90672c2009-11-20 21:37:22 +00001514 ScopeDIE = ModuleCU->getDIE(DS.getNode());
Devang Patel90a0fe32009-11-10 23:06:00 +00001515 else
Devang Patelc50078e2009-11-21 02:48:08 +00001516 ScopeDIE = updateSubprogramScopeDIE(DS.getNode());
Devang Patel90a0fe32009-11-10 23:06:00 +00001517 }
1518 else {
Devang Patelc50078e2009-11-21 02:48:08 +00001519 ScopeDIE = constructLexicalScopeDIE(Scope);
Devang Patel90a0fe32009-11-10 23:06:00 +00001520 if (!ScopeDIE) return NULL;
1521 }
1522
1523 // Add variables to scope.
1524 SmallVector<DbgVariable *, 8> &Variables = Scope->getVariables();
1525 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Devang Patelfe0be132009-12-09 18:24:21 +00001526 DIE *VariableDIE = constructVariableDIE(Variables[i], Scope);
Jim Grosbach652b7432009-11-21 23:12:12 +00001527 if (VariableDIE)
Devang Patelc50078e2009-11-21 02:48:08 +00001528 ScopeDIE->addChild(VariableDIE);
Devang Patel90a0fe32009-11-10 23:06:00 +00001529 }
1530
1531 // Add nested scopes.
1532 SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
1533 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1534 // Define the Scope debug information entry.
Devang Patelc50078e2009-11-21 02:48:08 +00001535 DIE *NestedDIE = constructScopeDIE(Scopes[j]);
Jim Grosbach652b7432009-11-21 23:12:12 +00001536 if (NestedDIE)
Devang Patelc50078e2009-11-21 02:48:08 +00001537 ScopeDIE->addChild(NestedDIE);
Devang Patel90a0fe32009-11-10 23:06:00 +00001538 }
Devang Patelec13b4f2009-11-24 01:14:22 +00001539
1540 if (DS.isSubprogram())
1541 addPubTypes(DISubprogram(DS.getNode()));
1542
1543 return ScopeDIE;
Devang Patel90a0fe32009-11-10 23:06:00 +00001544}
1545
Bill Wendlingf5839192009-05-20 23:19:06 +00001546/// GetOrCreateSourceID - Look up the source id with the given directory and
1547/// source file names. If none currently exists, create a new id and insert it
1548/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1549/// maps as well.
Devang Patel7f75bbe2009-11-25 17:36:49 +00001550unsigned DwarfDebug::GetOrCreateSourceID(StringRef DirName, StringRef FileName) {
Bill Wendlingf5839192009-05-20 23:19:06 +00001551 unsigned DId;
1552 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
1553 if (DI != DirectoryIdMap.end()) {
1554 DId = DI->getValue();
1555 } else {
1556 DId = DirectoryNames.size() + 1;
1557 DirectoryIdMap[DirName] = DId;
1558 DirectoryNames.push_back(DirName);
1559 }
1560
1561 unsigned FId;
1562 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
1563 if (FI != SourceFileIdMap.end()) {
1564 FId = FI->getValue();
1565 } else {
1566 FId = SourceFileNames.size() + 1;
1567 SourceFileIdMap[FileName] = FId;
1568 SourceFileNames.push_back(FileName);
1569 }
1570
1571 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
1572 SourceIdMap.find(std::make_pair(DId, FId));
1573 if (SI != SourceIdMap.end())
1574 return SI->second;
1575
1576 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0.
1577 SourceIdMap[std::make_pair(DId, FId)] = SrcId;
1578 SourceIds.push_back(std::make_pair(DId, FId));
1579
1580 return SrcId;
1581}
1582
Devang Patel8287d662009-12-15 19:16:48 +00001583/// getOrCreateNameSpace - Create a DIE for DINameSpace.
1584DIE *DwarfDebug::getOrCreateNameSpace(DINameSpace NS) {
1585 DIE *NDie = ModuleCU->getDIE(NS.getNode());
1586 if (NDie)
1587 return NDie;
1588 NDie = new DIE(dwarf::DW_TAG_namespace);
1589 ModuleCU->insertDIE(NS.getNode(), NDie);
1590 if (!NS.getName().empty())
1591 addString(NDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, NS.getName());
1592 addSourceLine(NDie, &NS);
1593 addToContextOwner(NDie, NS.getContext());
1594 return NDie;
1595}
1596
Devang Patelb9f2c6b2009-12-11 21:37:07 +00001597CompileUnit *DwarfDebug::constructCompileUnit(MDNode *N) {
Devang Patel15e723d2009-08-28 23:24:31 +00001598 DICompileUnit DIUnit(N);
Devang Patel7f75bbe2009-11-25 17:36:49 +00001599 StringRef FN = DIUnit.getFilename();
1600 StringRef Dir = DIUnit.getDirectory();
Devang Patelaaf012e2009-09-29 18:40:58 +00001601 unsigned ID = GetOrCreateSourceID(Dir, FN);
Bill Wendlingf5839192009-05-20 23:19:06 +00001602
1603 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
Devang Patelc50078e2009-11-21 02:48:08 +00001604 addSectionOffset(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
Bill Wendlingf5839192009-05-20 23:19:06 +00001605 DWLabel("section_line", 0), DWLabel("section_line", 0),
1606 false);
Devang Patelc50078e2009-11-21 02:48:08 +00001607 addString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patelaaf012e2009-09-29 18:40:58 +00001608 DIUnit.getProducer());
Devang Patelc50078e2009-11-21 02:48:08 +00001609 addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
Bill Wendlingf5839192009-05-20 23:19:06 +00001610 DIUnit.getLanguage());
Devang Patelc50078e2009-11-21 02:48:08 +00001611 addString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
Bill Wendlingf5839192009-05-20 23:19:06 +00001612
Devang Patel7f75bbe2009-11-25 17:36:49 +00001613 if (!Dir.empty())
Devang Patelc50078e2009-11-21 02:48:08 +00001614 addString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
Bill Wendlingf5839192009-05-20 23:19:06 +00001615 if (DIUnit.isOptimized())
Devang Patelc50078e2009-11-21 02:48:08 +00001616 addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
Bill Wendlingf5839192009-05-20 23:19:06 +00001617
Devang Patel7f75bbe2009-11-25 17:36:49 +00001618 StringRef Flags = DIUnit.getFlags();
1619 if (!Flags.empty())
Devang Patelc50078e2009-11-21 02:48:08 +00001620 addString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
Bill Wendlingf5839192009-05-20 23:19:06 +00001621
1622 unsigned RVer = DIUnit.getRunTimeVersion();
1623 if (RVer)
Devang Patelc50078e2009-11-21 02:48:08 +00001624 addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
Bill Wendlingf5839192009-05-20 23:19:06 +00001625 dwarf::DW_FORM_data1, RVer);
1626
1627 CompileUnit *Unit = new CompileUnit(ID, Die);
Devang Patel5a3d37f2009-06-29 20:45:18 +00001628 if (!ModuleCU && DIUnit.isMain()) {
Devang Patelf97a05a2009-06-29 20:38:13 +00001629 // Use first compile unit marked as isMain as the compile unit
1630 // for this module.
Devang Patel5a3d37f2009-06-29 20:45:18 +00001631 ModuleCU = Unit;
Devang Patelf97a05a2009-06-29 20:38:13 +00001632 }
Bill Wendlingf5839192009-05-20 23:19:06 +00001633
Devang Patel15e723d2009-08-28 23:24:31 +00001634 CompileUnitMap[DIUnit.getNode()] = Unit;
Bill Wendlingf5839192009-05-20 23:19:06 +00001635 CompileUnits.push_back(Unit);
Devang Patelb9f2c6b2009-12-11 21:37:07 +00001636 return Unit;
Bill Wendlingf5839192009-05-20 23:19:06 +00001637}
1638
Devang Patelc50078e2009-11-21 02:48:08 +00001639void DwarfDebug::constructGlobalVariableDIE(MDNode *N) {
Devang Patel15e723d2009-08-28 23:24:31 +00001640 DIGlobalVariable DI_GV(N);
Daniel Dunbar41716322009-09-19 20:40:05 +00001641
Devang Patel0c03f062009-09-04 23:59:07 +00001642 // If debug information is malformed then ignore it.
1643 if (DI_GV.Verify() == false)
1644 return;
Bill Wendlingf5839192009-05-20 23:19:06 +00001645
1646 // Check for pre-existence.
Devang Pateld90672c2009-11-20 21:37:22 +00001647 if (ModuleCU->getDIE(DI_GV.getNode()))
Devang Patel166f8432009-06-26 01:49:18 +00001648 return;
Bill Wendlingf5839192009-05-20 23:19:06 +00001649
Devang Patelfe0be132009-12-09 18:24:21 +00001650 DIE *VariableDie = createGlobalVariableDIE(DI_GV);
Devang Patel6d479632009-12-10 23:25:41 +00001651 if (!VariableDie)
1652 return;
Bill Wendlingf5839192009-05-20 23:19:06 +00001653
Bill Wendlingf5839192009-05-20 23:19:06 +00001654 // Add to map.
Devang Pateld90672c2009-11-20 21:37:22 +00001655 ModuleCU->insertDIE(N, VariableDie);
Bill Wendlingf5839192009-05-20 23:19:06 +00001656
1657 // Add to context owner.
Devang Pateldcc0dce2010-01-15 01:12:22 +00001658 DIDescriptor GVContext = DI_GV.getContext();
1659 // Do not create specification DIE if context is either compile unit
1660 // or a subprogram.
1661 if (DI_GV.isDefinition() && !GVContext.isCompileUnit()
1662 && !GVContext.isSubprogram()) {
Devang Patel8287d662009-12-15 19:16:48 +00001663 // Create specification DIE.
1664 DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1665 addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1666 dwarf::DW_FORM_ref4, VariableDie);
1667 DIEBlock *Block = new DIEBlock();
1668 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1669 addObjectLabel(Block, 0, dwarf::DW_FORM_udata,
Chris Lattner41e330f2010-01-16 18:50:28 +00001670 Asm->GetGlobalValueSymbol(DI_GV.getGlobal()));
Devang Patel8287d662009-12-15 19:16:48 +00001671 addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
1672 ModuleCU->addDie(VariableSpecDIE);
1673 } else {
1674 DIEBlock *Block = new DIEBlock();
1675 addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1676 addObjectLabel(Block, 0, dwarf::DW_FORM_udata,
Chris Lattner41e330f2010-01-16 18:50:28 +00001677 Asm->GetGlobalValueSymbol(DI_GV.getGlobal()));
Devang Patel8287d662009-12-15 19:16:48 +00001678 addBlock(VariableDie, dwarf::DW_AT_location, 0, Block);
1679 }
Devang Pateldcc0dce2010-01-15 01:12:22 +00001680 addToContextOwner(VariableDie, GVContext);
Devang Patel1a8f9a82009-12-10 19:14:49 +00001681
Bill Wendlingf5839192009-05-20 23:19:06 +00001682 // Expose as global. FIXME - need to check external flag.
Devang Patelc50078e2009-11-21 02:48:08 +00001683 ModuleCU->addGlobal(DI_GV.getName(), VariableDie);
Devang Patelec13b4f2009-11-24 01:14:22 +00001684
1685 DIType GTy = DI_GV.getType();
Devang Patel7f75bbe2009-11-25 17:36:49 +00001686 if (GTy.isCompositeType() && !GTy.getName().empty()) {
Devang Patelec13b4f2009-11-24 01:14:22 +00001687 DIEEntry *Entry = ModuleCU->getDIEEntry(GTy.getNode());
1688 assert (Entry && "Missing global type!");
1689 ModuleCU->addGlobalType(GTy.getName(), Entry->getEntry());
1690 }
Devang Patel166f8432009-06-26 01:49:18 +00001691 return;
Bill Wendlingf5839192009-05-20 23:19:06 +00001692}
1693
Devang Patelc50078e2009-11-21 02:48:08 +00001694void DwarfDebug::constructSubprogramDIE(MDNode *N) {
Devang Patel15e723d2009-08-28 23:24:31 +00001695 DISubprogram SP(N);
Bill Wendlingf5839192009-05-20 23:19:06 +00001696
1697 // Check for pre-existence.
Devang Pateld90672c2009-11-20 21:37:22 +00001698 if (ModuleCU->getDIE(N))
Devang Patel166f8432009-06-26 01:49:18 +00001699 return;
Bill Wendlingf5839192009-05-20 23:19:06 +00001700
1701 if (!SP.isDefinition())
1702 // This is a method declaration which will be handled while constructing
1703 // class type.
Devang Patel166f8432009-06-26 01:49:18 +00001704 return;
Bill Wendlingf5839192009-05-20 23:19:06 +00001705
Devang Patelfe0be132009-12-09 18:24:21 +00001706 DIE *SubprogramDie = createSubprogramDIE(SP);
Bill Wendlingf5839192009-05-20 23:19:06 +00001707
1708 // Add to map.
Devang Pateld90672c2009-11-20 21:37:22 +00001709 ModuleCU->insertDIE(N, SubprogramDie);
Bill Wendlingf5839192009-05-20 23:19:06 +00001710
1711 // Add to context owner.
Devang Patel8287d662009-12-15 19:16:48 +00001712 addToContextOwner(SubprogramDie, SP.getContext());
Devang Patelde2d3682009-12-08 23:21:45 +00001713
Bill Wendlingf5839192009-05-20 23:19:06 +00001714 // Expose as global.
Devang Patelc50078e2009-11-21 02:48:08 +00001715 ModuleCU->addGlobal(SP.getName(), SubprogramDie);
Devang Patelec13b4f2009-11-24 01:14:22 +00001716
Devang Patel166f8432009-06-26 01:49:18 +00001717 return;
Bill Wendlingf5839192009-05-20 23:19:06 +00001718}
1719
Devang Patelc50078e2009-11-21 02:48:08 +00001720/// beginModule - Emit all Dwarf sections that should come prior to the
Daniel Dunbar19f1d442009-09-19 20:40:14 +00001721/// content. Create global DIEs and emit initial debug info sections.
1722/// This is inovked by the target AsmPrinter.
Devang Patelc50078e2009-11-21 02:48:08 +00001723void DwarfDebug::beginModule(Module *M, MachineModuleInfo *mmi) {
Devang Patel59a1d422009-06-25 22:36:02 +00001724 this->M = M;
1725
Bill Wendlingf5839192009-05-20 23:19:06 +00001726 if (TimePassesIsEnabled)
1727 DebugTimer->startTimer();
1728
Devang Patel1b4d6832009-11-11 19:55:08 +00001729 if (!MAI->doesSupportDebugInformation())
1730 return;
1731
Devang Patelfda766d2009-07-30 18:56:46 +00001732 DebugInfoFinder DbgFinder;
1733 DbgFinder.processModule(*M);
Devang Patel166f8432009-06-26 01:49:18 +00001734
Bill Wendlingf5839192009-05-20 23:19:06 +00001735 // Create all the compile unit DIEs.
Devang Patelfda766d2009-07-30 18:56:46 +00001736 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1737 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patelc50078e2009-11-21 02:48:08 +00001738 constructCompileUnit(*I);
Bill Wendlingf5839192009-05-20 23:19:06 +00001739
1740 if (CompileUnits.empty()) {
1741 if (TimePassesIsEnabled)
1742 DebugTimer->stopTimer();
1743
1744 return;
1745 }
1746
Devang Patelf97a05a2009-06-29 20:38:13 +00001747 // If main compile unit for this module is not seen than randomly
1748 // select first compile unit.
Devang Patel5a3d37f2009-06-29 20:45:18 +00001749 if (!ModuleCU)
1750 ModuleCU = CompileUnits[0];
Devang Patelf97a05a2009-06-29 20:38:13 +00001751
Devang Patel90a0fe32009-11-10 23:06:00 +00001752 // Create DIEs for each subprogram.
Devang Patelfda766d2009-07-30 18:56:46 +00001753 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
1754 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patelc50078e2009-11-21 02:48:08 +00001755 constructSubprogramDIE(*I);
Devang Patel166f8432009-06-26 01:49:18 +00001756
Devang Patel1a8f9a82009-12-10 19:14:49 +00001757 // Create DIEs for each global variable.
1758 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
1759 E = DbgFinder.global_variable_end(); I != E; ++I)
1760 constructGlobalVariableDIE(*I);
1761
Bill Wendlingf5839192009-05-20 23:19:06 +00001762 MMI = mmi;
1763 shouldEmit = true;
1764 MMI->setDebugInfoAvailability(true);
1765
1766 // Prime section data.
Chris Lattnerc4c40a92009-07-28 03:13:23 +00001767 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf5839192009-05-20 23:19:06 +00001768
1769 // Print out .file directives to specify files for .loc directives. These are
1770 // printed out early so that they precede any .loc directives.
Chris Lattnera5ef4d32009-08-22 21:43:10 +00001771 if (MAI->hasDotLocAndDotFile()) {
Bill Wendlingf5839192009-05-20 23:19:06 +00001772 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
1773 // Remember source id starts at 1.
1774 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
Chris Lattnerad653482010-01-22 22:09:00 +00001775 // FIXME: don't use sys::path for this! This should not depend on the
1776 // host.
Bill Wendlingf5839192009-05-20 23:19:06 +00001777 sys::Path FullPath(getSourceDirectoryName(Id.first));
1778 bool AppendOk =
1779 FullPath.appendComponent(getSourceFileName(Id.second));
1780 assert(AppendOk && "Could not append filename to directory!");
1781 AppendOk = false;
Chris Lattnerb1aa85b2009-08-23 22:45:37 +00001782 Asm->EmitFile(i, FullPath.str());
Chris Lattnerad653482010-01-22 22:09:00 +00001783 Asm->O << '\n';
Bill Wendlingf5839192009-05-20 23:19:06 +00001784 }
1785 }
1786
1787 // Emit initial sections
Devang Patelc50078e2009-11-21 02:48:08 +00001788 emitInitial();
Bill Wendlingf5839192009-05-20 23:19:06 +00001789
1790 if (TimePassesIsEnabled)
1791 DebugTimer->stopTimer();
1792}
1793
Devang Patelc50078e2009-11-21 02:48:08 +00001794/// endModule - Emit all Dwarf sections that should come after the content.
Bill Wendlingf5839192009-05-20 23:19:06 +00001795///
Devang Patelc50078e2009-11-21 02:48:08 +00001796void DwarfDebug::endModule() {
Devang Patel95d477e2009-10-06 00:03:14 +00001797 if (!ModuleCU)
Bill Wendlingf5839192009-05-20 23:19:06 +00001798 return;
1799
1800 if (TimePassesIsEnabled)
1801 DebugTimer->startTimer();
1802
Devang Patel90a0fe32009-11-10 23:06:00 +00001803 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1804 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
1805 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
1806 DIE *ISP = *AI;
Devang Patelc50078e2009-11-21 02:48:08 +00001807 addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
Devang Patel90a0fe32009-11-10 23:06:00 +00001808 }
1809
Devang Patelc1df8792009-12-03 01:25:38 +00001810 // Insert top level DIEs.
1811 for (SmallVector<DIE *, 4>::iterator TI = TopLevelDIEsVector.begin(),
1812 TE = TopLevelDIEsVector.end(); TI != TE; ++TI)
1813 ModuleCU->getCUDie()->addChild(*TI);
1814
Devang Patel7d707f92010-01-19 06:19:05 +00001815 for (DenseMap<DIE *, MDNode *>::iterator CI = ContainingTypeMap.begin(),
Devang Patel188c85d2009-12-03 19:11:07 +00001816 CE = ContainingTypeMap.end(); CI != CE; ++CI) {
1817 DIE *SPDie = CI->first;
1818 MDNode *N = dyn_cast_or_null<MDNode>(CI->second);
1819 if (!N) continue;
1820 DIE *NDie = ModuleCU->getDIE(N);
1821 if (!NDie) continue;
1822 addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Patel69aae432010-01-15 00:26:31 +00001823 // FIXME - This is not the correct approach.
1824 // addDIEEntry(NDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
Devang Patel188c85d2009-12-03 19:11:07 +00001825 }
1826
Bill Wendlingf5839192009-05-20 23:19:06 +00001827 // Standard sections final addresses.
Chris Lattner73266f92009-08-19 05:49:37 +00001828 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf5839192009-05-20 23:19:06 +00001829 EmitLabel("text_end", 0);
Chris Lattner73266f92009-08-19 05:49:37 +00001830 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Bill Wendlingf5839192009-05-20 23:19:06 +00001831 EmitLabel("data_end", 0);
1832
1833 // End text sections.
1834 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner73266f92009-08-19 05:49:37 +00001835 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Bill Wendlingf5839192009-05-20 23:19:06 +00001836 EmitLabel("section_end", i);
1837 }
1838
1839 // Emit common frame information.
Devang Patelc50078e2009-11-21 02:48:08 +00001840 emitCommonDebugFrame();
Bill Wendlingf5839192009-05-20 23:19:06 +00001841
1842 // Emit function debug frame information
1843 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
1844 E = DebugFrames.end(); I != E; ++I)
Devang Patelc50078e2009-11-21 02:48:08 +00001845 emitFunctionDebugFrame(*I);
Bill Wendlingf5839192009-05-20 23:19:06 +00001846
1847 // Compute DIE offsets and sizes.
Devang Patelc50078e2009-11-21 02:48:08 +00001848 computeSizeAndOffsets();
Bill Wendlingf5839192009-05-20 23:19:06 +00001849
1850 // Emit all the DIEs into a debug info section
Devang Patelc50078e2009-11-21 02:48:08 +00001851 emitDebugInfo();
Bill Wendlingf5839192009-05-20 23:19:06 +00001852
1853 // Corresponding abbreviations into a abbrev section.
Devang Patelc50078e2009-11-21 02:48:08 +00001854 emitAbbreviations();
Bill Wendlingf5839192009-05-20 23:19:06 +00001855
1856 // Emit source line correspondence into a debug line section.
Devang Patelc50078e2009-11-21 02:48:08 +00001857 emitDebugLines();
Bill Wendlingf5839192009-05-20 23:19:06 +00001858
1859 // Emit info into a debug pubnames section.
Devang Patelc50078e2009-11-21 02:48:08 +00001860 emitDebugPubNames();
Bill Wendlingf5839192009-05-20 23:19:06 +00001861
Devang Patelec13b4f2009-11-24 01:14:22 +00001862 // Emit info into a debug pubtypes section.
1863 emitDebugPubTypes();
1864
Bill Wendlingf5839192009-05-20 23:19:06 +00001865 // Emit info into a debug str section.
Devang Patelc50078e2009-11-21 02:48:08 +00001866 emitDebugStr();
Bill Wendlingf5839192009-05-20 23:19:06 +00001867
1868 // Emit info into a debug loc section.
Devang Patelc50078e2009-11-21 02:48:08 +00001869 emitDebugLoc();
Bill Wendlingf5839192009-05-20 23:19:06 +00001870
1871 // Emit info into a debug aranges section.
1872 EmitDebugARanges();
1873
1874 // Emit info into a debug ranges section.
Devang Patelc50078e2009-11-21 02:48:08 +00001875 emitDebugRanges();
Bill Wendlingf5839192009-05-20 23:19:06 +00001876
1877 // Emit info into a debug macinfo section.
Devang Patelc50078e2009-11-21 02:48:08 +00001878 emitDebugMacInfo();
Bill Wendlingf5839192009-05-20 23:19:06 +00001879
1880 // Emit inline info.
Devang Patelc50078e2009-11-21 02:48:08 +00001881 emitDebugInlineInfo();
Bill Wendlingf5839192009-05-20 23:19:06 +00001882
1883 if (TimePassesIsEnabled)
1884 DebugTimer->stopTimer();
1885}
1886
Devang Patel90a0fe32009-11-10 23:06:00 +00001887/// findAbstractVariable - Find abstract variable, if any, associated with Var.
Jim Grosbachb23f2422009-11-22 19:20:36 +00001888DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var,
1889 unsigned FrameIdx,
Devang Patel90a0fe32009-11-10 23:06:00 +00001890 DILocation &ScopeLoc) {
1891
1892 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var.getNode());
1893 if (AbsDbgVariable)
1894 return AbsDbgVariable;
1895
1896 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope().getNode());
1897 if (!Scope)
1898 return NULL;
1899
1900 AbsDbgVariable = new DbgVariable(Var, FrameIdx);
Devang Patelc50078e2009-11-21 02:48:08 +00001901 Scope->addVariable(AbsDbgVariable);
Devang Patel90a0fe32009-11-10 23:06:00 +00001902 AbstractVariables[Var.getNode()] = AbsDbgVariable;
1903 return AbsDbgVariable;
1904}
1905
Devang Patelc50078e2009-11-21 02:48:08 +00001906/// collectVariableInfo - Populate DbgScope entries with variables' info.
1907void DwarfDebug::collectVariableInfo() {
Devang Patel40c80212009-10-09 22:42:28 +00001908 if (!MMI) return;
Devang Patel90a0fe32009-11-10 23:06:00 +00001909
Devang Patel84139992009-10-06 01:26:37 +00001910 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1911 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1912 VE = VMap.end(); VI != VE; ++VI) {
Devang Patel40c80212009-10-09 22:42:28 +00001913 MetadataBase *MB = VI->first;
1914 MDNode *Var = dyn_cast_or_null<MDNode>(MB);
Devang Patel90a0fe32009-11-10 23:06:00 +00001915 if (!Var) continue;
Devang Patel6882dff2009-10-08 18:48:03 +00001916 DIVariable DV (Var);
Devang Patel90a0fe32009-11-10 23:06:00 +00001917 std::pair< unsigned, MDNode *> VP = VI->second;
1918 DILocation ScopeLoc(VP.second);
1919
1920 DbgScope *Scope =
1921 ConcreteScopes.lookup(ScopeLoc.getOrigLocation().getNode());
1922 if (!Scope)
Jim Grosbach652b7432009-11-21 23:12:12 +00001923 Scope = DbgScopeMap.lookup(ScopeLoc.getScope().getNode());
Devang Patelbad42262009-11-10 23:20:04 +00001924 // If variable scope is not found then skip this variable.
1925 if (!Scope)
1926 continue;
Devang Patel90a0fe32009-11-10 23:06:00 +00001927
1928 DbgVariable *RegVar = new DbgVariable(DV, VP.first);
Devang Patelc50078e2009-11-21 02:48:08 +00001929 Scope->addVariable(RegVar);
Jim Grosbachb23f2422009-11-22 19:20:36 +00001930 if (DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.first,
1931 ScopeLoc))
Devang Patel90a0fe32009-11-10 23:06:00 +00001932 RegVar->setAbstractVariable(AbsDbgVariable);
Devang Patel84139992009-10-06 01:26:37 +00001933 }
1934}
1935
Devang Patelc50078e2009-11-21 02:48:08 +00001936/// beginScope - Process beginning of a scope starting at Label.
1937void DwarfDebug::beginScope(const MachineInstr *MI, unsigned Label) {
Devang Patel393a46d2009-10-06 01:50:42 +00001938 InsnToDbgScopeMapTy::iterator I = DbgScopeBeginMap.find(MI);
1939 if (I == DbgScopeBeginMap.end())
1940 return;
Dan Gohman8d34f972009-11-23 21:30:55 +00001941 ScopeVector &SD = I->second;
Devang Patel90a0fe32009-11-10 23:06:00 +00001942 for (ScopeVector::iterator SDI = SD.begin(), SDE = SD.end();
Jim Grosbach652b7432009-11-21 23:12:12 +00001943 SDI != SDE; ++SDI)
Devang Patel393a46d2009-10-06 01:50:42 +00001944 (*SDI)->setStartLabelID(Label);
1945}
1946
Devang Patelc50078e2009-11-21 02:48:08 +00001947/// endScope - Process end of a scope.
1948void DwarfDebug::endScope(const MachineInstr *MI) {
Devang Patel393a46d2009-10-06 01:50:42 +00001949 InsnToDbgScopeMapTy::iterator I = DbgScopeEndMap.find(MI);
Devang Patelf4348892009-10-06 03:15:38 +00001950 if (I == DbgScopeEndMap.end())
Devang Patel393a46d2009-10-06 01:50:42 +00001951 return;
Devang Patel90a0fe32009-11-10 23:06:00 +00001952
1953 unsigned Label = MMI->NextLabelID();
1954 Asm->printLabel(Label);
Dan Gohmancfca6e32009-12-05 01:42:34 +00001955 O << '\n';
Devang Patel90a0fe32009-11-10 23:06:00 +00001956
Devang Patel393a46d2009-10-06 01:50:42 +00001957 SmallVector<DbgScope *, 2> &SD = I->second;
1958 for (SmallVector<DbgScope *, 2>::iterator SDI = SD.begin(), SDE = SD.end();
Jim Grosbach652b7432009-11-21 23:12:12 +00001959 SDI != SDE; ++SDI)
Devang Patel393a46d2009-10-06 01:50:42 +00001960 (*SDI)->setEndLabelID(Label);
Devang Patel90a0fe32009-11-10 23:06:00 +00001961 return;
1962}
1963
1964/// createDbgScope - Create DbgScope for the scope.
1965void DwarfDebug::createDbgScope(MDNode *Scope, MDNode *InlinedAt) {
1966
1967 if (!InlinedAt) {
1968 DbgScope *WScope = DbgScopeMap.lookup(Scope);
1969 if (WScope)
1970 return;
1971 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
1972 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Jim Grosbach652b7432009-11-21 23:12:12 +00001973 if (DIDescriptor(Scope).isLexicalBlock())
Devang Patel53addbf2009-11-11 00:18:40 +00001974 createDbgScope(DILexicalBlock(Scope).getContext().getNode(), NULL);
Devang Patel90a0fe32009-11-10 23:06:00 +00001975 return;
1976 }
1977
1978 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
1979 if (WScope)
1980 return;
1981
1982 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
1983 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
1984 DILocation DL(InlinedAt);
1985 createDbgScope(DL.getScope().getNode(), DL.getOrigLocation().getNode());
Devang Patel393a46d2009-10-06 01:50:42 +00001986}
1987
Devang Patelc50078e2009-11-21 02:48:08 +00001988/// extractScopeInformation - Scan machine instructions in this function
Devang Patel6a260102009-10-01 20:31:14 +00001989/// and collect DbgScopes. Return true, if atleast one scope was found.
Devang Patelc50078e2009-11-21 02:48:08 +00001990bool DwarfDebug::extractScopeInformation(MachineFunction *MF) {
Devang Patel6a260102009-10-01 20:31:14 +00001991 // If scope information was extracted using .dbg intrinsics then there is not
1992 // any need to extract these information by scanning each instruction.
1993 if (!DbgScopeMap.empty())
1994 return false;
1995
Devang Patel98e77302010-01-04 20:44:00 +00001996 DenseMap<const MachineInstr *, unsigned> MIIndexMap;
1997 unsigned MIIndex = 0;
Devang Patel90a0fe32009-11-10 23:06:00 +00001998 // Scan each instruction and create scopes. First build working set of scopes.
Devang Patel6a260102009-10-01 20:31:14 +00001999 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2000 I != E; ++I) {
2001 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2002 II != IE; ++II) {
2003 const MachineInstr *MInsn = II;
Devang Patel98e77302010-01-04 20:44:00 +00002004 MIIndexMap[MInsn] = MIIndex++;
Devang Patel6a260102009-10-01 20:31:14 +00002005 DebugLoc DL = MInsn->getDebugLoc();
Devang Patel90a0fe32009-11-10 23:06:00 +00002006 if (DL.isUnknown()) continue;
Devang Patel042945f2010-01-16 06:09:35 +00002007 DILocation DLT = MF->getDILocation(DL);
2008 DIScope DLTScope = DLT.getScope();
2009 if (DLTScope.isNull()) continue;
Devang Patel6a260102009-10-01 20:31:14 +00002010 // There is no need to create another DIE for compile unit. For all
Jim Grosbach652b7432009-11-21 23:12:12 +00002011 // other scopes, create one DbgScope now. This will be translated
Devang Patel6a260102009-10-01 20:31:14 +00002012 // into a scope DIE at the end.
Devang Patel042945f2010-01-16 06:09:35 +00002013 if (DLTScope.isCompileUnit()) continue;
2014 createDbgScope(DLTScope.getNode(), DLT.getOrigLocation().getNode());
Devang Patel90a0fe32009-11-10 23:06:00 +00002015 }
2016 }
2017
2018
2019 // Build scope hierarchy using working set of scopes.
2020 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2021 I != E; ++I) {
2022 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2023 II != IE; ++II) {
2024 const MachineInstr *MInsn = II;
2025 DebugLoc DL = MInsn->getDebugLoc();
2026 if (DL.isUnknown()) continue;
Devang Patel042945f2010-01-16 06:09:35 +00002027 DILocation DLT = MF->getDILocation(DL);
2028 DIScope DLTScope = DLT.getScope();
2029 if (DLTScope.isNull()) continue;
Devang Patel90a0fe32009-11-10 23:06:00 +00002030 // There is no need to create another DIE for compile unit. For all
Jim Grosbach652b7432009-11-21 23:12:12 +00002031 // other scopes, create one DbgScope now. This will be translated
Devang Patel90a0fe32009-11-10 23:06:00 +00002032 // into a scope DIE at the end.
Devang Patel042945f2010-01-16 06:09:35 +00002033 if (DLTScope.isCompileUnit()) continue;
2034 DbgScope *Scope = getUpdatedDbgScope(DLTScope.getNode(), MInsn,
2035 DLT.getOrigLocation().getNode());
Devang Patel90a0fe32009-11-10 23:06:00 +00002036 Scope->setLastInsn(MInsn);
Devang Patel6a260102009-10-01 20:31:14 +00002037 }
2038 }
2039
Devang Patel98e77302010-01-04 20:44:00 +00002040 if (!CurrentFnDbgScope)
2041 return false;
2042
2043 CurrentFnDbgScope->fixInstructionMarkers(MIIndexMap);
Devang Patel6a260102009-10-01 20:31:14 +00002044
2045 // Each scope has first instruction and last instruction to mark beginning
2046 // and end of a scope respectively. Create an inverse map that list scopes
2047 // starts (and ends) with an instruction. One instruction may start (or end)
Devang Patelfd311df2010-01-20 02:05:23 +00002048 // multiple scopes. Ignore scopes that are not reachable.
2049 SmallVector<DbgScope *, 4> WorkList;
2050 WorkList.push_back(CurrentFnDbgScope);
2051 while (!WorkList.empty()) {
2052 DbgScope *S = WorkList.back(); WorkList.pop_back();
2053
2054 SmallVector<DbgScope *, 4> &Children = S->getScopes();
2055 if (!Children.empty())
2056 for (SmallVector<DbgScope *, 4>::iterator SI = Children.begin(),
2057 SE = Children.end(); SI != SE; ++SI)
2058 WorkList.push_back(*SI);
2059
Devang Patel90a0fe32009-11-10 23:06:00 +00002060 if (S->isAbstractScope())
2061 continue;
Devang Patel6a260102009-10-01 20:31:14 +00002062 const MachineInstr *MI = S->getFirstInsn();
2063 assert (MI && "DbgScope does not have first instruction!");
2064
2065 InsnToDbgScopeMapTy::iterator IDI = DbgScopeBeginMap.find(MI);
2066 if (IDI != DbgScopeBeginMap.end())
2067 IDI->second.push_back(S);
2068 else
Devang Patel90a0fe32009-11-10 23:06:00 +00002069 DbgScopeBeginMap[MI].push_back(S);
Devang Patel6a260102009-10-01 20:31:14 +00002070
2071 MI = S->getLastInsn();
2072 assert (MI && "DbgScope does not have last instruction!");
2073 IDI = DbgScopeEndMap.find(MI);
2074 if (IDI != DbgScopeEndMap.end())
2075 IDI->second.push_back(S);
2076 else
Devang Patel90a0fe32009-11-10 23:06:00 +00002077 DbgScopeEndMap[MI].push_back(S);
Devang Patel6a260102009-10-01 20:31:14 +00002078 }
2079
2080 return !DbgScopeMap.empty();
2081}
2082
Devang Patelc50078e2009-11-21 02:48:08 +00002083/// beginFunction - Gather pre-function debug information. Assumes being
Bill Wendlingf5839192009-05-20 23:19:06 +00002084/// emitted immediately after the function entry point.
Devang Patelc50078e2009-11-21 02:48:08 +00002085void DwarfDebug::beginFunction(MachineFunction *MF) {
Bill Wendlingf5839192009-05-20 23:19:06 +00002086 this->MF = MF;
2087
2088 if (!ShouldEmitDwarfDebug()) return;
2089
2090 if (TimePassesIsEnabled)
2091 DebugTimer->startTimer();
2092
Devang Patelc50078e2009-11-21 02:48:08 +00002093 if (!extractScopeInformation(MF))
Devang Patel0feae422009-10-06 18:37:31 +00002094 return;
Devang Patelc50078e2009-11-21 02:48:08 +00002095
2096 collectVariableInfo();
Devang Patel0feae422009-10-06 18:37:31 +00002097
Bill Wendlingf5839192009-05-20 23:19:06 +00002098 // Begin accumulating function debug information.
2099 MMI->BeginFunction(MF);
2100
2101 // Assumes in correct section after the entry point.
2102 EmitLabel("func_begin", ++SubprogramCount);
2103
2104 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2105 // function.
Devang Patel40c80212009-10-09 22:42:28 +00002106 DebugLoc FDL = MF->getDefaultDebugLoc();
2107 if (!FDL.isUnknown()) {
Devang Patel042945f2010-01-16 06:09:35 +00002108 DILocation DLT = MF->getDILocation(FDL);
Devang Patel40c80212009-10-09 22:42:28 +00002109 unsigned LabelID = 0;
Devang Patel042945f2010-01-16 06:09:35 +00002110 DISubprogram SP = getDISubprogram(DLT.getScope().getNode());
Devang Patel40c80212009-10-09 22:42:28 +00002111 if (!SP.isNull())
Devang Patel042945f2010-01-16 06:09:35 +00002112 LabelID = recordSourceLine(SP.getLineNumber(), 0,
2113 DLT.getScope().getNode());
Devang Patel40c80212009-10-09 22:42:28 +00002114 else
Devang Patel042945f2010-01-16 06:09:35 +00002115 LabelID = recordSourceLine(DLT.getLineNumber(),
2116 DLT.getColumnNumber(),
2117 DLT.getScope().getNode());
Devang Patel40c80212009-10-09 22:42:28 +00002118 Asm->printLabel(LabelID);
2119 O << '\n';
Bill Wendlingf5839192009-05-20 23:19:06 +00002120 }
Bill Wendlingf5839192009-05-20 23:19:06 +00002121 if (TimePassesIsEnabled)
2122 DebugTimer->stopTimer();
2123}
2124
Devang Patelc50078e2009-11-21 02:48:08 +00002125/// endFunction - Gather and emit post-function debug information.
Bill Wendlingf5839192009-05-20 23:19:06 +00002126///
Devang Patelc50078e2009-11-21 02:48:08 +00002127void DwarfDebug::endFunction(MachineFunction *MF) {
Bill Wendlingf5839192009-05-20 23:19:06 +00002128 if (!ShouldEmitDwarfDebug()) return;
2129
2130 if (TimePassesIsEnabled)
2131 DebugTimer->startTimer();
2132
Devang Patel40c80212009-10-09 22:42:28 +00002133 if (DbgScopeMap.empty())
2134 return;
Devang Patel4a7ef8d2009-11-12 19:02:56 +00002135
Devang Patel98e77302010-01-04 20:44:00 +00002136 if (CurrentFnDbgScope) {
2137 // Define end label for subprogram.
2138 EmitLabel("func_end", SubprogramCount);
2139
2140 // Get function line info.
2141 if (!Lines.empty()) {
2142 // Get section line info.
2143 unsigned ID = SectionMap.insert(Asm->getCurrentSection());
2144 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2145 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2146 // Append the function info to section info.
2147 SectionLineInfos.insert(SectionLineInfos.end(),
2148 Lines.begin(), Lines.end());
2149 }
2150
2151 // Construct abstract scopes.
2152 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
2153 AE = AbstractScopesList.end(); AI != AE; ++AI)
2154 constructScopeDIE(*AI);
2155
2156 constructScopeDIE(CurrentFnDbgScope);
2157
2158 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
2159 MMI->getFrameMoves()));
Bill Wendlingf5839192009-05-20 23:19:06 +00002160 }
2161
Bill Wendlingf5839192009-05-20 23:19:06 +00002162 // Clear debug info
Devang Patel387e9c12010-01-19 01:26:02 +00002163 CurrentFnDbgScope = NULL;
2164 DbgScopeMap.clear();
2165 DbgScopeBeginMap.clear();
2166 DbgScopeEndMap.clear();
2167 ConcreteScopes.clear();
2168 AbstractScopesList.clear();
Bill Wendlingf5839192009-05-20 23:19:06 +00002169 Lines.clear();
Devang Patel67533ab2009-12-01 18:13:48 +00002170
Bill Wendlingf5839192009-05-20 23:19:06 +00002171 if (TimePassesIsEnabled)
2172 DebugTimer->stopTimer();
2173}
2174
Devang Patelc50078e2009-11-21 02:48:08 +00002175/// recordSourceLine - Records location information and associates it with a
Bill Wendlingf5839192009-05-20 23:19:06 +00002176/// label. Returns a unique label ID used to generate a label and provide
2177/// correspondence to the source line list.
Jim Grosbach652b7432009-11-21 23:12:12 +00002178unsigned DwarfDebug::recordSourceLine(unsigned Line, unsigned Col,
Devang Patel946d0ae2009-10-05 18:03:19 +00002179 MDNode *S) {
Devang Patel15e723d2009-08-28 23:24:31 +00002180 if (!MMI)
2181 return 0;
2182
Bill Wendlingf5839192009-05-20 23:19:06 +00002183 if (TimePassesIsEnabled)
2184 DebugTimer->startTimer();
2185
Devang Patel7f75bbe2009-11-25 17:36:49 +00002186 StringRef Dir;
2187 StringRef Fn;
Devang Patel946d0ae2009-10-05 18:03:19 +00002188
2189 DIDescriptor Scope(S);
2190 if (Scope.isCompileUnit()) {
2191 DICompileUnit CU(S);
2192 Dir = CU.getDirectory();
2193 Fn = CU.getFilename();
2194 } else if (Scope.isSubprogram()) {
2195 DISubprogram SP(S);
2196 Dir = SP.getDirectory();
2197 Fn = SP.getFilename();
2198 } else if (Scope.isLexicalBlock()) {
2199 DILexicalBlock DB(S);
2200 Dir = DB.getDirectory();
2201 Fn = DB.getFilename();
2202 } else
2203 assert (0 && "Unexpected scope info");
2204
2205 unsigned Src = GetOrCreateSourceID(Dir, Fn);
Bill Wendlingf5839192009-05-20 23:19:06 +00002206 unsigned ID = MMI->NextLabelID();
2207 Lines.push_back(SrcLineInfo(Line, Col, Src, ID));
2208
2209 if (TimePassesIsEnabled)
2210 DebugTimer->stopTimer();
2211
2212 return ID;
2213}
2214
2215/// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be
2216/// timed. Look up the source id with the given directory and source file
2217/// names. If none currently exists, create a new id and insert it in the
2218/// SourceIds map. This can update DirectoryNames and SourceFileNames maps as
2219/// well.
2220unsigned DwarfDebug::getOrCreateSourceID(const std::string &DirName,
2221 const std::string &FileName) {
2222 if (TimePassesIsEnabled)
2223 DebugTimer->startTimer();
2224
Devang Patelaaf012e2009-09-29 18:40:58 +00002225 unsigned SrcId = GetOrCreateSourceID(DirName.c_str(), FileName.c_str());
Bill Wendlingf5839192009-05-20 23:19:06 +00002226
2227 if (TimePassesIsEnabled)
2228 DebugTimer->stopTimer();
2229
2230 return SrcId;
2231}
2232
Bill Wendlinge1a5bbb2009-05-20 23:22:40 +00002233//===----------------------------------------------------------------------===//
2234// Emit Methods
2235//===----------------------------------------------------------------------===//
2236
Devang Patelc50078e2009-11-21 02:48:08 +00002237/// computeSizeAndOffset - Compute the size and offset of a DIE.
Bill Wendling55fccda2009-05-20 23:21:38 +00002238///
Jim Grosbachb23f2422009-11-22 19:20:36 +00002239unsigned
2240DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
Bill Wendling55fccda2009-05-20 23:21:38 +00002241 // Get the children.
2242 const std::vector<DIE *> &Children = Die->getChildren();
2243
2244 // If not last sibling and has children then add sibling offset attribute.
Devang Patelc50078e2009-11-21 02:48:08 +00002245 if (!Last && !Children.empty()) Die->addSiblingOffset();
Bill Wendling55fccda2009-05-20 23:21:38 +00002246
2247 // Record the abbreviation.
Devang Patelc50078e2009-11-21 02:48:08 +00002248 assignAbbrevNumber(Die->getAbbrev());
Bill Wendling55fccda2009-05-20 23:21:38 +00002249
2250 // Get the abbreviation for this DIE.
2251 unsigned AbbrevNumber = Die->getAbbrevNumber();
2252 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2253
2254 // Set DIE offset
2255 Die->setOffset(Offset);
2256
2257 // Start the size with the size of abbreviation code.
Chris Lattner621c44d2009-08-22 20:48:53 +00002258 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling55fccda2009-05-20 23:21:38 +00002259
2260 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2261 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2262
2263 // Size the DIE attribute values.
2264 for (unsigned i = 0, N = Values.size(); i < N; ++i)
2265 // Size attribute value.
2266 Offset += Values[i]->SizeOf(TD, AbbrevData[i].getForm());
2267
2268 // Size the DIE children if any.
2269 if (!Children.empty()) {
2270 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
2271 "Children flag not set");
2272
2273 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patelc50078e2009-11-21 02:48:08 +00002274 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
Bill Wendling55fccda2009-05-20 23:21:38 +00002275
2276 // End of children marker.
2277 Offset += sizeof(int8_t);
2278 }
2279
2280 Die->setSize(Offset - Die->getOffset());
2281 return Offset;
2282}
2283
Devang Patelc50078e2009-11-21 02:48:08 +00002284/// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
Bill Wendling55fccda2009-05-20 23:21:38 +00002285///
Devang Patelc50078e2009-11-21 02:48:08 +00002286void DwarfDebug::computeSizeAndOffsets() {
Bill Wendling55fccda2009-05-20 23:21:38 +00002287 // Compute size of compile unit header.
2288 static unsigned Offset =
2289 sizeof(int32_t) + // Length of Compilation Unit Info
2290 sizeof(int16_t) + // DWARF version number
2291 sizeof(int32_t) + // Offset Into Abbrev. Section
2292 sizeof(int8_t); // Pointer Size (in bytes)
2293
Devang Patelc50078e2009-11-21 02:48:08 +00002294 computeSizeAndOffset(ModuleCU->getCUDie(), Offset, true);
Devang Patel5a3d37f2009-06-29 20:45:18 +00002295 CompileUnitOffsets[ModuleCU] = 0;
Bill Wendling55fccda2009-05-20 23:21:38 +00002296}
2297
Devang Patelc50078e2009-11-21 02:48:08 +00002298/// emitInitial - Emit initial Dwarf declarations. This is necessary for cc
Bill Wendling55fccda2009-05-20 23:21:38 +00002299/// tools to recognize the object file contains Dwarf information.
Devang Patelc50078e2009-11-21 02:48:08 +00002300void DwarfDebug::emitInitial() {
Bill Wendling55fccda2009-05-20 23:21:38 +00002301 // Check to see if we already emitted intial headers.
2302 if (didInitial) return;
2303 didInitial = true;
2304
Chris Lattner73266f92009-08-19 05:49:37 +00002305 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbar41716322009-09-19 20:40:05 +00002306
Bill Wendling55fccda2009-05-20 23:21:38 +00002307 // Dwarf sections base addresses.
Chris Lattnera5ef4d32009-08-22 21:43:10 +00002308 if (MAI->doesDwarfRequireFrameSection()) {
Chris Lattner73266f92009-08-19 05:49:37 +00002309 Asm->OutStreamer.SwitchSection(TLOF.getDwarfFrameSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002310 EmitLabel("section_debug_frame", 0);
2311 }
2312
Chris Lattner73266f92009-08-19 05:49:37 +00002313 Asm->OutStreamer.SwitchSection(TLOF.getDwarfInfoSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002314 EmitLabel("section_info", 0);
Chris Lattner73266f92009-08-19 05:49:37 +00002315 Asm->OutStreamer.SwitchSection(TLOF.getDwarfAbbrevSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002316 EmitLabel("section_abbrev", 0);
Chris Lattner73266f92009-08-19 05:49:37 +00002317 Asm->OutStreamer.SwitchSection(TLOF.getDwarfARangesSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002318 EmitLabel("section_aranges", 0);
2319
Chris Lattner73266f92009-08-19 05:49:37 +00002320 if (const MCSection *LineInfoDirective = TLOF.getDwarfMacroInfoSection()) {
2321 Asm->OutStreamer.SwitchSection(LineInfoDirective);
Bill Wendling55fccda2009-05-20 23:21:38 +00002322 EmitLabel("section_macinfo", 0);
2323 }
2324
Chris Lattner73266f92009-08-19 05:49:37 +00002325 Asm->OutStreamer.SwitchSection(TLOF.getDwarfLineSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002326 EmitLabel("section_line", 0);
Chris Lattner73266f92009-08-19 05:49:37 +00002327 Asm->OutStreamer.SwitchSection(TLOF.getDwarfLocSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002328 EmitLabel("section_loc", 0);
Chris Lattner73266f92009-08-19 05:49:37 +00002329 Asm->OutStreamer.SwitchSection(TLOF.getDwarfPubNamesSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002330 EmitLabel("section_pubnames", 0);
Devang Patelec13b4f2009-11-24 01:14:22 +00002331 Asm->OutStreamer.SwitchSection(TLOF.getDwarfPubTypesSection());
2332 EmitLabel("section_pubtypes", 0);
Chris Lattner73266f92009-08-19 05:49:37 +00002333 Asm->OutStreamer.SwitchSection(TLOF.getDwarfStrSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002334 EmitLabel("section_str", 0);
Chris Lattner73266f92009-08-19 05:49:37 +00002335 Asm->OutStreamer.SwitchSection(TLOF.getDwarfRangesSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002336 EmitLabel("section_ranges", 0);
2337
Chris Lattner73266f92009-08-19 05:49:37 +00002338 Asm->OutStreamer.SwitchSection(TLOF.getTextSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002339 EmitLabel("text_begin", 0);
Chris Lattner73266f92009-08-19 05:49:37 +00002340 Asm->OutStreamer.SwitchSection(TLOF.getDataSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002341 EmitLabel("data_begin", 0);
2342}
2343
Devang Patelc50078e2009-11-21 02:48:08 +00002344/// emitDIE - Recusively Emits a debug information entry.
Bill Wendling55fccda2009-05-20 23:21:38 +00002345///
Devang Patelc50078e2009-11-21 02:48:08 +00002346void DwarfDebug::emitDIE(DIE *Die) {
Bill Wendling55fccda2009-05-20 23:21:38 +00002347 // Get the abbreviation for this DIE.
2348 unsigned AbbrevNumber = Die->getAbbrevNumber();
2349 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2350
Chris Lattnerad653482010-01-22 22:09:00 +00002351 Asm->O << '\n';
Bill Wendling55fccda2009-05-20 23:21:38 +00002352
2353 // Emit the code (index) for the abbreviation.
2354 Asm->EmitULEB128Bytes(AbbrevNumber);
2355
Benjamin Kramer0ad2db92010-01-17 07:46:39 +00002356 Asm->EOL("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
2357 Twine::utohexstr(Die->getOffset()) + ":0x" +
2358 Twine::utohexstr(Die->getSize()) + " " +
2359 dwarf::TagString(Abbrev->getTag()));
Bill Wendling55fccda2009-05-20 23:21:38 +00002360
2361 SmallVector<DIEValue*, 32> &Values = Die->getValues();
2362 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2363
2364 // Emit the DIE attribute values.
2365 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2366 unsigned Attr = AbbrevData[i].getAttribute();
2367 unsigned Form = AbbrevData[i].getForm();
2368 assert(Form && "Too many attributes for DIE (check abbreviation)");
2369
2370 switch (Attr) {
2371 case dwarf::DW_AT_sibling:
Devang Patelc50078e2009-11-21 02:48:08 +00002372 Asm->EmitInt32(Die->getSiblingOffset());
Bill Wendling55fccda2009-05-20 23:21:38 +00002373 break;
2374 case dwarf::DW_AT_abstract_origin: {
2375 DIEEntry *E = cast<DIEEntry>(Values[i]);
2376 DIE *Origin = E->getEntry();
Devang Patel90a0fe32009-11-10 23:06:00 +00002377 unsigned Addr = Origin->getOffset();
Bill Wendling55fccda2009-05-20 23:21:38 +00002378 Asm->EmitInt32(Addr);
2379 break;
2380 }
2381 default:
2382 // Emit an attribute using the defined form.
2383 Values[i]->EmitValue(this, Form);
2384 break;
2385 }
2386
2387 Asm->EOL(dwarf::AttributeString(Attr));
2388 }
2389
2390 // Emit the DIE children if any.
2391 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2392 const std::vector<DIE *> &Children = Die->getChildren();
2393
2394 for (unsigned j = 0, M = Children.size(); j < M; ++j)
Devang Patelc50078e2009-11-21 02:48:08 +00002395 emitDIE(Children[j]);
Bill Wendling55fccda2009-05-20 23:21:38 +00002396
2397 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2398 }
2399}
2400
Devang Patelfe0be132009-12-09 18:24:21 +00002401/// emitDebugInfo - Emit the debug info section.
Bill Wendling55fccda2009-05-20 23:21:38 +00002402///
Devang Patelfe0be132009-12-09 18:24:21 +00002403void DwarfDebug::emitDebugInfo() {
2404 // Start debug info section.
2405 Asm->OutStreamer.SwitchSection(
2406 Asm->getObjFileLowering().getDwarfInfoSection());
2407 DIE *Die = ModuleCU->getCUDie();
Bill Wendling55fccda2009-05-20 23:21:38 +00002408
2409 // Emit the compile units header.
Devang Patelfe0be132009-12-09 18:24:21 +00002410 EmitLabel("info_begin", ModuleCU->getID());
Bill Wendling55fccda2009-05-20 23:21:38 +00002411
2412 // Emit size of content not including length itself
2413 unsigned ContentSize = Die->getSize() +
2414 sizeof(int16_t) + // DWARF version number
2415 sizeof(int32_t) + // Offset Into Abbrev. Section
2416 sizeof(int8_t) + // Pointer Size (in bytes)
2417 sizeof(int32_t); // FIXME - extra pad for gdb bug.
2418
2419 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2420 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF version number");
2421 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2422 Asm->EOL("Offset Into Abbrev. Section");
2423 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2424
Devang Patelc50078e2009-11-21 02:48:08 +00002425 emitDIE(Die);
Bill Wendling55fccda2009-05-20 23:21:38 +00002426 // FIXME - extra padding for gdb bug.
2427 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2428 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2429 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2430 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
Devang Patelfe0be132009-12-09 18:24:21 +00002431 EmitLabel("info_end", ModuleCU->getID());
Chris Lattnerad653482010-01-22 22:09:00 +00002432 Asm->O << '\n';
Bill Wendling55fccda2009-05-20 23:21:38 +00002433}
2434
Devang Patelc50078e2009-11-21 02:48:08 +00002435/// emitAbbreviations - Emit the abbreviation section.
Bill Wendling55fccda2009-05-20 23:21:38 +00002436///
Devang Patelc50078e2009-11-21 02:48:08 +00002437void DwarfDebug::emitAbbreviations() const {
Bill Wendling55fccda2009-05-20 23:21:38 +00002438 // Check to see if it is worth the effort.
2439 if (!Abbreviations.empty()) {
2440 // Start the debug abbrev section.
Chris Lattner73266f92009-08-19 05:49:37 +00002441 Asm->OutStreamer.SwitchSection(
2442 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002443
2444 EmitLabel("abbrev_begin", 0);
2445
2446 // For each abbrevation.
2447 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2448 // Get abbreviation data
2449 const DIEAbbrev *Abbrev = Abbreviations[i];
2450
2451 // Emit the abbrevations code (base 1 index.)
2452 Asm->EmitULEB128Bytes(Abbrev->getNumber());
2453 Asm->EOL("Abbreviation Code");
2454
2455 // Emit the abbreviations data.
2456 Abbrev->Emit(Asm);
Chris Lattnerad653482010-01-22 22:09:00 +00002457 Asm->O << '\n';
Bill Wendling55fccda2009-05-20 23:21:38 +00002458 }
2459
2460 // Mark end of abbreviations.
2461 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2462
2463 EmitLabel("abbrev_end", 0);
Chris Lattnerad653482010-01-22 22:09:00 +00002464 Asm->O << '\n';
Bill Wendling55fccda2009-05-20 23:21:38 +00002465 }
2466}
2467
Devang Patelc50078e2009-11-21 02:48:08 +00002468/// emitEndOfLineMatrix - Emit the last address of the section and the end of
Bill Wendling55fccda2009-05-20 23:21:38 +00002469/// the line matrix.
2470///
Devang Patelc50078e2009-11-21 02:48:08 +00002471void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
Bill Wendling55fccda2009-05-20 23:21:38 +00002472 // Define last address of section.
2473 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2474 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2475 Asm->EmitInt8(dwarf::DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2476 EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2477
2478 // Mark end of matrix.
2479 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
Chris Lattnerad653482010-01-22 22:09:00 +00002480 Asm->EmitULEB128Bytes(1);
2481 Asm->O << '\n';
2482 Asm->EmitInt8(1);
2483 Asm->O << '\n';
Bill Wendling55fccda2009-05-20 23:21:38 +00002484}
2485
Devang Patelc50078e2009-11-21 02:48:08 +00002486/// emitDebugLines - Emit source line information.
Bill Wendling55fccda2009-05-20 23:21:38 +00002487///
Devang Patelc50078e2009-11-21 02:48:08 +00002488void DwarfDebug::emitDebugLines() {
Bill Wendling55fccda2009-05-20 23:21:38 +00002489 // If the target is using .loc/.file, the assembler will be emitting the
2490 // .debug_line table automatically.
Chris Lattnera5ef4d32009-08-22 21:43:10 +00002491 if (MAI->hasDotLocAndDotFile())
Bill Wendling55fccda2009-05-20 23:21:38 +00002492 return;
2493
2494 // Minimum line delta, thus ranging from -10..(255-10).
2495 const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
2496 // Maximum line delta, thus ranging from -10..(255-10).
2497 const int MaxLineDelta = 255 + MinLineDelta;
2498
2499 // Start the dwarf line section.
Chris Lattner73266f92009-08-19 05:49:37 +00002500 Asm->OutStreamer.SwitchSection(
2501 Asm->getObjFileLowering().getDwarfLineSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002502
2503 // Construct the section header.
2504 EmitDifference("line_end", 0, "line_begin", 0, true);
2505 Asm->EOL("Length of Source Line Info");
2506 EmitLabel("line_begin", 0);
2507
2508 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF version number");
2509
2510 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2511 Asm->EOL("Prolog Length");
2512 EmitLabel("line_prolog_begin", 0);
2513
2514 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2515
2516 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2517
2518 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
2519
2520 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2521
2522 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
2523
2524 // Line number standard opcode encodings argument count
2525 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2526 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2527 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2528 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2529 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2530 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2531 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2532 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2533 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2534
2535 // Emit directories.
2536 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
2537 Asm->EmitString(getSourceDirectoryName(DI));
2538 Asm->EOL("Directory");
2539 }
2540
2541 Asm->EmitInt8(0); Asm->EOL("End of directories");
2542
2543 // Emit files.
2544 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
2545 // Remember source id starts at 1.
2546 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
2547 Asm->EmitString(getSourceFileName(Id.second));
2548 Asm->EOL("Source");
2549 Asm->EmitULEB128Bytes(Id.first);
2550 Asm->EOL("Directory #");
2551 Asm->EmitULEB128Bytes(0);
2552 Asm->EOL("Mod date");
2553 Asm->EmitULEB128Bytes(0);
2554 Asm->EOL("File size");
2555 }
2556
2557 Asm->EmitInt8(0); Asm->EOL("End of files");
2558
2559 EmitLabel("line_prolog_end", 0);
2560
2561 // A sequence for each text section.
2562 unsigned SecSrcLinesSize = SectionSourceLines.size();
2563
2564 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
2565 // Isolate current sections line info.
2566 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
2567
Chris Lattner26aabb92009-08-08 23:39:42 +00002568 /*if (Asm->isVerbose()) {
Chris Lattnere6ad12f2009-07-31 18:48:30 +00002569 const MCSection *S = SectionMap[j + 1];
Chris Lattnera5ef4d32009-08-22 21:43:10 +00002570 O << '\t' << MAI->getCommentString() << " Section"
Bill Wendling55fccda2009-05-20 23:21:38 +00002571 << S->getName() << '\n';
Chris Lattner26aabb92009-08-08 23:39:42 +00002572 }*/
Chris Lattnerad653482010-01-22 22:09:00 +00002573 Asm->O << '\n';
Bill Wendling55fccda2009-05-20 23:21:38 +00002574
2575 // Dwarf assumes we start with first line of first source file.
2576 unsigned Source = 1;
2577 unsigned Line = 1;
2578
2579 // Construct rows of the address, source, line, column matrix.
2580 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2581 const SrcLineInfo &LineInfo = LineInfos[i];
2582 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2583 if (!LabelID) continue;
2584
Caroline Tice9da96d82009-09-11 18:25:54 +00002585 if (LineInfo.getLine() == 0) continue;
2586
Bill Wendling55fccda2009-05-20 23:21:38 +00002587 if (!Asm->isVerbose())
Chris Lattnerad653482010-01-22 22:09:00 +00002588 Asm->O << '\n';
Bill Wendling55fccda2009-05-20 23:21:38 +00002589 else {
2590 std::pair<unsigned, unsigned> SourceID =
2591 getSourceDirectoryAndFileIds(LineInfo.getSourceID());
Chris Lattnera5ef4d32009-08-22 21:43:10 +00002592 O << '\t' << MAI->getCommentString() << ' '
Dan Gohman1792bc62009-12-05 02:00:34 +00002593 << getSourceDirectoryName(SourceID.first) << '/'
Bill Wendling55fccda2009-05-20 23:21:38 +00002594 << getSourceFileName(SourceID.second)
Dan Gohman1792bc62009-12-05 02:00:34 +00002595 << ':' << utostr_32(LineInfo.getLine()) << '\n';
Bill Wendling55fccda2009-05-20 23:21:38 +00002596 }
2597
2598 // Define the line address.
2599 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2600 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2601 Asm->EmitInt8(dwarf::DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2602 EmitReference("label", LabelID); Asm->EOL("Location label");
2603
2604 // If change of source, then switch to the new source.
2605 if (Source != LineInfo.getSourceID()) {
2606 Source = LineInfo.getSourceID();
2607 Asm->EmitInt8(dwarf::DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2608 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2609 }
2610
2611 // If change of line.
2612 if (Line != LineInfo.getLine()) {
2613 // Determine offset.
2614 int Offset = LineInfo.getLine() - Line;
2615 int Delta = Offset - MinLineDelta;
2616
2617 // Update line.
2618 Line = LineInfo.getLine();
2619
2620 // If delta is small enough and in range...
2621 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2622 // ... then use fast opcode.
2623 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2624 } else {
2625 // ... otherwise use long hand.
2626 Asm->EmitInt8(dwarf::DW_LNS_advance_line);
2627 Asm->EOL("DW_LNS_advance_line");
2628 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2629 Asm->EmitInt8(dwarf::DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2630 }
2631 } else {
2632 // Copy the previous row (different address or source)
2633 Asm->EmitInt8(dwarf::DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2634 }
2635 }
2636
Devang Patelc50078e2009-11-21 02:48:08 +00002637 emitEndOfLineMatrix(j + 1);
Bill Wendling55fccda2009-05-20 23:21:38 +00002638 }
2639
2640 if (SecSrcLinesSize == 0)
2641 // Because we're emitting a debug_line section, we still need a line
2642 // table. The linker and friends expect it to exist. If there's nothing to
2643 // put into it, emit an empty table.
Devang Patelc50078e2009-11-21 02:48:08 +00002644 emitEndOfLineMatrix(1);
Bill Wendling55fccda2009-05-20 23:21:38 +00002645
2646 EmitLabel("line_end", 0);
Chris Lattnerad653482010-01-22 22:09:00 +00002647 Asm->O << '\n';
Bill Wendling55fccda2009-05-20 23:21:38 +00002648}
2649
Devang Patelc50078e2009-11-21 02:48:08 +00002650/// emitCommonDebugFrame - Emit common frame info into a debug frame section.
Bill Wendling55fccda2009-05-20 23:21:38 +00002651///
Devang Patelc50078e2009-11-21 02:48:08 +00002652void DwarfDebug::emitCommonDebugFrame() {
Chris Lattnera5ef4d32009-08-22 21:43:10 +00002653 if (!MAI->doesDwarfRequireFrameSection())
Bill Wendling55fccda2009-05-20 23:21:38 +00002654 return;
2655
2656 int stackGrowth =
2657 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2658 TargetFrameInfo::StackGrowsUp ?
2659 TD->getPointerSize() : -TD->getPointerSize();
2660
2661 // Start the dwarf frame section.
Chris Lattner73266f92009-08-19 05:49:37 +00002662 Asm->OutStreamer.SwitchSection(
2663 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002664
2665 EmitLabel("debug_frame_common", 0);
2666 EmitDifference("debug_frame_common_end", 0,
2667 "debug_frame_common_begin", 0, true);
2668 Asm->EOL("Length of Common Information Entry");
2669
2670 EmitLabel("debug_frame_common_begin", 0);
2671 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
2672 Asm->EOL("CIE Identifier Tag");
2673 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
2674 Asm->EOL("CIE Version");
2675 Asm->EmitString("");
2676 Asm->EOL("CIE Augmentation");
2677 Asm->EmitULEB128Bytes(1);
2678 Asm->EOL("CIE Code Alignment Factor");
2679 Asm->EmitSLEB128Bytes(stackGrowth);
2680 Asm->EOL("CIE Data Alignment Factor");
2681 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
2682 Asm->EOL("CIE RA Column");
2683
2684 std::vector<MachineMove> Moves;
2685 RI->getInitialFrameState(Moves);
2686
2687 EmitFrameMoves(NULL, 0, Moves, false);
2688
2689 Asm->EmitAlignment(2, 0, 0, false);
2690 EmitLabel("debug_frame_common_end", 0);
Chris Lattnerad653482010-01-22 22:09:00 +00002691 Asm->O << '\n';
Bill Wendling55fccda2009-05-20 23:21:38 +00002692}
2693
Devang Patelc50078e2009-11-21 02:48:08 +00002694/// emitFunctionDebugFrame - Emit per function frame info into a debug frame
Bill Wendling55fccda2009-05-20 23:21:38 +00002695/// section.
2696void
Devang Patelc50078e2009-11-21 02:48:08 +00002697DwarfDebug::emitFunctionDebugFrame(const FunctionDebugFrameInfo&DebugFrameInfo){
Chris Lattnera5ef4d32009-08-22 21:43:10 +00002698 if (!MAI->doesDwarfRequireFrameSection())
Bill Wendling55fccda2009-05-20 23:21:38 +00002699 return;
2700
2701 // Start the dwarf frame section.
Chris Lattner73266f92009-08-19 05:49:37 +00002702 Asm->OutStreamer.SwitchSection(
2703 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002704
2705 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2706 "debug_frame_begin", DebugFrameInfo.Number, true);
2707 Asm->EOL("Length of Frame Information Entry");
2708
2709 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2710
2711 EmitSectionOffset("debug_frame_common", "section_debug_frame",
2712 0, 0, true, false);
2713 Asm->EOL("FDE CIE offset");
2714
2715 EmitReference("func_begin", DebugFrameInfo.Number);
2716 Asm->EOL("FDE initial location");
2717 EmitDifference("func_end", DebugFrameInfo.Number,
2718 "func_begin", DebugFrameInfo.Number);
2719 Asm->EOL("FDE address range");
2720
2721 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves,
2722 false);
2723
2724 Asm->EmitAlignment(2, 0, 0, false);
2725 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
Chris Lattnerad653482010-01-22 22:09:00 +00002726 Asm->O << '\n';
Bill Wendling55fccda2009-05-20 23:21:38 +00002727}
2728
Devang Patelfe0be132009-12-09 18:24:21 +00002729/// emitDebugPubNames - Emit visible names into a debug pubnames section.
2730///
2731void DwarfDebug::emitDebugPubNames() {
2732 // Start the dwarf pubnames section.
2733 Asm->OutStreamer.SwitchSection(
2734 Asm->getObjFileLowering().getDwarfPubNamesSection());
2735
2736 EmitDifference("pubnames_end", ModuleCU->getID(),
2737 "pubnames_begin", ModuleCU->getID(), true);
Bill Wendling55fccda2009-05-20 23:21:38 +00002738 Asm->EOL("Length of Public Names Info");
2739
Devang Patelfe0be132009-12-09 18:24:21 +00002740 EmitLabel("pubnames_begin", ModuleCU->getID());
Bill Wendling55fccda2009-05-20 23:21:38 +00002741
2742 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF Version");
2743
2744 EmitSectionOffset("info_begin", "section_info",
Devang Patelfe0be132009-12-09 18:24:21 +00002745 ModuleCU->getID(), 0, true, false);
Bill Wendling55fccda2009-05-20 23:21:38 +00002746 Asm->EOL("Offset of Compilation Unit Info");
2747
Devang Patelfe0be132009-12-09 18:24:21 +00002748 EmitDifference("info_end", ModuleCU->getID(), "info_begin", ModuleCU->getID(),
Bill Wendling55fccda2009-05-20 23:21:38 +00002749 true);
2750 Asm->EOL("Compilation Unit Length");
2751
Devang Patelfe0be132009-12-09 18:24:21 +00002752 const StringMap<DIE*> &Globals = ModuleCU->getGlobals();
Bill Wendling55fccda2009-05-20 23:21:38 +00002753 for (StringMap<DIE*>::const_iterator
2754 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2755 const char *Name = GI->getKeyData();
2756 DIE * Entity = GI->second;
2757
2758 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2759 Asm->EmitString(Name, strlen(Name)); Asm->EOL("External Name");
2760 }
2761
2762 Asm->EmitInt32(0); Asm->EOL("End Mark");
Devang Patelfe0be132009-12-09 18:24:21 +00002763 EmitLabel("pubnames_end", ModuleCU->getID());
Chris Lattnerad653482010-01-22 22:09:00 +00002764 Asm->O << '\n';
Bill Wendling55fccda2009-05-20 23:21:38 +00002765}
2766
Devang Patelec13b4f2009-11-24 01:14:22 +00002767void DwarfDebug::emitDebugPubTypes() {
Devang Patel6f2bdd52009-11-24 19:18:41 +00002768 // Start the dwarf pubnames section.
2769 Asm->OutStreamer.SwitchSection(
2770 Asm->getObjFileLowering().getDwarfPubTypesSection());
Devang Patelec13b4f2009-11-24 01:14:22 +00002771 EmitDifference("pubtypes_end", ModuleCU->getID(),
2772 "pubtypes_begin", ModuleCU->getID(), true);
2773 Asm->EOL("Length of Public Types Info");
2774
2775 EmitLabel("pubtypes_begin", ModuleCU->getID());
2776
2777 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF Version");
2778
2779 EmitSectionOffset("info_begin", "section_info",
2780 ModuleCU->getID(), 0, true, false);
2781 Asm->EOL("Offset of Compilation ModuleCU Info");
2782
2783 EmitDifference("info_end", ModuleCU->getID(), "info_begin", ModuleCU->getID(),
2784 true);
2785 Asm->EOL("Compilation ModuleCU Length");
2786
2787 const StringMap<DIE*> &Globals = ModuleCU->getGlobalTypes();
2788 for (StringMap<DIE*>::const_iterator
2789 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2790 const char *Name = GI->getKeyData();
2791 DIE * Entity = GI->second;
2792
2793 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2794 Asm->EmitString(Name, strlen(Name)); Asm->EOL("External Name");
2795 }
2796
2797 Asm->EmitInt32(0); Asm->EOL("End Mark");
2798 EmitLabel("pubtypes_end", ModuleCU->getID());
Chris Lattnerad653482010-01-22 22:09:00 +00002799 Asm->O << '\n';
Devang Patelec13b4f2009-11-24 01:14:22 +00002800}
2801
Devang Patelc50078e2009-11-21 02:48:08 +00002802/// emitDebugStr - Emit visible names into a debug str section.
Bill Wendling55fccda2009-05-20 23:21:38 +00002803///
Devang Patelc50078e2009-11-21 02:48:08 +00002804void DwarfDebug::emitDebugStr() {
Bill Wendling55fccda2009-05-20 23:21:38 +00002805 // Check to see if it is worth the effort.
2806 if (!StringPool.empty()) {
2807 // Start the dwarf str section.
Chris Lattner73266f92009-08-19 05:49:37 +00002808 Asm->OutStreamer.SwitchSection(
2809 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002810
2811 // For each of strings in the string pool.
2812 for (unsigned StringID = 1, N = StringPool.size();
2813 StringID <= N; ++StringID) {
2814 // Emit a label for reference from debug information entries.
2815 EmitLabel("string", StringID);
2816
2817 // Emit the string itself.
2818 const std::string &String = StringPool[StringID];
Chris Lattnerad653482010-01-22 22:09:00 +00002819 Asm->EmitString(String);
2820 Asm->O << '\n';
Bill Wendling55fccda2009-05-20 23:21:38 +00002821 }
2822
Chris Lattnerad653482010-01-22 22:09:00 +00002823 Asm->O << '\n';
Bill Wendling55fccda2009-05-20 23:21:38 +00002824 }
2825}
2826
Devang Patelc50078e2009-11-21 02:48:08 +00002827/// emitDebugLoc - Emit visible names into a debug loc section.
Bill Wendling55fccda2009-05-20 23:21:38 +00002828///
Devang Patelc50078e2009-11-21 02:48:08 +00002829void DwarfDebug::emitDebugLoc() {
Bill Wendling55fccda2009-05-20 23:21:38 +00002830 // Start the dwarf loc section.
Chris Lattner73266f92009-08-19 05:49:37 +00002831 Asm->OutStreamer.SwitchSection(
2832 Asm->getObjFileLowering().getDwarfLocSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002833}
2834
2835/// EmitDebugARanges - Emit visible names into a debug aranges section.
2836///
2837void DwarfDebug::EmitDebugARanges() {
2838 // Start the dwarf aranges section.
Chris Lattner73266f92009-08-19 05:49:37 +00002839 Asm->OutStreamer.SwitchSection(
2840 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002841
2842 // FIXME - Mock up
2843#if 0
2844 CompileUnit *Unit = GetBaseCompileUnit();
2845
2846 // Don't include size of length
2847 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
2848
2849 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("Dwarf Version");
2850
2851 EmitReference("info_begin", Unit->getID());
2852 Asm->EOL("Offset of Compilation Unit Info");
2853
2854 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
2855
2856 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2857
2858 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
2859 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
2860
2861 // Range 1
2862 EmitReference("text_begin", 0); Asm->EOL("Address");
2863 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2864
2865 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2866 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
2867#endif
Bill Wendling55fccda2009-05-20 23:21:38 +00002868}
2869
Devang Patelc50078e2009-11-21 02:48:08 +00002870/// emitDebugRanges - Emit visible names into a debug ranges section.
Bill Wendling55fccda2009-05-20 23:21:38 +00002871///
Devang Patelc50078e2009-11-21 02:48:08 +00002872void DwarfDebug::emitDebugRanges() {
Bill Wendling55fccda2009-05-20 23:21:38 +00002873 // Start the dwarf ranges section.
Chris Lattner73266f92009-08-19 05:49:37 +00002874 Asm->OutStreamer.SwitchSection(
2875 Asm->getObjFileLowering().getDwarfRangesSection());
Bill Wendling55fccda2009-05-20 23:21:38 +00002876}
2877
Devang Patelc50078e2009-11-21 02:48:08 +00002878/// emitDebugMacInfo - Emit visible names into a debug macinfo section.
Bill Wendling55fccda2009-05-20 23:21:38 +00002879///
Devang Patelc50078e2009-11-21 02:48:08 +00002880void DwarfDebug::emitDebugMacInfo() {
Daniel Dunbar41716322009-09-19 20:40:05 +00002881 if (const MCSection *LineInfo =
Chris Lattner72d228d2009-08-02 07:24:22 +00002882 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling55fccda2009-05-20 23:21:38 +00002883 // Start the dwarf macinfo section.
Chris Lattner73266f92009-08-19 05:49:37 +00002884 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling55fccda2009-05-20 23:21:38 +00002885 }
2886}
2887
Devang Patelc50078e2009-11-21 02:48:08 +00002888/// emitDebugInlineInfo - Emit inline info using following format.
Bill Wendling55fccda2009-05-20 23:21:38 +00002889/// Section Header:
2890/// 1. length of section
2891/// 2. Dwarf version number
2892/// 3. address size.
2893///
2894/// Entries (one "entry" for each function that was inlined):
2895///
2896/// 1. offset into __debug_str section for MIPS linkage name, if exists;
2897/// otherwise offset into __debug_str for regular function name.
2898/// 2. offset into __debug_str section for regular function name.
2899/// 3. an unsigned LEB128 number indicating the number of distinct inlining
2900/// instances for the function.
2901///
2902/// The rest of the entry consists of a {die_offset, low_pc} pair for each
2903/// inlined instance; the die_offset points to the inlined_subroutine die in the
2904/// __debug_info section, and the low_pc is the starting address for the
2905/// inlining instance.
Devang Patelc50078e2009-11-21 02:48:08 +00002906void DwarfDebug::emitDebugInlineInfo() {
Chris Lattnera5ef4d32009-08-22 21:43:10 +00002907 if (!MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling55fccda2009-05-20 23:21:38 +00002908 return;
2909
Devang Patel5a3d37f2009-06-29 20:45:18 +00002910 if (!ModuleCU)
Bill Wendling55fccda2009-05-20 23:21:38 +00002911 return;
2912
Chris Lattner73266f92009-08-19 05:49:37 +00002913 Asm->OutStreamer.SwitchSection(
2914 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Chris Lattnerad653482010-01-22 22:09:00 +00002915
Bill Wendling55fccda2009-05-20 23:21:38 +00002916 EmitDifference("debug_inlined_end", 1,
2917 "debug_inlined_begin", 1, true);
2918 Asm->EOL("Length of Debug Inlined Information Entry");
2919
2920 EmitLabel("debug_inlined_begin", 1);
2921
2922 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("Dwarf Version");
2923 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2924
Devang Patel90a0fe32009-11-10 23:06:00 +00002925 for (SmallVector<MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
2926 E = InlinedSPNodes.end(); I != E; ++I) {
Jim Grosbach652b7432009-11-21 23:12:12 +00002927
Devang Patel90a0fe32009-11-10 23:06:00 +00002928 MDNode *Node = *I;
Devang Patel7d707f92010-01-19 06:19:05 +00002929 DenseMap<MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
Jim Grosbachb23f2422009-11-22 19:20:36 +00002930 = InlineInfo.find(Node);
Devang Patel90a0fe32009-11-10 23:06:00 +00002931 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patel15e723d2009-08-28 23:24:31 +00002932 DISubprogram SP(Node);
Devang Patel7f75bbe2009-11-25 17:36:49 +00002933 StringRef LName = SP.getLinkageName();
2934 StringRef Name = SP.getName();
Bill Wendling55fccda2009-05-20 23:21:38 +00002935
Devang Patel7f75bbe2009-11-25 17:36:49 +00002936 if (LName.empty())
Devang Patel76031e82009-07-16 01:01:22 +00002937 Asm->EmitString(Name);
Devang Patel141e1c42010-01-05 01:46:14 +00002938 else
Devang Patel90a0fe32009-11-10 23:06:00 +00002939 EmitSectionOffset("string", "section_str",
Devang Patel141e1c42010-01-05 01:46:14 +00002940 StringPool.idFor(getRealLinkageName(LName)), false, true);
Devang Patel90a0fe32009-11-10 23:06:00 +00002941
Bill Wendling55fccda2009-05-20 23:21:38 +00002942 Asm->EOL("MIPS linkage name");
Devang Patel90a0fe32009-11-10 23:06:00 +00002943 EmitSectionOffset("string", "section_str",
2944 StringPool.idFor(Name), false, true);
2945 Asm->EOL("Function name");
Bill Wendling55fccda2009-05-20 23:21:38 +00002946 Asm->EmitULEB128Bytes(Labels.size()); Asm->EOL("Inline count");
2947
Devang Patel90a0fe32009-11-10 23:06:00 +00002948 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling55fccda2009-05-20 23:21:38 +00002949 LE = Labels.end(); LI != LE; ++LI) {
Devang Patel90a0fe32009-11-10 23:06:00 +00002950 DIE *SP = LI->second;
Bill Wendling55fccda2009-05-20 23:21:38 +00002951 Asm->EmitInt32(SP->getOffset()); Asm->EOL("DIE offset");
2952
2953 if (TD->getPointerSize() == sizeof(int32_t))
Chris Lattnera5ef4d32009-08-22 21:43:10 +00002954 O << MAI->getData32bitsDirective();
Bill Wendling55fccda2009-05-20 23:21:38 +00002955 else
Chris Lattnera5ef4d32009-08-22 21:43:10 +00002956 O << MAI->getData64bitsDirective();
Bill Wendling55fccda2009-05-20 23:21:38 +00002957
Devang Patel90a0fe32009-11-10 23:06:00 +00002958 PrintLabelName("label", LI->first); Asm->EOL("low_pc");
Bill Wendling55fccda2009-05-20 23:21:38 +00002959 }
2960 }
2961
2962 EmitLabel("debug_inlined_end", 1);
Chris Lattnerad653482010-01-22 22:09:00 +00002963 Asm->O << '\n';
Bill Wendling55fccda2009-05-20 23:21:38 +00002964}