blob: 3f26360f0b5f5d5070caded6afdca67debbee73b [file] [log] [blame]
Bill Wendling0310d762009-05-15 09:23:25 +00001//===-- llvm/CodeGen/DwarfDebug.cpp - Dwarf Debug Framework ---------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains support for writing dwarf debug info into asm files.
11//
12//===----------------------------------------------------------------------===//
Devang Patele4b27562009-08-28 23:24:31 +000013#define DEBUG_TYPE "dwarfdebug"
Bill Wendling0310d762009-05-15 09:23:25 +000014#include "DwarfDebug.h"
15#include "llvm/Module.h"
David Greeneb2c66fc2009-08-19 21:52:55 +000016#include "llvm/CodeGen/MachineFunction.h"
Bill Wendling0310d762009-05-15 09:23:25 +000017#include "llvm/CodeGen/MachineModuleInfo.h"
Chris Lattnera87dea42009-07-31 18:48:30 +000018#include "llvm/MC/MCSection.h"
Chris Lattner6c2f9e12009-08-19 05:49:37 +000019#include "llvm/MC/MCStreamer.h"
Chris Lattneraf76e592009-08-22 20:48:53 +000020#include "llvm/MC/MCAsmInfo.h"
Bill Wendling0310d762009-05-15 09:23:25 +000021#include "llvm/Target/TargetData.h"
22#include "llvm/Target/TargetFrameInfo.h"
Chris Lattnerf0144122009-07-28 03:13:23 +000023#include "llvm/Target/TargetLoweringObjectFile.h"
24#include "llvm/Target/TargetRegisterInfo.h"
Chris Lattner23132b12009-08-24 03:52:50 +000025#include "llvm/ADT/StringExtras.h"
Daniel Dunbar6e4bdfc2009-10-13 06:47:08 +000026#include "llvm/Support/Debug.h"
27#include "llvm/Support/ErrorHandling.h"
Chris Lattner334fd1f2009-09-16 00:08:41 +000028#include "llvm/Support/Mangler.h"
Chris Lattnera87dea42009-07-31 18:48:30 +000029#include "llvm/Support/Timer.h"
30#include "llvm/System/Path.h"
Bill Wendling0310d762009-05-15 09:23:25 +000031using namespace llvm;
32
33static TimerGroup &getDwarfTimerGroup() {
34 static TimerGroup DwarfTimerGroup("Dwarf Debugging");
35 return DwarfTimerGroup;
36}
37
38//===----------------------------------------------------------------------===//
39
40/// Configuration values for initial hash set sizes (log2).
41///
42static const unsigned InitDiesSetSize = 9; // log2(512)
43static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
44static const unsigned InitValuesSetSize = 9; // log2(512)
45
46namespace llvm {
47
48//===----------------------------------------------------------------------===//
49/// CompileUnit - This dwarf writer support class manages information associate
50/// with a source file.
51class VISIBILITY_HIDDEN CompileUnit {
52 /// ID - File identifier for source.
53 ///
54 unsigned ID;
55
56 /// Die - Compile unit debug information entry.
57 ///
58 DIE *Die;
59
60 /// GVToDieMap - Tracks the mapping of unit level debug informaton
61 /// variables to debug information entries.
Devang Patele4b27562009-08-28 23:24:31 +000062 /// FIXME : Rename GVToDieMap -> NodeToDieMap
63 std::map<MDNode *, DIE *> GVToDieMap;
Bill Wendling0310d762009-05-15 09:23:25 +000064
65 /// GVToDIEEntryMap - Tracks the mapping of unit level debug informaton
66 /// descriptors to debug information entries using a DIEEntry proxy.
Devang Patele4b27562009-08-28 23:24:31 +000067 /// FIXME : Rename
68 std::map<MDNode *, DIEEntry *> GVToDIEEntryMap;
Bill Wendling0310d762009-05-15 09:23:25 +000069
70 /// Globals - A map of globally visible named entities for this unit.
71 ///
72 StringMap<DIE*> Globals;
73
74 /// DiesSet - Used to uniquely define dies within the compile unit.
75 ///
76 FoldingSet<DIE> DiesSet;
77public:
78 CompileUnit(unsigned I, DIE *D)
Bill Wendling39dd6962009-05-20 23:31:45 +000079 : ID(I), Die(D), DiesSet(InitDiesSetSize) {}
80 ~CompileUnit() { delete Die; }
Bill Wendling0310d762009-05-15 09:23:25 +000081
82 // Accessors.
Bill Wendling39dd6962009-05-20 23:31:45 +000083 unsigned getID() const { return ID; }
84 DIE* getDie() const { return Die; }
Bill Wendling0310d762009-05-15 09:23:25 +000085 StringMap<DIE*> &getGlobals() { return Globals; }
86
87 /// hasContent - Return true if this compile unit has something to write out.
88 ///
Bill Wendling39dd6962009-05-20 23:31:45 +000089 bool hasContent() const { return !Die->getChildren().empty(); }
Bill Wendling0310d762009-05-15 09:23:25 +000090
91 /// AddGlobal - Add a new global entity to the compile unit.
92 ///
Bill Wendling39dd6962009-05-20 23:31:45 +000093 void AddGlobal(const std::string &Name, DIE *Die) { Globals[Name] = Die; }
Bill Wendling0310d762009-05-15 09:23:25 +000094
95 /// getDieMapSlotFor - Returns the debug information entry map slot for the
96 /// specified debug variable.
Devang Patele4b27562009-08-28 23:24:31 +000097 DIE *&getDieMapSlotFor(MDNode *N) { return GVToDieMap[N]; }
Bill Wendling0310d762009-05-15 09:23:25 +000098
Chris Lattner1cda87c2009-07-14 04:50:12 +000099 /// getDIEEntrySlotFor - Returns the debug information entry proxy slot for
100 /// the specified debug variable.
Devang Patele4b27562009-08-28 23:24:31 +0000101 DIEEntry *&getDIEEntrySlotFor(MDNode *N) {
102 return GVToDIEEntryMap[N];
Bill Wendling0310d762009-05-15 09:23:25 +0000103 }
104
105 /// AddDie - Adds or interns the DIE to the compile unit.
106 ///
107 DIE *AddDie(DIE &Buffer) {
108 FoldingSetNodeID ID;
109 Buffer.Profile(ID);
110 void *Where;
111 DIE *Die = DiesSet.FindNodeOrInsertPos(ID, Where);
112
113 if (!Die) {
114 Die = new DIE(Buffer);
115 DiesSet.InsertNode(Die, Where);
116 this->Die->AddChild(Die);
117 Buffer.Detach();
118 }
119
120 return Die;
121 }
122};
123
124//===----------------------------------------------------------------------===//
125/// DbgVariable - This class is used to track local variable information.
126///
Jeffrey Yasskin36d52bf2009-11-03 06:29:36 +0000127class DbgVariable {
Bill Wendling0310d762009-05-15 09:23:25 +0000128 DIVariable Var; // Variable Descriptor.
129 unsigned FrameIndex; // Variable frame index.
Devang Patel53bb5c92009-11-10 23:06:00 +0000130 DbgVariable *AbstractVar; // Abstract variable for this variable.
131 DIE *TheDIE;
Bill Wendling0310d762009-05-15 09:23:25 +0000132public:
Devang Patel53bb5c92009-11-10 23:06:00 +0000133 DbgVariable(DIVariable V, unsigned I)
134 : Var(V), FrameIndex(I), AbstractVar(0), TheDIE(0) {}
Bill Wendling0310d762009-05-15 09:23:25 +0000135
136 // Accessors.
Devang Patel53bb5c92009-11-10 23:06:00 +0000137 DIVariable getVariable() const { return Var; }
138 unsigned getFrameIndex() const { return FrameIndex; }
139 void setAbstractVariable(DbgVariable *V) { AbstractVar = V; }
140 DbgVariable *getAbstractVariable() const { return AbstractVar; }
141 void setDIE(DIE *D) { TheDIE = D; }
142 DIE *getDIE() const { return TheDIE; }
Bill Wendling0310d762009-05-15 09:23:25 +0000143};
144
145//===----------------------------------------------------------------------===//
146/// DbgScope - This class is used to track scope information.
147///
148class DbgConcreteScope;
Jeffrey Yasskin36d52bf2009-11-03 06:29:36 +0000149class DbgScope {
Bill Wendling0310d762009-05-15 09:23:25 +0000150 DbgScope *Parent; // Parent to this scope.
Devang Patel53bb5c92009-11-10 23:06:00 +0000151 DIDescriptor Desc; // Debug info descriptor for scope.
152 WeakVH InlinedAtLocation; // Location at which scope is inlined.
153 bool AbstractScope; // Abstract Scope
Bill Wendling0310d762009-05-15 09:23:25 +0000154 unsigned StartLabelID; // Label ID of the beginning of scope.
155 unsigned EndLabelID; // Label ID of the end of scope.
Devang Pateld38dd112009-10-01 18:25:23 +0000156 const MachineInstr *LastInsn; // Last instruction of this scope.
157 const MachineInstr *FirstInsn; // First instruction of this scope.
Bill Wendling0310d762009-05-15 09:23:25 +0000158 SmallVector<DbgScope *, 4> Scopes; // Scopes defined in scope.
159 SmallVector<DbgVariable *, 8> Variables;// Variables declared in scope.
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000160
Owen Anderson04c05f72009-06-24 22:53:20 +0000161 // Private state for dump()
162 mutable unsigned IndentLevel;
Bill Wendling0310d762009-05-15 09:23:25 +0000163public:
Devang Patelc90aefe2009-10-14 21:08:09 +0000164 DbgScope(DbgScope *P, DIDescriptor D, MDNode *I = 0)
Devang Patel53bb5c92009-11-10 23:06:00 +0000165 : Parent(P), Desc(D), InlinedAtLocation(I), AbstractScope(false),
166 StartLabelID(0), EndLabelID(0),
Devang Patelc90aefe2009-10-14 21:08:09 +0000167 LastInsn(0), FirstInsn(0), IndentLevel(0) {}
Bill Wendling0310d762009-05-15 09:23:25 +0000168 virtual ~DbgScope();
169
170 // Accessors.
171 DbgScope *getParent() const { return Parent; }
Devang Patel53bb5c92009-11-10 23:06:00 +0000172 void setParent(DbgScope *P) { Parent = P; }
Bill Wendling0310d762009-05-15 09:23:25 +0000173 DIDescriptor getDesc() const { return Desc; }
Devang Patel53bb5c92009-11-10 23:06:00 +0000174 MDNode *getInlinedAt() const {
175 return dyn_cast_or_null<MDNode>(InlinedAtLocation);
Devang Patelc90aefe2009-10-14 21:08:09 +0000176 }
Devang Patel53bb5c92009-11-10 23:06:00 +0000177 MDNode *getScopeNode() const { return Desc.getNode(); }
Bill Wendling0310d762009-05-15 09:23:25 +0000178 unsigned getStartLabelID() const { return StartLabelID; }
179 unsigned getEndLabelID() const { return EndLabelID; }
180 SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
181 SmallVector<DbgVariable *, 8> &getVariables() { return Variables; }
Bill Wendling0310d762009-05-15 09:23:25 +0000182 void setStartLabelID(unsigned S) { StartLabelID = S; }
183 void setEndLabelID(unsigned E) { EndLabelID = E; }
Devang Pateld38dd112009-10-01 18:25:23 +0000184 void setLastInsn(const MachineInstr *MI) { LastInsn = MI; }
185 const MachineInstr *getLastInsn() { return LastInsn; }
186 void setFirstInsn(const MachineInstr *MI) { FirstInsn = MI; }
Devang Patel53bb5c92009-11-10 23:06:00 +0000187 void setAbstractScope() { AbstractScope = true; }
188 bool isAbstractScope() const { return AbstractScope; }
Devang Pateld38dd112009-10-01 18:25:23 +0000189 const MachineInstr *getFirstInsn() { return FirstInsn; }
Devang Patel53bb5c92009-11-10 23:06:00 +0000190
Bill Wendling0310d762009-05-15 09:23:25 +0000191 /// AddScope - Add a scope to the scope.
192 ///
193 void AddScope(DbgScope *S) { Scopes.push_back(S); }
194
195 /// AddVariable - Add a variable to the scope.
196 ///
197 void AddVariable(DbgVariable *V) { Variables.push_back(V); }
198
Devang Patelaf9e8472009-10-01 20:31:14 +0000199 void FixInstructionMarkers() {
200 assert (getFirstInsn() && "First instruction is missing!");
201 if (getLastInsn())
202 return;
203
204 // If a scope does not have an instruction to mark an end then use
205 // the end of last child scope.
206 SmallVector<DbgScope *, 4> &Scopes = getScopes();
207 assert (!Scopes.empty() && "Inner most scope does not have last insn!");
208 DbgScope *L = Scopes.back();
209 if (!L->getLastInsn())
210 L->FixInstructionMarkers();
211 setLastInsn(L->getLastInsn());
212 }
213
Bill Wendling0310d762009-05-15 09:23:25 +0000214#ifndef NDEBUG
215 void dump() const;
216#endif
217};
218
219#ifndef NDEBUG
220void DbgScope::dump() const {
Chris Lattnerc281de12009-08-23 00:51:00 +0000221 raw_ostream &err = errs();
222 err.indent(IndentLevel);
Devang Patel53bb5c92009-11-10 23:06:00 +0000223 MDNode *N = Desc.getNode();
224 N->dump();
Chris Lattnerc281de12009-08-23 00:51:00 +0000225 err << " [" << StartLabelID << ", " << EndLabelID << "]\n";
Devang Patel53bb5c92009-11-10 23:06:00 +0000226 if (AbstractScope)
227 err << "Abstract Scope\n";
Bill Wendling0310d762009-05-15 09:23:25 +0000228
229 IndentLevel += 2;
Devang Patel53bb5c92009-11-10 23:06:00 +0000230 if (!Scopes.empty())
231 err << "Children ...\n";
Bill Wendling0310d762009-05-15 09:23:25 +0000232 for (unsigned i = 0, e = Scopes.size(); i != e; ++i)
233 if (Scopes[i] != this)
234 Scopes[i]->dump();
235
236 IndentLevel -= 2;
237}
238#endif
239
240//===----------------------------------------------------------------------===//
241/// DbgConcreteScope - This class is used to track a scope that holds concrete
242/// instance information.
243///
244class VISIBILITY_HIDDEN DbgConcreteScope : public DbgScope {
245 CompileUnit *Unit;
246 DIE *Die; // Debug info for this concrete scope.
247public:
248 DbgConcreteScope(DIDescriptor D) : DbgScope(NULL, D) {}
249
250 // Accessors.
251 DIE *getDie() const { return Die; }
252 void setDie(DIE *D) { Die = D; }
253};
254
255DbgScope::~DbgScope() {
256 for (unsigned i = 0, N = Scopes.size(); i < N; ++i)
257 delete Scopes[i];
258 for (unsigned j = 0, M = Variables.size(); j < M; ++j)
259 delete Variables[j];
Bill Wendling0310d762009-05-15 09:23:25 +0000260}
261
262} // end llvm namespace
263
Chris Lattneraf76e592009-08-22 20:48:53 +0000264DwarfDebug::DwarfDebug(raw_ostream &OS, AsmPrinter *A, const MCAsmInfo *T)
Devang Patel1dbc7712009-06-29 20:45:18 +0000265 : Dwarf(OS, A, T, "dbg"), ModuleCU(0),
Bill Wendling0310d762009-05-15 09:23:25 +0000266 AbbreviationsSet(InitAbbreviationsSetSize), Abbreviations(),
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000267 ValuesSet(InitValuesSetSize), Values(), StringPool(),
Bill Wendling0310d762009-05-15 09:23:25 +0000268 SectionSourceLines(), didInitial(false), shouldEmit(false),
Devang Patel53bb5c92009-11-10 23:06:00 +0000269 CurrentFnDbgScope(0), DebugTimer(0) {
Bill Wendling0310d762009-05-15 09:23:25 +0000270 if (TimePassesIsEnabled)
271 DebugTimer = new Timer("Dwarf Debug Writer",
272 getDwarfTimerGroup());
273}
274DwarfDebug::~DwarfDebug() {
275 for (unsigned j = 0, M = Values.size(); j < M; ++j)
276 delete Values[j];
277
Bill Wendling0310d762009-05-15 09:23:25 +0000278 delete DebugTimer;
279}
280
281/// AssignAbbrevNumber - Define a unique number for the abbreviation.
282///
283void DwarfDebug::AssignAbbrevNumber(DIEAbbrev &Abbrev) {
284 // Profile the node so that we can make it unique.
285 FoldingSetNodeID ID;
286 Abbrev.Profile(ID);
287
288 // Check the set for priors.
289 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
290
291 // If it's newly added.
292 if (InSet == &Abbrev) {
293 // Add to abbreviation list.
294 Abbreviations.push_back(&Abbrev);
295
296 // Assign the vector position + 1 as its number.
297 Abbrev.setNumber(Abbreviations.size());
298 } else {
299 // Assign existing abbreviation number.
300 Abbrev.setNumber(InSet->getNumber());
301 }
302}
303
Bill Wendling995f80a2009-05-20 23:24:48 +0000304/// CreateDIEEntry - Creates a new DIEEntry to be a proxy for a debug
305/// information entry.
306DIEEntry *DwarfDebug::CreateDIEEntry(DIE *Entry) {
Bill Wendling0310d762009-05-15 09:23:25 +0000307 DIEEntry *Value;
308
309 if (Entry) {
310 FoldingSetNodeID ID;
311 DIEEntry::Profile(ID, Entry);
312 void *Where;
313 Value = static_cast<DIEEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where));
314
315 if (Value) return Value;
316
317 Value = new DIEEntry(Entry);
318 ValuesSet.InsertNode(Value, Where);
319 } else {
320 Value = new DIEEntry(Entry);
321 }
322
323 Values.push_back(Value);
324 return Value;
325}
326
327/// SetDIEEntry - Set a DIEEntry once the debug information entry is defined.
328///
329void DwarfDebug::SetDIEEntry(DIEEntry *Value, DIE *Entry) {
330 Value->setEntry(Entry);
331
332 // Add to values set if not already there. If it is, we merely have a
333 // duplicate in the values list (no harm.)
334 ValuesSet.GetOrInsertNode(Value);
335}
336
337/// AddUInt - Add an unsigned integer attribute data and value.
338///
339void DwarfDebug::AddUInt(DIE *Die, unsigned Attribute,
340 unsigned Form, uint64_t Integer) {
341 if (!Form) Form = DIEInteger::BestForm(false, Integer);
342
343 FoldingSetNodeID ID;
344 DIEInteger::Profile(ID, Integer);
345 void *Where;
346 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
347
348 if (!Value) {
349 Value = new DIEInteger(Integer);
350 ValuesSet.InsertNode(Value, Where);
351 Values.push_back(Value);
352 }
353
354 Die->AddValue(Attribute, Form, Value);
355}
356
357/// AddSInt - Add an signed integer attribute data and value.
358///
359void DwarfDebug::AddSInt(DIE *Die, unsigned Attribute,
360 unsigned Form, int64_t Integer) {
361 if (!Form) Form = DIEInteger::BestForm(true, Integer);
362
363 FoldingSetNodeID ID;
364 DIEInteger::Profile(ID, (uint64_t)Integer);
365 void *Where;
366 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
367
368 if (!Value) {
369 Value = new DIEInteger(Integer);
370 ValuesSet.InsertNode(Value, Where);
371 Values.push_back(Value);
372 }
373
374 Die->AddValue(Attribute, Form, Value);
375}
376
377/// AddString - Add a string attribute data and value.
378///
379void DwarfDebug::AddString(DIE *Die, unsigned Attribute, unsigned Form,
380 const std::string &String) {
381 FoldingSetNodeID ID;
382 DIEString::Profile(ID, String);
383 void *Where;
384 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
385
386 if (!Value) {
387 Value = new DIEString(String);
388 ValuesSet.InsertNode(Value, Where);
389 Values.push_back(Value);
390 }
391
392 Die->AddValue(Attribute, Form, Value);
393}
394
395/// AddLabel - Add a Dwarf label attribute data and value.
396///
397void DwarfDebug::AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
398 const DWLabel &Label) {
399 FoldingSetNodeID ID;
400 DIEDwarfLabel::Profile(ID, Label);
401 void *Where;
402 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
403
404 if (!Value) {
405 Value = new DIEDwarfLabel(Label);
406 ValuesSet.InsertNode(Value, Where);
407 Values.push_back(Value);
408 }
409
410 Die->AddValue(Attribute, Form, Value);
411}
412
413/// AddObjectLabel - Add an non-Dwarf label attribute data and value.
414///
415void DwarfDebug::AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
416 const std::string &Label) {
417 FoldingSetNodeID ID;
418 DIEObjectLabel::Profile(ID, Label);
419 void *Where;
420 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
421
422 if (!Value) {
423 Value = new DIEObjectLabel(Label);
424 ValuesSet.InsertNode(Value, Where);
425 Values.push_back(Value);
426 }
427
428 Die->AddValue(Attribute, Form, Value);
429}
430
431/// AddSectionOffset - Add a section offset label attribute data and value.
432///
433void DwarfDebug::AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
434 const DWLabel &Label, const DWLabel &Section,
435 bool isEH, bool useSet) {
436 FoldingSetNodeID ID;
437 DIESectionOffset::Profile(ID, Label, Section);
438 void *Where;
439 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
440
441 if (!Value) {
442 Value = new DIESectionOffset(Label, Section, isEH, useSet);
443 ValuesSet.InsertNode(Value, Where);
444 Values.push_back(Value);
445 }
446
447 Die->AddValue(Attribute, Form, Value);
448}
449
450/// AddDelta - Add a label delta attribute data and value.
451///
452void DwarfDebug::AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
453 const DWLabel &Hi, const DWLabel &Lo) {
454 FoldingSetNodeID ID;
455 DIEDelta::Profile(ID, Hi, Lo);
456 void *Where;
457 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
458
459 if (!Value) {
460 Value = new DIEDelta(Hi, Lo);
461 ValuesSet.InsertNode(Value, Where);
462 Values.push_back(Value);
463 }
464
465 Die->AddValue(Attribute, Form, Value);
466}
467
468/// AddBlock - Add block data.
469///
470void DwarfDebug::AddBlock(DIE *Die, unsigned Attribute, unsigned Form,
471 DIEBlock *Block) {
472 Block->ComputeSize(TD);
473 FoldingSetNodeID ID;
474 Block->Profile(ID);
475 void *Where;
476 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
477
478 if (!Value) {
479 Value = Block;
480 ValuesSet.InsertNode(Value, Where);
481 Values.push_back(Value);
482 } else {
483 // Already exists, reuse the previous one.
484 delete Block;
485 Block = cast<DIEBlock>(Value);
486 }
487
488 Die->AddValue(Attribute, Block->BestForm(), Value);
489}
490
491/// AddSourceLine - Add location information to specified debug information
492/// entry.
493void DwarfDebug::AddSourceLine(DIE *Die, const DIVariable *V) {
494 // If there is no compile unit specified, don't add a line #.
495 if (V->getCompileUnit().isNull())
496 return;
497
498 unsigned Line = V->getLineNumber();
499 unsigned FileID = FindCompileUnit(V->getCompileUnit()).getID();
500 assert(FileID && "Invalid file id");
501 AddUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
502 AddUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
503}
504
505/// AddSourceLine - Add location information to specified debug information
506/// entry.
507void DwarfDebug::AddSourceLine(DIE *Die, const DIGlobal *G) {
508 // If there is no compile unit specified, don't add a line #.
509 if (G->getCompileUnit().isNull())
510 return;
511
512 unsigned Line = G->getLineNumber();
513 unsigned FileID = FindCompileUnit(G->getCompileUnit()).getID();
514 assert(FileID && "Invalid file id");
515 AddUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
516 AddUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
517}
Devang Patel82dfc0c2009-08-31 22:47:13 +0000518
519/// AddSourceLine - Add location information to specified debug information
520/// entry.
521void DwarfDebug::AddSourceLine(DIE *Die, const DISubprogram *SP) {
522 // If there is no compile unit specified, don't add a line #.
523 if (SP->getCompileUnit().isNull())
524 return;
Caroline Ticec6f9d622009-09-11 18:25:54 +0000525 // If the line number is 0, don't add it.
526 if (SP->getLineNumber() == 0)
527 return;
528
Devang Patel82dfc0c2009-08-31 22:47:13 +0000529
530 unsigned Line = SP->getLineNumber();
531 unsigned FileID = FindCompileUnit(SP->getCompileUnit()).getID();
532 assert(FileID && "Invalid file id");
533 AddUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
534 AddUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
535}
536
537/// AddSourceLine - Add location information to specified debug information
538/// entry.
Bill Wendling0310d762009-05-15 09:23:25 +0000539void DwarfDebug::AddSourceLine(DIE *Die, const DIType *Ty) {
540 // If there is no compile unit specified, don't add a line #.
541 DICompileUnit CU = Ty->getCompileUnit();
542 if (CU.isNull())
543 return;
544
545 unsigned Line = Ty->getLineNumber();
546 unsigned FileID = FindCompileUnit(CU).getID();
547 assert(FileID && "Invalid file id");
548 AddUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
549 AddUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
550}
551
Caroline Ticedc8f6042009-08-31 21:19:37 +0000552/* Byref variables, in Blocks, are declared by the programmer as
553 "SomeType VarName;", but the compiler creates a
554 __Block_byref_x_VarName struct, and gives the variable VarName
555 either the struct, or a pointer to the struct, as its type. This
556 is necessary for various behind-the-scenes things the compiler
557 needs to do with by-reference variables in blocks.
558
559 However, as far as the original *programmer* is concerned, the
560 variable should still have type 'SomeType', as originally declared.
561
562 The following function dives into the __Block_byref_x_VarName
563 struct to find the original type of the variable. This will be
564 passed back to the code generating the type for the Debug
565 Information Entry for the variable 'VarName'. 'VarName' will then
566 have the original type 'SomeType' in its debug information.
567
568 The original type 'SomeType' will be the type of the field named
569 'VarName' inside the __Block_byref_x_VarName struct.
570
571 NOTE: In order for this to not completely fail on the debugger
572 side, the Debug Information Entry for the variable VarName needs to
573 have a DW_AT_location that tells the debugger how to unwind through
574 the pointers and __Block_byref_x_VarName struct to find the actual
575 value of the variable. The function AddBlockByrefType does this. */
576
577/// Find the type the programmer originally declared the variable to be
578/// and return that type.
579///
580DIType DwarfDebug::GetBlockByrefType(DIType Ty, std::string Name) {
581
582 DIType subType = Ty;
583 unsigned tag = Ty.getTag();
584
585 if (tag == dwarf::DW_TAG_pointer_type) {
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000586 DIDerivedType DTy = DIDerivedType(Ty.getNode());
Caroline Ticedc8f6042009-08-31 21:19:37 +0000587 subType = DTy.getTypeDerivedFrom();
588 }
589
590 DICompositeType blockStruct = DICompositeType(subType.getNode());
591
592 DIArray Elements = blockStruct.getTypeArray();
593
594 if (Elements.isNull())
595 return Ty;
596
597 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
598 DIDescriptor Element = Elements.getElement(i);
599 DIDerivedType DT = DIDerivedType(Element.getNode());
Devang Patel5ccdd102009-09-29 18:40:58 +0000600 if (strcmp(Name.c_str(), DT.getName()) == 0)
Caroline Ticedc8f6042009-08-31 21:19:37 +0000601 return (DT.getTypeDerivedFrom());
602 }
603
604 return Ty;
605}
606
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000607/// AddComplexAddress - Start with the address based on the location provided,
608/// and generate the DWARF information necessary to find the actual variable
609/// given the extra address information encoded in the DIVariable, starting from
610/// the starting location. Add the DWARF information to the die.
611///
612void DwarfDebug::AddComplexAddress(DbgVariable *&DV, DIE *Die,
613 unsigned Attribute,
614 const MachineLocation &Location) {
615 const DIVariable &VD = DV->getVariable();
616 DIType Ty = VD.getType();
617
618 // Decode the original location, and use that as the start of the byref
619 // variable's location.
620 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
621 DIEBlock *Block = new DIEBlock();
622
623 if (Location.isReg()) {
624 if (Reg < 32) {
625 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
626 } else {
627 Reg = Reg - dwarf::DW_OP_reg0;
628 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
629 AddUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
630 }
631 } else {
632 if (Reg < 32)
633 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
634 else {
635 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
636 AddUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
637 }
638
639 AddUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
640 }
641
642 for (unsigned i = 0, N = VD.getNumAddrElements(); i < N; ++i) {
643 uint64_t Element = VD.getAddrElement(i);
644
645 if (Element == DIFactory::OpPlus) {
646 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
647 AddUInt(Block, 0, dwarf::DW_FORM_udata, VD.getAddrElement(++i));
648 } else if (Element == DIFactory::OpDeref) {
649 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
650 } else llvm_unreachable("unknown DIFactory Opcode");
651 }
652
653 // Now attach the location information to the DIE.
654 AddBlock(Die, Attribute, 0, Block);
655}
656
Caroline Ticedc8f6042009-08-31 21:19:37 +0000657/* Byref variables, in Blocks, are declared by the programmer as "SomeType
658 VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
659 gives the variable VarName either the struct, or a pointer to the struct, as
660 its type. This is necessary for various behind-the-scenes things the
661 compiler needs to do with by-reference variables in Blocks.
662
663 However, as far as the original *programmer* is concerned, the variable
664 should still have type 'SomeType', as originally declared.
665
666 The function GetBlockByrefType dives into the __Block_byref_x_VarName
667 struct to find the original type of the variable, which is then assigned to
668 the variable's Debug Information Entry as its real type. So far, so good.
669 However now the debugger will expect the variable VarName to have the type
670 SomeType. So we need the location attribute for the variable to be an
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000671 expression that explains to the debugger how to navigate through the
Caroline Ticedc8f6042009-08-31 21:19:37 +0000672 pointers and struct to find the actual variable of type SomeType.
673
674 The following function does just that. We start by getting
675 the "normal" location for the variable. This will be the location
676 of either the struct __Block_byref_x_VarName or the pointer to the
677 struct __Block_byref_x_VarName.
678
679 The struct will look something like:
680
681 struct __Block_byref_x_VarName {
682 ... <various fields>
683 struct __Block_byref_x_VarName *forwarding;
684 ... <various other fields>
685 SomeType VarName;
686 ... <maybe more fields>
687 };
688
689 If we are given the struct directly (as our starting point) we
690 need to tell the debugger to:
691
692 1). Add the offset of the forwarding field.
693
694 2). Follow that pointer to get the the real __Block_byref_x_VarName
695 struct to use (the real one may have been copied onto the heap).
696
697 3). Add the offset for the field VarName, to find the actual variable.
698
699 If we started with a pointer to the struct, then we need to
700 dereference that pointer first, before the other steps.
701 Translating this into DWARF ops, we will need to append the following
702 to the current location description for the variable:
703
704 DW_OP_deref -- optional, if we start with a pointer
705 DW_OP_plus_uconst <forward_fld_offset>
706 DW_OP_deref
707 DW_OP_plus_uconst <varName_fld_offset>
708
709 That is what this function does. */
710
711/// AddBlockByrefAddress - Start with the address based on the location
712/// provided, and generate the DWARF information necessary to find the
713/// actual Block variable (navigating the Block struct) based on the
714/// starting location. Add the DWARF information to the die. For
715/// more information, read large comment just above here.
716///
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000717void DwarfDebug::AddBlockByrefAddress(DbgVariable *&DV, DIE *Die,
Daniel Dunbar00564992009-09-19 20:40:14 +0000718 unsigned Attribute,
719 const MachineLocation &Location) {
Caroline Ticedc8f6042009-08-31 21:19:37 +0000720 const DIVariable &VD = DV->getVariable();
721 DIType Ty = VD.getType();
722 DIType TmpTy = Ty;
723 unsigned Tag = Ty.getTag();
724 bool isPointer = false;
725
Devang Patel5ccdd102009-09-29 18:40:58 +0000726 const char *varName = VD.getName();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000727
728 if (Tag == dwarf::DW_TAG_pointer_type) {
Mike Stump3e4c9bd2009-09-30 00:08:22 +0000729 DIDerivedType DTy = DIDerivedType(Ty.getNode());
Caroline Ticedc8f6042009-08-31 21:19:37 +0000730 TmpTy = DTy.getTypeDerivedFrom();
731 isPointer = true;
732 }
733
734 DICompositeType blockStruct = DICompositeType(TmpTy.getNode());
735
Daniel Dunbar00564992009-09-19 20:40:14 +0000736 // Find the __forwarding field and the variable field in the __Block_byref
737 // struct.
Daniel Dunbar00564992009-09-19 20:40:14 +0000738 DIArray Fields = blockStruct.getTypeArray();
739 DIDescriptor varField = DIDescriptor();
740 DIDescriptor forwardingField = DIDescriptor();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000741
742
Daniel Dunbar00564992009-09-19 20:40:14 +0000743 for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
744 DIDescriptor Element = Fields.getElement(i);
745 DIDerivedType DT = DIDerivedType(Element.getNode());
Devang Patel5ccdd102009-09-29 18:40:58 +0000746 const char *fieldName = DT.getName();
747 if (strcmp(fieldName, "__forwarding") == 0)
Daniel Dunbar00564992009-09-19 20:40:14 +0000748 forwardingField = Element;
Devang Patel5ccdd102009-09-29 18:40:58 +0000749 else if (strcmp(fieldName, varName) == 0)
Daniel Dunbar00564992009-09-19 20:40:14 +0000750 varField = Element;
751 }
Daniel Dunbarf612ff62009-09-19 20:40:05 +0000752
Mike Stump7e3720d2009-09-24 23:21:26 +0000753 assert(!varField.isNull() && "Can't find byref variable in Block struct");
754 assert(!forwardingField.isNull()
755 && "Can't find forwarding field in Block struct");
Caroline Ticedc8f6042009-08-31 21:19:37 +0000756
Daniel Dunbar00564992009-09-19 20:40:14 +0000757 // Get the offsets for the forwarding field and the variable field.
Daniel Dunbar00564992009-09-19 20:40:14 +0000758 unsigned int forwardingFieldOffset =
759 DIDerivedType(forwardingField.getNode()).getOffsetInBits() >> 3;
760 unsigned int varFieldOffset =
761 DIDerivedType(varField.getNode()).getOffsetInBits() >> 3;
Caroline Ticedc8f6042009-08-31 21:19:37 +0000762
Mike Stump7e3720d2009-09-24 23:21:26 +0000763 // Decode the original location, and use that as the start of the byref
764 // variable's location.
Daniel Dunbar00564992009-09-19 20:40:14 +0000765 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
766 DIEBlock *Block = new DIEBlock();
Caroline Ticedc8f6042009-08-31 21:19:37 +0000767
Daniel Dunbar00564992009-09-19 20:40:14 +0000768 if (Location.isReg()) {
769 if (Reg < 32)
770 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
771 else {
772 Reg = Reg - dwarf::DW_OP_reg0;
773 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
774 AddUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
775 }
776 } else {
777 if (Reg < 32)
778 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
779 else {
780 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
781 AddUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
782 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000783
Daniel Dunbar00564992009-09-19 20:40:14 +0000784 AddUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
785 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000786
Mike Stump7e3720d2009-09-24 23:21:26 +0000787 // If we started with a pointer to the __Block_byref... struct, then
Daniel Dunbar00564992009-09-19 20:40:14 +0000788 // the first thing we need to do is dereference the pointer (DW_OP_deref).
Daniel Dunbar00564992009-09-19 20:40:14 +0000789 if (isPointer)
790 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000791
Daniel Dunbar00564992009-09-19 20:40:14 +0000792 // Next add the offset for the '__forwarding' field:
793 // DW_OP_plus_uconst ForwardingFieldOffset. Note there's no point in
794 // adding the offset if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000795 if (forwardingFieldOffset > 0) {
796 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
797 AddUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
798 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000799
Daniel Dunbar00564992009-09-19 20:40:14 +0000800 // Now dereference the __forwarding field to get to the real __Block_byref
801 // struct: DW_OP_deref.
Daniel Dunbar00564992009-09-19 20:40:14 +0000802 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000803
Daniel Dunbar00564992009-09-19 20:40:14 +0000804 // Now that we've got the real __Block_byref... struct, add the offset
805 // for the variable's field to get to the location of the actual variable:
806 // DW_OP_plus_uconst varFieldOffset. Again, don't add if it's 0.
Daniel Dunbar00564992009-09-19 20:40:14 +0000807 if (varFieldOffset > 0) {
808 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
809 AddUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
810 }
Caroline Ticedc8f6042009-08-31 21:19:37 +0000811
Daniel Dunbar00564992009-09-19 20:40:14 +0000812 // Now attach the location information to the DIE.
Daniel Dunbar00564992009-09-19 20:40:14 +0000813 AddBlock(Die, Attribute, 0, Block);
Caroline Ticedc8f6042009-08-31 21:19:37 +0000814}
815
Bill Wendling0310d762009-05-15 09:23:25 +0000816/// AddAddress - Add an address attribute to a die based on the location
817/// provided.
818void DwarfDebug::AddAddress(DIE *Die, unsigned Attribute,
819 const MachineLocation &Location) {
820 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
821 DIEBlock *Block = new DIEBlock();
822
823 if (Location.isReg()) {
824 if (Reg < 32) {
825 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
826 } else {
827 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
828 AddUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
829 }
830 } else {
831 if (Reg < 32) {
832 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
833 } else {
834 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
835 AddUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
836 }
837
838 AddUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
839 }
840
841 AddBlock(Die, Attribute, 0, Block);
842}
843
844/// AddType - Add a new type attribute to the specified entity.
845void DwarfDebug::AddType(CompileUnit *DW_Unit, DIE *Entity, DIType Ty) {
846 if (Ty.isNull())
847 return;
848
849 // Check for pre-existence.
Devang Patele4b27562009-08-28 23:24:31 +0000850 DIEEntry *&Slot = DW_Unit->getDIEEntrySlotFor(Ty.getNode());
Bill Wendling0310d762009-05-15 09:23:25 +0000851
852 // If it exists then use the existing value.
853 if (Slot) {
854 Entity->AddValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Slot);
855 return;
856 }
857
858 // Set up proxy.
Bill Wendling995f80a2009-05-20 23:24:48 +0000859 Slot = CreateDIEEntry();
Bill Wendling0310d762009-05-15 09:23:25 +0000860
861 // Construct type.
862 DIE Buffer(dwarf::DW_TAG_base_type);
Devang Patel6ceea332009-08-31 18:49:10 +0000863 if (Ty.isBasicType())
Devang Patele4b27562009-08-28 23:24:31 +0000864 ConstructTypeDIE(DW_Unit, Buffer, DIBasicType(Ty.getNode()));
Devang Patel6ceea332009-08-31 18:49:10 +0000865 else if (Ty.isCompositeType())
Devang Patele4b27562009-08-28 23:24:31 +0000866 ConstructTypeDIE(DW_Unit, Buffer, DICompositeType(Ty.getNode()));
Bill Wendling0310d762009-05-15 09:23:25 +0000867 else {
Devang Patel6ceea332009-08-31 18:49:10 +0000868 assert(Ty.isDerivedType() && "Unknown kind of DIType");
Devang Patele4b27562009-08-28 23:24:31 +0000869 ConstructTypeDIE(DW_Unit, Buffer, DIDerivedType(Ty.getNode()));
Bill Wendling0310d762009-05-15 09:23:25 +0000870 }
871
872 // Add debug information entry to entity and appropriate context.
873 DIE *Die = NULL;
874 DIDescriptor Context = Ty.getContext();
875 if (!Context.isNull())
Devang Patele4b27562009-08-28 23:24:31 +0000876 Die = DW_Unit->getDieMapSlotFor(Context.getNode());
Bill Wendling0310d762009-05-15 09:23:25 +0000877
878 if (Die) {
879 DIE *Child = new DIE(Buffer);
880 Die->AddChild(Child);
881 Buffer.Detach();
882 SetDIEEntry(Slot, Child);
883 } else {
884 Die = DW_Unit->AddDie(Buffer);
885 SetDIEEntry(Slot, Die);
886 }
887
888 Entity->AddValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Slot);
889}
890
891/// ConstructTypeDIE - Construct basic type die from DIBasicType.
892void DwarfDebug::ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
893 DIBasicType BTy) {
894 // Get core information.
Devang Patel5ccdd102009-09-29 18:40:58 +0000895 const char *Name = BTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000896 Buffer.setTag(dwarf::DW_TAG_base_type);
897 AddUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
898 BTy.getEncoding());
899
900 // Add name if not anonymous or intermediate type.
Devang Patel5ccdd102009-09-29 18:40:58 +0000901 if (Name)
Bill Wendling0310d762009-05-15 09:23:25 +0000902 AddString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
903 uint64_t Size = BTy.getSizeInBits() >> 3;
904 AddUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
905}
906
907/// ConstructTypeDIE - Construct derived type die from DIDerivedType.
908void DwarfDebug::ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
909 DIDerivedType DTy) {
910 // Get core information.
Devang Patel5ccdd102009-09-29 18:40:58 +0000911 const char *Name = DTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000912 uint64_t Size = DTy.getSizeInBits() >> 3;
913 unsigned Tag = DTy.getTag();
914
915 // FIXME - Workaround for templates.
916 if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
917
918 Buffer.setTag(Tag);
919
920 // Map to main type, void will not have a type.
921 DIType FromTy = DTy.getTypeDerivedFrom();
922 AddType(DW_Unit, &Buffer, FromTy);
923
924 // Add name if not anonymous or intermediate type.
Devang Patel808b8262009-10-16 21:27:43 +0000925 if (Name && Tag != dwarf::DW_TAG_pointer_type)
Bill Wendling0310d762009-05-15 09:23:25 +0000926 AddString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
927
928 // Add size if non-zero (derived types might be zero-sized.)
929 if (Size)
930 AddUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
931
932 // Add source line info if available and TyDesc is not a forward declaration.
933 if (!DTy.isForwardDecl())
934 AddSourceLine(&Buffer, &DTy);
935}
936
937/// ConstructTypeDIE - Construct type DIE from DICompositeType.
938void DwarfDebug::ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
939 DICompositeType CTy) {
940 // Get core information.
Devang Patel5ccdd102009-09-29 18:40:58 +0000941 const char *Name = CTy.getName();
Bill Wendling0310d762009-05-15 09:23:25 +0000942
943 uint64_t Size = CTy.getSizeInBits() >> 3;
944 unsigned Tag = CTy.getTag();
945 Buffer.setTag(Tag);
946
947 switch (Tag) {
948 case dwarf::DW_TAG_vector_type:
949 case dwarf::DW_TAG_array_type:
950 ConstructArrayTypeDIE(DW_Unit, Buffer, &CTy);
951 break;
952 case dwarf::DW_TAG_enumeration_type: {
953 DIArray Elements = CTy.getTypeArray();
954
955 // Add enumerators to enumeration type.
956 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
957 DIE *ElemDie = NULL;
Devang Patele4b27562009-08-28 23:24:31 +0000958 DIEnumerator Enum(Elements.getElement(i).getNode());
Devang Patelc5254722009-10-09 17:51:49 +0000959 if (!Enum.isNull()) {
960 ElemDie = ConstructEnumTypeDIE(DW_Unit, &Enum);
961 Buffer.AddChild(ElemDie);
962 }
Bill Wendling0310d762009-05-15 09:23:25 +0000963 }
964 }
965 break;
966 case dwarf::DW_TAG_subroutine_type: {
967 // Add return type.
968 DIArray Elements = CTy.getTypeArray();
969 DIDescriptor RTy = Elements.getElement(0);
Devang Patele4b27562009-08-28 23:24:31 +0000970 AddType(DW_Unit, &Buffer, DIType(RTy.getNode()));
Bill Wendling0310d762009-05-15 09:23:25 +0000971
972 // Add prototype flag.
973 AddUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
974
975 // Add arguments.
976 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
977 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
978 DIDescriptor Ty = Elements.getElement(i);
Devang Patele4b27562009-08-28 23:24:31 +0000979 AddType(DW_Unit, Arg, DIType(Ty.getNode()));
Bill Wendling0310d762009-05-15 09:23:25 +0000980 Buffer.AddChild(Arg);
981 }
982 }
983 break;
984 case dwarf::DW_TAG_structure_type:
985 case dwarf::DW_TAG_union_type:
986 case dwarf::DW_TAG_class_type: {
987 // Add elements to structure type.
988 DIArray Elements = CTy.getTypeArray();
989
990 // A forward struct declared type may not have elements available.
991 if (Elements.isNull())
992 break;
993
994 // Add elements to structure type.
995 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
996 DIDescriptor Element = Elements.getElement(i);
Devang Patele4b27562009-08-28 23:24:31 +0000997 if (Element.isNull())
998 continue;
Bill Wendling0310d762009-05-15 09:23:25 +0000999 DIE *ElemDie = NULL;
1000 if (Element.getTag() == dwarf::DW_TAG_subprogram)
1001 ElemDie = CreateSubprogramDIE(DW_Unit,
Devang Patele4b27562009-08-28 23:24:31 +00001002 DISubprogram(Element.getNode()));
Bill Wendling0310d762009-05-15 09:23:25 +00001003 else
1004 ElemDie = CreateMemberDIE(DW_Unit,
Devang Patele4b27562009-08-28 23:24:31 +00001005 DIDerivedType(Element.getNode()));
Bill Wendling0310d762009-05-15 09:23:25 +00001006 Buffer.AddChild(ElemDie);
1007 }
1008
Devang Patela1ba2692009-08-27 23:51:51 +00001009 if (CTy.isAppleBlockExtension())
Bill Wendling0310d762009-05-15 09:23:25 +00001010 AddUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
1011
1012 unsigned RLang = CTy.getRunTimeLang();
1013 if (RLang)
1014 AddUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
1015 dwarf::DW_FORM_data1, RLang);
1016 break;
1017 }
1018 default:
1019 break;
1020 }
1021
1022 // Add name if not anonymous or intermediate type.
Devang Patel5ccdd102009-09-29 18:40:58 +00001023 if (Name)
Bill Wendling0310d762009-05-15 09:23:25 +00001024 AddString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
1025
1026 if (Tag == dwarf::DW_TAG_enumeration_type ||
1027 Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type) {
1028 // Add size if non-zero (derived types might be zero-sized.)
1029 if (Size)
1030 AddUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
1031 else {
1032 // Add zero size if it is not a forward declaration.
1033 if (CTy.isForwardDecl())
1034 AddUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1035 else
1036 AddUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
1037 }
1038
1039 // Add source line info if available.
1040 if (!CTy.isForwardDecl())
1041 AddSourceLine(&Buffer, &CTy);
1042 }
1043}
1044
1045/// ConstructSubrangeDIE - Construct subrange DIE from DISubrange.
1046void DwarfDebug::ConstructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
1047 int64_t L = SR.getLo();
1048 int64_t H = SR.getHi();
1049 DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1050
Devang Patel6325a532009-08-14 20:59:16 +00001051 AddDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
1052 if (L)
1053 AddSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
1054 if (H)
Daniel Dunbar00564992009-09-19 20:40:14 +00001055 AddSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
Bill Wendling0310d762009-05-15 09:23:25 +00001056
1057 Buffer.AddChild(DW_Subrange);
1058}
1059
1060/// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType.
1061void DwarfDebug::ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1062 DICompositeType *CTy) {
1063 Buffer.setTag(dwarf::DW_TAG_array_type);
1064 if (CTy->getTag() == dwarf::DW_TAG_vector_type)
1065 AddUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
1066
1067 // Emit derived type.
1068 AddType(DW_Unit, &Buffer, CTy->getTypeDerivedFrom());
1069 DIArray Elements = CTy->getTypeArray();
1070
1071 // Construct an anonymous type for index type.
1072 DIE IdxBuffer(dwarf::DW_TAG_base_type);
1073 AddUInt(&IdxBuffer, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1074 AddUInt(&IdxBuffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
1075 dwarf::DW_ATE_signed);
1076 DIE *IndexTy = DW_Unit->AddDie(IdxBuffer);
1077
1078 // Add subranges to array type.
1079 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1080 DIDescriptor Element = Elements.getElement(i);
1081 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
Devang Patele4b27562009-08-28 23:24:31 +00001082 ConstructSubrangeDIE(Buffer, DISubrange(Element.getNode()), IndexTy);
Bill Wendling0310d762009-05-15 09:23:25 +00001083 }
1084}
1085
1086/// ConstructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
1087DIE *DwarfDebug::ConstructEnumTypeDIE(CompileUnit *DW_Unit, DIEnumerator *ETy) {
1088 DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
Devang Patel5ccdd102009-09-29 18:40:58 +00001089 const char *Name = ETy->getName();
Bill Wendling0310d762009-05-15 09:23:25 +00001090 AddString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
1091 int64_t Value = ETy->getEnumValue();
1092 AddSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
1093 return Enumerator;
1094}
1095
1096/// CreateGlobalVariableDIE - Create new DIE using GV.
1097DIE *DwarfDebug::CreateGlobalVariableDIE(CompileUnit *DW_Unit,
1098 const DIGlobalVariable &GV) {
Devang Patel465c3be2009-11-06 01:30:04 +00001099 // If the global variable was optmized out then no need to create debug info entry.
Devang Patel84c73e92009-11-06 17:58:12 +00001100 if (!GV.getGlobal()) return NULL;
1101 if (!GV.getDisplayName()) return NULL;
Devang Patel465c3be2009-11-06 01:30:04 +00001102
Bill Wendling0310d762009-05-15 09:23:25 +00001103 DIE *GVDie = new DIE(dwarf::DW_TAG_variable);
Devang Patel5ccdd102009-09-29 18:40:58 +00001104 AddString(GVDie, dwarf::DW_AT_name, dwarf::DW_FORM_string,
1105 GV.getDisplayName());
1106
1107 const char *LinkageName = GV.getLinkageName();
1108 if (LinkageName) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001109 // Skip special LLVM prefix that is used to inform the asm printer to not
1110 // emit usual symbol prefix before the symbol name. This happens for
1111 // Objective-C symbol names and symbol whose name is replaced using GCC's
1112 // __asm__ attribute.
Devang Patel53cb17d2009-07-16 01:01:22 +00001113 if (LinkageName[0] == 1)
1114 LinkageName = &LinkageName[1];
Bill Wendling0310d762009-05-15 09:23:25 +00001115 AddString(GVDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel1a8d2d22009-07-14 00:55:28 +00001116 LinkageName);
Devang Patel53cb17d2009-07-16 01:01:22 +00001117 }
Daniel Dunbar00564992009-09-19 20:40:14 +00001118 AddType(DW_Unit, GVDie, GV.getType());
Bill Wendling0310d762009-05-15 09:23:25 +00001119 if (!GV.isLocalToUnit())
1120 AddUInt(GVDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1121 AddSourceLine(GVDie, &GV);
Devang Patelb71a16d2009-10-05 23:22:08 +00001122
1123 // Add address.
1124 DIEBlock *Block = new DIEBlock();
1125 AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1126 AddObjectLabel(Block, 0, dwarf::DW_FORM_udata,
1127 Asm->Mang->getMangledName(GV.getGlobal()));
1128 AddBlock(GVDie, dwarf::DW_AT_location, 0, Block);
1129
Bill Wendling0310d762009-05-15 09:23:25 +00001130 return GVDie;
1131}
1132
1133/// CreateMemberDIE - Create new member DIE.
1134DIE *DwarfDebug::CreateMemberDIE(CompileUnit *DW_Unit, const DIDerivedType &DT){
1135 DIE *MemberDie = new DIE(DT.getTag());
Devang Patel5ccdd102009-09-29 18:40:58 +00001136 if (const char *Name = DT.getName())
Bill Wendling0310d762009-05-15 09:23:25 +00001137 AddString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
1138
1139 AddType(DW_Unit, MemberDie, DT.getTypeDerivedFrom());
1140
1141 AddSourceLine(MemberDie, &DT);
1142
Devang Patel33db5082009-11-04 22:06:12 +00001143 DIEBlock *MemLocationDie = new DIEBlock();
1144 AddUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
1145
Bill Wendling0310d762009-05-15 09:23:25 +00001146 uint64_t Size = DT.getSizeInBits();
Devang Patel61ecbd12009-11-04 23:48:00 +00001147 uint64_t FieldSize = DT.getOriginalTypeSize();
Bill Wendling0310d762009-05-15 09:23:25 +00001148
1149 if (Size != FieldSize) {
1150 // Handle bitfield.
1151 AddUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1152 AddUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
1153
1154 uint64_t Offset = DT.getOffsetInBits();
1155 uint64_t FieldOffset = Offset;
1156 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1157 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1158 FieldOffset = (HiMark - FieldSize);
1159 Offset -= FieldOffset;
1160
1161 // Maybe we need to work from the other end.
1162 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
1163 AddUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
Bill Wendling0310d762009-05-15 09:23:25 +00001164
Devang Patel33db5082009-11-04 22:06:12 +00001165 // Here WD_AT_data_member_location points to the anonymous
1166 // field that includes this bit field.
1167 AddUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
1168
1169 } else
1170 // This is not a bitfield.
1171 AddUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
1172
1173 AddBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
Bill Wendling0310d762009-05-15 09:23:25 +00001174
1175 if (DT.isProtected())
1176 AddUInt(MemberDie, dwarf::DW_AT_accessibility, 0,
1177 dwarf::DW_ACCESS_protected);
1178 else if (DT.isPrivate())
1179 AddUInt(MemberDie, dwarf::DW_AT_accessibility, 0,
1180 dwarf::DW_ACCESS_private);
1181
1182 return MemberDie;
1183}
1184
1185/// CreateSubprogramDIE - Create new DIE using SP.
1186DIE *DwarfDebug::CreateSubprogramDIE(CompileUnit *DW_Unit,
1187 const DISubprogram &SP,
Bill Wendling6679ee42009-05-18 22:02:36 +00001188 bool IsConstructor,
1189 bool IsInlined) {
Bill Wendling0310d762009-05-15 09:23:25 +00001190 DIE *SPDie = new DIE(dwarf::DW_TAG_subprogram);
1191
Devang Patel5ccdd102009-09-29 18:40:58 +00001192 const char * Name = SP.getName();
Bill Wendling0310d762009-05-15 09:23:25 +00001193 AddString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
1194
Devang Patel5ccdd102009-09-29 18:40:58 +00001195 const char *LinkageName = SP.getLinkageName();
1196 if (LinkageName) {
Devang Patel53cb17d2009-07-16 01:01:22 +00001197 // Skip special LLVM prefix that is used to inform the asm printer to not emit
1198 // usual symbol prefix before the symbol name. This happens for Objective-C
1199 // symbol names and symbol whose name is replaced using GCC's __asm__ attribute.
1200 if (LinkageName[0] == 1)
1201 LinkageName = &LinkageName[1];
Bill Wendling0310d762009-05-15 09:23:25 +00001202 AddString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
Devang Patel1a8d2d22009-07-14 00:55:28 +00001203 LinkageName);
Devang Patel53cb17d2009-07-16 01:01:22 +00001204 }
Bill Wendling0310d762009-05-15 09:23:25 +00001205 AddSourceLine(SPDie, &SP);
1206
1207 DICompositeType SPTy = SP.getType();
1208 DIArray Args = SPTy.getTypeArray();
1209
1210 // Add prototyped tag, if C or ObjC.
1211 unsigned Lang = SP.getCompileUnit().getLanguage();
1212 if (Lang == dwarf::DW_LANG_C99 || Lang == dwarf::DW_LANG_C89 ||
1213 Lang == dwarf::DW_LANG_ObjC)
1214 AddUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
1215
1216 // Add Return Type.
1217 unsigned SPTag = SPTy.getTag();
1218 if (!IsConstructor) {
1219 if (Args.isNull() || SPTag != dwarf::DW_TAG_subroutine_type)
1220 AddType(DW_Unit, SPDie, SPTy);
1221 else
Devang Patele4b27562009-08-28 23:24:31 +00001222 AddType(DW_Unit, SPDie, DIType(Args.getElement(0).getNode()));
Bill Wendling0310d762009-05-15 09:23:25 +00001223 }
1224
1225 if (!SP.isDefinition()) {
1226 AddUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
1227
1228 // Add arguments. Do not add arguments for subprogram definition. They will
1229 // be handled through RecordVariable.
1230 if (SPTag == dwarf::DW_TAG_subroutine_type)
1231 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1232 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
Devang Patele4b27562009-08-28 23:24:31 +00001233 AddType(DW_Unit, Arg, DIType(Args.getElement(i).getNode()));
Bill Wendling0310d762009-05-15 09:23:25 +00001234 AddUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1); // ??
1235 SPDie->AddChild(Arg);
1236 }
1237 }
1238
Bill Wendling0310d762009-05-15 09:23:25 +00001239 // DW_TAG_inlined_subroutine may refer to this DIE.
Devang Patele4b27562009-08-28 23:24:31 +00001240 DIE *&Slot = DW_Unit->getDieMapSlotFor(SP.getNode());
Bill Wendling0310d762009-05-15 09:23:25 +00001241 Slot = SPDie;
1242 return SPDie;
1243}
1244
1245/// FindCompileUnit - Get the compile unit for the given descriptor.
1246///
1247CompileUnit &DwarfDebug::FindCompileUnit(DICompileUnit Unit) const {
1248 DenseMap<Value *, CompileUnit *>::const_iterator I =
Devang Patele4b27562009-08-28 23:24:31 +00001249 CompileUnitMap.find(Unit.getNode());
Bill Wendling0310d762009-05-15 09:23:25 +00001250 assert(I != CompileUnitMap.end() && "Missing compile unit.");
1251 return *I->second;
1252}
1253
Bill Wendling995f80a2009-05-20 23:24:48 +00001254/// CreateDbgScopeVariable - Create a new scope variable.
Bill Wendling0310d762009-05-15 09:23:25 +00001255///
Bill Wendling995f80a2009-05-20 23:24:48 +00001256DIE *DwarfDebug::CreateDbgScopeVariable(DbgVariable *DV, CompileUnit *Unit) {
Bill Wendling0310d762009-05-15 09:23:25 +00001257 // Get the descriptor.
1258 const DIVariable &VD = DV->getVariable();
Devang Patel1b845972009-11-03 18:30:27 +00001259 const char *Name = VD.getName();
1260 if (!Name)
1261 return NULL;
Bill Wendling0310d762009-05-15 09:23:25 +00001262
1263 // Translate tag to proper Dwarf tag. The result variable is dropped for
1264 // now.
1265 unsigned Tag;
1266 switch (VD.getTag()) {
1267 case dwarf::DW_TAG_return_variable:
1268 return NULL;
1269 case dwarf::DW_TAG_arg_variable:
1270 Tag = dwarf::DW_TAG_formal_parameter;
1271 break;
1272 case dwarf::DW_TAG_auto_variable: // fall thru
1273 default:
1274 Tag = dwarf::DW_TAG_variable;
1275 break;
1276 }
1277
1278 // Define variable debug information entry.
1279 DIE *VariableDie = new DIE(Tag);
Bill Wendling0310d762009-05-15 09:23:25 +00001280 AddString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
1281
1282 // Add source line info if available.
1283 AddSourceLine(VariableDie, &VD);
1284
1285 // Add variable type.
Devang Patel53bb5c92009-11-10 23:06:00 +00001286 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
1287 // addresses instead.
Caroline Ticedc8f6042009-08-31 21:19:37 +00001288 if (VD.isBlockByrefVariable())
1289 AddType(Unit, VariableDie, GetBlockByrefType(VD.getType(), Name));
1290 else
1291 AddType(Unit, VariableDie, VD.getType());
Bill Wendling0310d762009-05-15 09:23:25 +00001292
1293 // Add variable address.
Devang Patel53bb5c92009-11-10 23:06:00 +00001294 // Variables for abstract instances of inlined functions don't get a
1295 // location.
1296 MachineLocation Location;
1297 Location.set(RI->getFrameRegister(*MF),
1298 RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
1299
1300
1301 if (VD.hasComplexAddress())
1302 AddComplexAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
1303 else if (VD.isBlockByrefVariable())
1304 AddBlockByrefAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
1305 else
1306 AddAddress(VariableDie, dwarf::DW_AT_location, Location);
Bill Wendling0310d762009-05-15 09:23:25 +00001307
1308 return VariableDie;
1309}
1310
Devang Patel53bb5c92009-11-10 23:06:00 +00001311/// getUpdatedDbgScope - Find or create DbgScope assicated with the instruction.
1312/// Initialize scope and update scope hierarchy.
1313DbgScope *DwarfDebug::getUpdatedDbgScope(MDNode *N, const MachineInstr *MI,
1314 MDNode *InlinedAt) {
1315 assert (N && "Invalid Scope encoding!");
1316 assert (MI && "Missing machine instruction!");
1317 bool GetConcreteScope = (MI && InlinedAt);
1318
1319 DbgScope *NScope = NULL;
1320
1321 if (InlinedAt)
1322 NScope = DbgScopeMap.lookup(InlinedAt);
1323 else
1324 NScope = DbgScopeMap.lookup(N);
1325 assert (NScope && "Unable to find working scope!");
1326
1327 if (NScope->getFirstInsn())
1328 return NScope;
Devang Patelaf9e8472009-10-01 20:31:14 +00001329
1330 DbgScope *Parent = NULL;
Devang Patel53bb5c92009-11-10 23:06:00 +00001331 if (GetConcreteScope) {
Devang Patelc90aefe2009-10-14 21:08:09 +00001332 DILocation IL(InlinedAt);
Devang Patel53bb5c92009-11-10 23:06:00 +00001333 Parent = getUpdatedDbgScope(IL.getScope().getNode(), MI,
1334 IL.getOrigLocation().getNode());
1335 assert (Parent && "Unable to find Parent scope!");
1336 NScope->setParent(Parent);
1337 Parent->AddScope(NScope);
1338 } else if (DIDescriptor(N).isLexicalBlock()) {
1339 DILexicalBlock DB(N);
1340 if (!DB.getContext().isNull()) {
1341 Parent = getUpdatedDbgScope(DB.getContext().getNode(), MI, InlinedAt);
1342 NScope->setParent(Parent);
1343 Parent->AddScope(NScope);
1344 }
Devang Patelc90aefe2009-10-14 21:08:09 +00001345 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001346
Devang Patelbdf45cb2009-10-27 20:47:17 +00001347 NScope->setFirstInsn(MI);
Devang Patelaf9e8472009-10-01 20:31:14 +00001348
Devang Patel53bb5c92009-11-10 23:06:00 +00001349 if (!Parent && !InlinedAt) {
Devang Patel39ae3ff2009-11-11 00:31:36 +00001350 StringRef SPName = DISubprogram(N).getLinkageName();
1351 if (SPName == MF->getFunction()->getName())
1352 CurrentFnDbgScope = NScope;
Devang Patel53bb5c92009-11-10 23:06:00 +00001353 }
Devang Patelaf9e8472009-10-01 20:31:14 +00001354
Devang Patel53bb5c92009-11-10 23:06:00 +00001355 if (GetConcreteScope) {
1356 ConcreteScopes[InlinedAt] = NScope;
1357 getOrCreateAbstractScope(N);
1358 }
1359
Devang Patelbdf45cb2009-10-27 20:47:17 +00001360 return NScope;
Devang Patelaf9e8472009-10-01 20:31:14 +00001361}
1362
Devang Patel53bb5c92009-11-10 23:06:00 +00001363DbgScope *DwarfDebug::getOrCreateAbstractScope(MDNode *N) {
1364 assert (N && "Invalid Scope encoding!");
1365
1366 DbgScope *AScope = AbstractScopes.lookup(N);
1367 if (AScope)
1368 return AScope;
1369
1370 DbgScope *Parent = NULL;
1371
1372 DIDescriptor Scope(N);
1373 if (Scope.isLexicalBlock()) {
1374 DILexicalBlock DB(N);
1375 DIDescriptor ParentDesc = DB.getContext();
1376 if (!ParentDesc.isNull())
1377 Parent = getOrCreateAbstractScope(ParentDesc.getNode());
1378 }
1379
1380 AScope = new DbgScope(Parent, DIDescriptor(N), NULL);
1381
1382 if (Parent)
1383 Parent->AddScope(AScope);
1384 AScope->setAbstractScope();
1385 AbstractScopes[N] = AScope;
1386 if (DIDescriptor(N).isSubprogram())
1387 AbstractScopesList.push_back(AScope);
1388 return AScope;
1389}
Devang Patelaf9e8472009-10-01 20:31:14 +00001390
1391/// getOrCreateScope - Returns the scope associated with the given descriptor.
1392/// FIXME - Remove this method.
Devang Patele4b27562009-08-28 23:24:31 +00001393DbgScope *DwarfDebug::getOrCreateScope(MDNode *N) {
1394 DbgScope *&Slot = DbgScopeMap[N];
Bill Wendling0310d762009-05-15 09:23:25 +00001395 if (Slot) return Slot;
1396
1397 DbgScope *Parent = NULL;
Devang Patel5e005d82009-08-31 22:00:15 +00001398 DILexicalBlock Block(N);
Bill Wendling0310d762009-05-15 09:23:25 +00001399
Bill Wendling0310d762009-05-15 09:23:25 +00001400 if (!Block.isNull()) {
1401 DIDescriptor ParentDesc = Block.getContext();
1402 Parent =
Devang Patele4b27562009-08-28 23:24:31 +00001403 ParentDesc.isNull() ? NULL : getOrCreateScope(ParentDesc.getNode());
Bill Wendling0310d762009-05-15 09:23:25 +00001404 }
1405
Devang Patele4b27562009-08-28 23:24:31 +00001406 Slot = new DbgScope(Parent, DIDescriptor(N));
Bill Wendling0310d762009-05-15 09:23:25 +00001407
1408 if (Parent)
1409 Parent->AddScope(Slot);
1410 else
1411 // First function is top level function.
Devang Patel53bb5c92009-11-10 23:06:00 +00001412 CurrentFnDbgScope = Slot;
Bill Wendling0310d762009-05-15 09:23:25 +00001413
1414 return Slot;
1415}
1416
Devang Patel53bb5c92009-11-10 23:06:00 +00001417static DISubprogram getDISubprogram(MDNode *N) {
1418
1419 DIDescriptor D(N);
1420 if (D.isNull())
1421 return DISubprogram();
1422
1423 if (D.isCompileUnit())
1424 return DISubprogram();
1425
1426 if (D.isSubprogram())
1427 return DISubprogram(N);
1428
1429 if (D.isLexicalBlock())
1430 return getDISubprogram(DILexicalBlock(N).getContext().getNode());
1431
1432 llvm_unreachable("Unexpected Descriptor!");
1433}
1434
1435DIE *DwarfDebug::UpdateSubprogramScopeDIE(MDNode *SPNode) {
1436
1437 DIE *SPDie = ModuleCU->getDieMapSlotFor(SPNode);
1438 assert (SPDie && "Unable to find subprogram DIE!");
1439 AddLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1440 DWLabel("func_begin", SubprogramCount));
1441 AddLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1442 DWLabel("func_end", SubprogramCount));
1443 MachineLocation Location(RI->getFrameRegister(*MF));
1444 AddAddress(SPDie, dwarf::DW_AT_frame_base, Location);
1445
1446 if (!DISubprogram(SPNode).isLocalToUnit())
1447 AddUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1448
1449 // If there are global variables at this scope then add their dies.
1450 for (SmallVector<WeakVH, 4>::iterator SGI = ScopedGVs.begin(),
1451 SGE = ScopedGVs.end(); SGI != SGE; ++SGI) {
1452 MDNode *N = dyn_cast_or_null<MDNode>(*SGI);
1453 if (!N) continue;
1454 DIGlobalVariable GV(N);
1455 if (GV.getContext().getNode() == SPNode) {
1456 DIE *ScopedGVDie = CreateGlobalVariableDIE(ModuleCU, GV);
Devang Patelfb0ee432009-11-10 23:20:04 +00001457 if (ScopedGVDie)
1458 SPDie->AddChild(ScopedGVDie);
Devang Patel53bb5c92009-11-10 23:06:00 +00001459 }
1460 }
1461 return SPDie;
1462}
1463
1464DIE *DwarfDebug::ConstructLexicalScopeDIE(DbgScope *Scope) {
1465 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1466 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
1467
1468 // Ignore empty scopes.
1469 if (StartID == EndID && StartID != 0)
1470 return NULL;
1471
1472 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
1473 if (Scope->isAbstractScope())
1474 return ScopeDIE;
1475
1476 AddLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1477 StartID ?
1478 DWLabel("label", StartID)
1479 : DWLabel("func_begin", SubprogramCount));
1480 AddLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1481 EndID ?
1482 DWLabel("label", EndID)
1483 : DWLabel("func_end", SubprogramCount));
1484
1485
1486
1487 return ScopeDIE;
1488}
1489
1490DIE *DwarfDebug::ConstructInlinedScopeDIE(DbgScope *Scope) {
1491 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1492 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
1493 assert (StartID && "Invalid starting label for an inlined scope!");
1494 assert (EndID && "Invalid end label for an inlined scope!");
1495 // Ignore empty scopes.
1496 if (StartID == EndID && StartID != 0)
1497 return NULL;
1498
1499 DIScope DS(Scope->getScopeNode());
1500 if (DS.isNull())
1501 return NULL;
1502 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
1503
1504 DISubprogram InlinedSP = getDISubprogram(DS.getNode());
1505 DIE *&OriginDIE = ModuleCU->getDieMapSlotFor(InlinedSP.getNode());
1506 assert (OriginDIE && "Unable to find Origin DIE!");
1507 AddDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
1508 dwarf::DW_FORM_ref4, OriginDIE);
1509
1510 AddLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1511 DWLabel("label", StartID));
1512 AddLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1513 DWLabel("label", EndID));
1514
1515 InlinedSubprogramDIEs.insert(OriginDIE);
1516
1517 // Track the start label for this inlined function.
1518 ValueMap<MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
1519 I = InlineInfo.find(InlinedSP.getNode());
1520
1521 if (I == InlineInfo.end()) {
1522 InlineInfo[InlinedSP.getNode()].push_back(std::make_pair(StartID, ScopeDIE));
1523 InlinedSPNodes.push_back(InlinedSP.getNode());
1524 } else
1525 I->second.push_back(std::make_pair(StartID, ScopeDIE));
1526
1527 StringPool.insert(InlinedSP.getName());
1528 StringPool.insert(InlinedSP.getLinkageName());
1529 DILocation DL(Scope->getInlinedAt());
1530 AddUInt(ScopeDIE, dwarf::DW_AT_call_file, 0, ModuleCU->getID());
1531 AddUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
1532
1533 return ScopeDIE;
1534}
1535
1536DIE *DwarfDebug::ConstructVariableDIE(DbgVariable *DV,
1537 DbgScope *Scope, CompileUnit *Unit) {
1538 // Get the descriptor.
1539 const DIVariable &VD = DV->getVariable();
1540
1541 // Translate tag to proper Dwarf tag. The result variable is dropped for
1542 // now.
1543 unsigned Tag;
1544 switch (VD.getTag()) {
1545 case dwarf::DW_TAG_return_variable:
1546 return NULL;
1547 case dwarf::DW_TAG_arg_variable:
1548 Tag = dwarf::DW_TAG_formal_parameter;
1549 break;
1550 case dwarf::DW_TAG_auto_variable: // fall thru
1551 default:
1552 Tag = dwarf::DW_TAG_variable;
1553 break;
1554 }
1555
1556 // Define variable debug information entry.
1557 DIE *VariableDie = new DIE(Tag);
1558
1559
1560 DIE *AbsDIE = NULL;
1561 if (DbgVariable *AV = DV->getAbstractVariable())
1562 AbsDIE = AV->getDIE();
1563
1564 if (AbsDIE) {
1565 DIScope DS(Scope->getScopeNode());
1566 DISubprogram InlinedSP = getDISubprogram(DS.getNode());
1567 DIE *&OriginSPDIE = ModuleCU->getDieMapSlotFor(InlinedSP.getNode());
Daniel Dunbarc0326792009-11-11 03:09:50 +00001568 (void) OriginSPDIE;
Devang Patel53bb5c92009-11-10 23:06:00 +00001569 assert (OriginSPDIE && "Unable to find Origin DIE for the SP!");
1570 DIE *AbsDIE = DV->getAbstractVariable()->getDIE();
1571 assert (AbsDIE && "Unable to find Origin DIE for the Variable!");
1572 AddDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
1573 dwarf::DW_FORM_ref4, AbsDIE);
1574 }
1575 else {
1576 const char *Name = VD.getName();
1577 AddString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
1578 AddSourceLine(VariableDie, &VD);
1579
1580 // Add variable type.
1581 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
1582 // addresses instead.
1583 if (VD.isBlockByrefVariable())
1584 AddType(Unit, VariableDie, GetBlockByrefType(VD.getType(), Name));
1585 else
1586 AddType(Unit, VariableDie, VD.getType());
1587 }
1588
1589 // Add variable address.
1590 if (!Scope->isAbstractScope()) {
1591 MachineLocation Location;
1592 Location.set(RI->getFrameRegister(*MF),
1593 RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
1594
1595
1596 if (VD.hasComplexAddress())
1597 AddComplexAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
1598 else if (VD.isBlockByrefVariable())
1599 AddBlockByrefAddress(DV, VariableDie, dwarf::DW_AT_location, Location);
1600 else
1601 AddAddress(VariableDie, dwarf::DW_AT_location, Location);
1602 }
1603 DV->setDIE(VariableDie);
1604 return VariableDie;
1605
1606}
1607DIE *DwarfDebug::ConstructScopeDIE(DbgScope *Scope) {
1608 if (!Scope)
1609 return NULL;
1610 DIScope DS(Scope->getScopeNode());
1611 if (DS.isNull())
1612 return NULL;
1613
1614 DIE *ScopeDIE = NULL;
1615 if (Scope->getInlinedAt())
1616 ScopeDIE = ConstructInlinedScopeDIE(Scope);
1617 else if (DS.isSubprogram()) {
1618 if (Scope->isAbstractScope())
1619 ScopeDIE = ModuleCU->getDieMapSlotFor(DS.getNode());
1620 else
1621 ScopeDIE = UpdateSubprogramScopeDIE(DS.getNode());
1622 }
1623 else {
1624 ScopeDIE = ConstructLexicalScopeDIE(Scope);
1625 if (!ScopeDIE) return NULL;
1626 }
1627
1628 // Add variables to scope.
1629 SmallVector<DbgVariable *, 8> &Variables = Scope->getVariables();
1630 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
1631 DIE *VariableDIE = ConstructVariableDIE(Variables[i], Scope, ModuleCU);
1632 if (VariableDIE)
1633 ScopeDIE->AddChild(VariableDIE);
1634 }
1635
1636 // Add nested scopes.
1637 SmallVector<DbgScope *, 4> &Scopes = Scope->getScopes();
1638 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1639 // Define the Scope debug information entry.
1640 DIE *NestedDIE = ConstructScopeDIE(Scopes[j]);
1641 if (NestedDIE)
1642 ScopeDIE->AddChild(NestedDIE);
1643 }
1644 return ScopeDIE;
1645}
1646
Bill Wendling0310d762009-05-15 09:23:25 +00001647/// ConstructDbgScope - Construct the components of a scope.
Devang Patel53bb5c92009-11-10 23:06:00 +00001648/// FIXME: Remove
Bill Wendling0310d762009-05-15 09:23:25 +00001649void DwarfDebug::ConstructDbgScope(DbgScope *ParentScope,
1650 unsigned ParentStartID,
1651 unsigned ParentEndID,
1652 DIE *ParentDie, CompileUnit *Unit) {
1653 // Add variables to scope.
1654 SmallVector<DbgVariable *, 8> &Variables = ParentScope->getVariables();
1655 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
Bill Wendling995f80a2009-05-20 23:24:48 +00001656 DIE *VariableDie = CreateDbgScopeVariable(Variables[i], Unit);
Bill Wendling0310d762009-05-15 09:23:25 +00001657 if (VariableDie) ParentDie->AddChild(VariableDie);
1658 }
1659
Bill Wendling0310d762009-05-15 09:23:25 +00001660 // Add nested scopes.
1661 SmallVector<DbgScope *, 4> &Scopes = ParentScope->getScopes();
1662 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1663 // Define the Scope debug information entry.
1664 DbgScope *Scope = Scopes[j];
1665
1666 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1667 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
1668
1669 // Ignore empty scopes.
1670 if (StartID == EndID && StartID != 0) continue;
1671
1672 // Do not ignore inlined scopes even if they don't have any variables or
1673 // scopes.
Devang Patel53bb5c92009-11-10 23:06:00 +00001674 if (Scope->getScopes().empty() && Scope->getVariables().empty())
Bill Wendling0310d762009-05-15 09:23:25 +00001675 continue;
1676
1677 if (StartID == ParentStartID && EndID == ParentEndID) {
1678 // Just add stuff to the parent scope.
1679 ConstructDbgScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
1680 } else {
1681 DIE *ScopeDie = new DIE(dwarf::DW_TAG_lexical_block);
1682
1683 // Add the scope bounds.
1684 if (StartID)
1685 AddLabel(ScopeDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1686 DWLabel("label", StartID));
1687 else
1688 AddLabel(ScopeDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1689 DWLabel("func_begin", SubprogramCount));
1690
1691 if (EndID)
1692 AddLabel(ScopeDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1693 DWLabel("label", EndID));
1694 else
1695 AddLabel(ScopeDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1696 DWLabel("func_end", SubprogramCount));
1697
1698 // Add the scope's contents.
1699 ConstructDbgScope(Scope, StartID, EndID, ScopeDie, Unit);
1700 ParentDie->AddChild(ScopeDie);
1701 }
1702 }
1703}
1704
Devang Patel53bb5c92009-11-10 23:06:00 +00001705/// ConstructCurrentFnDbgScope - Construct the scope for the subprogram.
1706/// FIXME: Remove
1707void DwarfDebug::ConstructCurrentFnDbgScope(DbgScope *RootScope,
Bill Wendling17956162009-05-20 23:28:48 +00001708 bool AbstractScope) {
Bill Wendling0310d762009-05-15 09:23:25 +00001709 // Exit if there is no root scope.
1710 if (!RootScope) return;
1711 DIDescriptor Desc = RootScope->getDesc();
1712 if (Desc.isNull())
1713 return;
1714
1715 // Get the subprogram debug information entry.
Devang Patele4b27562009-08-28 23:24:31 +00001716 DISubprogram SPD(Desc.getNode());
Bill Wendling0310d762009-05-15 09:23:25 +00001717
Bill Wendling0310d762009-05-15 09:23:25 +00001718 // Get the subprogram die.
Devang Patele4b27562009-08-28 23:24:31 +00001719 DIE *SPDie = ModuleCU->getDieMapSlotFor(SPD.getNode());
Devang Patelffd9c3d2009-10-05 23:59:00 +00001720 if (!SPDie) {
1721 ConstructSubprogram(SPD.getNode());
1722 SPDie = ModuleCU->getDieMapSlotFor(SPD.getNode());
1723 }
Bill Wendling0310d762009-05-15 09:23:25 +00001724 assert(SPDie && "Missing subprogram descriptor");
1725
Bill Wendling17956162009-05-20 23:28:48 +00001726 if (!AbstractScope) {
1727 // Add the function bounds.
1728 AddLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1729 DWLabel("func_begin", SubprogramCount));
1730 AddLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1731 DWLabel("func_end", SubprogramCount));
1732 MachineLocation Location(RI->getFrameRegister(*MF));
1733 AddAddress(SPDie, dwarf::DW_AT_frame_base, Location);
1734 }
Bill Wendling0310d762009-05-15 09:23:25 +00001735
Devang Patel1dbc7712009-06-29 20:45:18 +00001736 ConstructDbgScope(RootScope, 0, 0, SPDie, ModuleCU);
Devang Patelfd07cf52009-10-05 23:40:42 +00001737 // If there are global variables at this scope then add their dies.
1738 for (SmallVector<WeakVH, 4>::iterator SGI = ScopedGVs.begin(),
1739 SGE = ScopedGVs.end(); SGI != SGE; ++SGI) {
1740 MDNode *N = dyn_cast_or_null<MDNode>(*SGI);
1741 if (!N) continue;
1742 DIGlobalVariable GV(N);
1743 if (GV.getContext().getNode() == RootScope->getDesc().getNode()) {
1744 DIE *ScopedGVDie = CreateGlobalVariableDIE(ModuleCU, GV);
Devang Patel465c3be2009-11-06 01:30:04 +00001745 if (ScopedGVDie)
1746 SPDie->AddChild(ScopedGVDie);
Devang Patelfd07cf52009-10-05 23:40:42 +00001747 }
1748 }
Bill Wendling0310d762009-05-15 09:23:25 +00001749}
1750
Bill Wendling0310d762009-05-15 09:23:25 +00001751/// ConstructDefaultDbgScope - Construct a default scope for the subprogram.
Devang Patel53bb5c92009-11-10 23:06:00 +00001752/// FIXME: Remove
Bill Wendling0310d762009-05-15 09:23:25 +00001753void DwarfDebug::ConstructDefaultDbgScope(MachineFunction *MF) {
Devang Patel1dbc7712009-06-29 20:45:18 +00001754 StringMap<DIE*> &Globals = ModuleCU->getGlobals();
Daniel Dunbar460f6562009-07-26 09:48:23 +00001755 StringMap<DIE*>::iterator GI = Globals.find(MF->getFunction()->getName());
Devang Patel70f44262009-06-29 20:38:13 +00001756 if (GI != Globals.end()) {
1757 DIE *SPDie = GI->second;
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001758
Devang Patel70f44262009-06-29 20:38:13 +00001759 // Add the function bounds.
1760 AddLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1761 DWLabel("func_begin", SubprogramCount));
1762 AddLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1763 DWLabel("func_end", SubprogramCount));
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001764
Devang Patel70f44262009-06-29 20:38:13 +00001765 MachineLocation Location(RI->getFrameRegister(*MF));
1766 AddAddress(SPDie, dwarf::DW_AT_frame_base, Location);
Bill Wendling0310d762009-05-15 09:23:25 +00001767 }
Bill Wendling0310d762009-05-15 09:23:25 +00001768}
1769
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001770/// GetOrCreateSourceID - Look up the source id with the given directory and
1771/// source file names. If none currently exists, create a new id and insert it
1772/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1773/// maps as well.
Devang Patel5ccdd102009-09-29 18:40:58 +00001774unsigned DwarfDebug::GetOrCreateSourceID(const char *DirName,
1775 const char *FileName) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001776 unsigned DId;
1777 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
1778 if (DI != DirectoryIdMap.end()) {
1779 DId = DI->getValue();
1780 } else {
1781 DId = DirectoryNames.size() + 1;
1782 DirectoryIdMap[DirName] = DId;
1783 DirectoryNames.push_back(DirName);
1784 }
1785
1786 unsigned FId;
1787 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
1788 if (FI != SourceFileIdMap.end()) {
1789 FId = FI->getValue();
1790 } else {
1791 FId = SourceFileNames.size() + 1;
1792 SourceFileIdMap[FileName] = FId;
1793 SourceFileNames.push_back(FileName);
1794 }
1795
1796 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
1797 SourceIdMap.find(std::make_pair(DId, FId));
1798 if (SI != SourceIdMap.end())
1799 return SI->second;
1800
1801 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0.
1802 SourceIdMap[std::make_pair(DId, FId)] = SrcId;
1803 SourceIds.push_back(std::make_pair(DId, FId));
1804
1805 return SrcId;
1806}
1807
Devang Patele4b27562009-08-28 23:24:31 +00001808void DwarfDebug::ConstructCompileUnit(MDNode *N) {
1809 DICompileUnit DIUnit(N);
Devang Patel5ccdd102009-09-29 18:40:58 +00001810 const char *FN = DIUnit.getFilename();
1811 const char *Dir = DIUnit.getDirectory();
1812 unsigned ID = GetOrCreateSourceID(Dir, FN);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001813
1814 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
1815 AddSectionOffset(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
1816 DWLabel("section_line", 0), DWLabel("section_line", 0),
1817 false);
1818 AddString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
Devang Patel5ccdd102009-09-29 18:40:58 +00001819 DIUnit.getProducer());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001820 AddUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
1821 DIUnit.getLanguage());
1822 AddString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
1823
Devang Patel5ccdd102009-09-29 18:40:58 +00001824 if (Dir)
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001825 AddString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
1826 if (DIUnit.isOptimized())
1827 AddUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1828
Devang Patel5ccdd102009-09-29 18:40:58 +00001829 if (const char *Flags = DIUnit.getFlags())
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001830 AddString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
1831
1832 unsigned RVer = DIUnit.getRunTimeVersion();
1833 if (RVer)
1834 AddUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
1835 dwarf::DW_FORM_data1, RVer);
1836
1837 CompileUnit *Unit = new CompileUnit(ID, Die);
Devang Patel1dbc7712009-06-29 20:45:18 +00001838 if (!ModuleCU && DIUnit.isMain()) {
Devang Patel70f44262009-06-29 20:38:13 +00001839 // Use first compile unit marked as isMain as the compile unit
1840 // for this module.
Devang Patel1dbc7712009-06-29 20:45:18 +00001841 ModuleCU = Unit;
Devang Patel70f44262009-06-29 20:38:13 +00001842 }
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001843
Devang Patele4b27562009-08-28 23:24:31 +00001844 CompileUnitMap[DIUnit.getNode()] = Unit;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001845 CompileUnits.push_back(Unit);
1846}
1847
Devang Patele4b27562009-08-28 23:24:31 +00001848void DwarfDebug::ConstructGlobalVariableDIE(MDNode *N) {
1849 DIGlobalVariable DI_GV(N);
Daniel Dunbarf612ff62009-09-19 20:40:05 +00001850
Devang Patel905cf5e2009-09-04 23:59:07 +00001851 // If debug information is malformed then ignore it.
1852 if (DI_GV.Verify() == false)
1853 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001854
1855 // Check for pre-existence.
Devang Patele4b27562009-08-28 23:24:31 +00001856 DIE *&Slot = ModuleCU->getDieMapSlotFor(DI_GV.getNode());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001857 if (Slot)
Devang Patel13e16b62009-06-26 01:49:18 +00001858 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001859
Devang Patel1dbc7712009-06-29 20:45:18 +00001860 DIE *VariableDie = CreateGlobalVariableDIE(ModuleCU, DI_GV);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001861
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001862 // Add to map.
1863 Slot = VariableDie;
1864
1865 // Add to context owner.
Devang Patel1dbc7712009-06-29 20:45:18 +00001866 ModuleCU->getDie()->AddChild(VariableDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001867
1868 // Expose as global. FIXME - need to check external flag.
Devang Patel5ccdd102009-09-29 18:40:58 +00001869 ModuleCU->AddGlobal(DI_GV.getName(), VariableDie);
Devang Patel13e16b62009-06-26 01:49:18 +00001870 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001871}
1872
Devang Patele4b27562009-08-28 23:24:31 +00001873void DwarfDebug::ConstructSubprogram(MDNode *N) {
1874 DISubprogram SP(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001875
1876 // Check for pre-existence.
Devang Patele4b27562009-08-28 23:24:31 +00001877 DIE *&Slot = ModuleCU->getDieMapSlotFor(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001878 if (Slot)
Devang Patel13e16b62009-06-26 01:49:18 +00001879 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001880
1881 if (!SP.isDefinition())
1882 // This is a method declaration which will be handled while constructing
1883 // class type.
Devang Patel13e16b62009-06-26 01:49:18 +00001884 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001885
Devang Patel1dbc7712009-06-29 20:45:18 +00001886 DIE *SubprogramDie = CreateSubprogramDIE(ModuleCU, SP);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001887
1888 // Add to map.
1889 Slot = SubprogramDie;
1890
1891 // Add to context owner.
Devang Patel1dbc7712009-06-29 20:45:18 +00001892 ModuleCU->getDie()->AddChild(SubprogramDie);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001893
1894 // Expose as global.
Devang Patel5ccdd102009-09-29 18:40:58 +00001895 ModuleCU->AddGlobal(SP.getName(), SubprogramDie);
Devang Patel13e16b62009-06-26 01:49:18 +00001896 return;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001897}
1898
Daniel Dunbar00564992009-09-19 20:40:14 +00001899/// BeginModule - Emit all Dwarf sections that should come prior to the
1900/// content. Create global DIEs and emit initial debug info sections.
1901/// This is inovked by the target AsmPrinter.
Devang Patel208622d2009-06-25 22:36:02 +00001902void DwarfDebug::BeginModule(Module *M, MachineModuleInfo *mmi) {
1903 this->M = M;
1904
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001905 if (TimePassesIsEnabled)
1906 DebugTimer->startTimer();
1907
Devang Patel78ab9e22009-07-30 18:56:46 +00001908 DebugInfoFinder DbgFinder;
1909 DbgFinder.processModule(*M);
Devang Patel13e16b62009-06-26 01:49:18 +00001910
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001911 // Create all the compile unit DIEs.
Devang Patel78ab9e22009-07-30 18:56:46 +00001912 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
1913 E = DbgFinder.compile_unit_end(); I != E; ++I)
Devang Patel13e16b62009-06-26 01:49:18 +00001914 ConstructCompileUnit(*I);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001915
1916 if (CompileUnits.empty()) {
1917 if (TimePassesIsEnabled)
1918 DebugTimer->stopTimer();
1919
1920 return;
1921 }
1922
Devang Patel70f44262009-06-29 20:38:13 +00001923 // If main compile unit for this module is not seen than randomly
1924 // select first compile unit.
Devang Patel1dbc7712009-06-29 20:45:18 +00001925 if (!ModuleCU)
1926 ModuleCU = CompileUnits[0];
Devang Patel70f44262009-06-29 20:38:13 +00001927
Devang Patel13e16b62009-06-26 01:49:18 +00001928 // Create DIEs for each of the externally visible global variables.
Devang Patel78ab9e22009-07-30 18:56:46 +00001929 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
Devang Patelfd07cf52009-10-05 23:40:42 +00001930 E = DbgFinder.global_variable_end(); I != E; ++I) {
1931 DIGlobalVariable GV(*I);
1932 if (GV.getContext().getNode() != GV.getCompileUnit().getNode())
1933 ScopedGVs.push_back(*I);
1934 else
1935 ConstructGlobalVariableDIE(*I);
1936 }
Devang Patel13e16b62009-06-26 01:49:18 +00001937
Devang Patel53bb5c92009-11-10 23:06:00 +00001938 // Create DIEs for each subprogram.
Devang Patel78ab9e22009-07-30 18:56:46 +00001939 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
1940 E = DbgFinder.subprogram_end(); I != E; ++I)
Devang Patel13e16b62009-06-26 01:49:18 +00001941 ConstructSubprogram(*I);
1942
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001943 MMI = mmi;
1944 shouldEmit = true;
1945 MMI->setDebugInfoAvailability(true);
1946
1947 // Prime section data.
Chris Lattnerf0144122009-07-28 03:13:23 +00001948 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001949
1950 // Print out .file directives to specify files for .loc directives. These are
1951 // printed out early so that they precede any .loc directives.
Chris Lattner33adcfb2009-08-22 21:43:10 +00001952 if (MAI->hasDotLocAndDotFile()) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001953 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
1954 // Remember source id starts at 1.
1955 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
1956 sys::Path FullPath(getSourceDirectoryName(Id.first));
1957 bool AppendOk =
1958 FullPath.appendComponent(getSourceFileName(Id.second));
1959 assert(AppendOk && "Could not append filename to directory!");
1960 AppendOk = false;
Chris Lattner74382b72009-08-23 22:45:37 +00001961 Asm->EmitFile(i, FullPath.str());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001962 Asm->EOL();
1963 }
1964 }
1965
1966 // Emit initial sections
1967 EmitInitial();
1968
1969 if (TimePassesIsEnabled)
1970 DebugTimer->stopTimer();
1971}
1972
1973/// EndModule - Emit all Dwarf sections that should come after the content.
1974///
1975void DwarfDebug::EndModule() {
Devang Patel6f3dc922009-10-06 00:03:14 +00001976 if (!ModuleCU)
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001977 return;
1978
1979 if (TimePassesIsEnabled)
1980 DebugTimer->startTimer();
1981
Devang Patel53bb5c92009-11-10 23:06:00 +00001982 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1983 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
1984 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
1985 DIE *ISP = *AI;
1986 AddUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
1987 }
1988
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001989 // Standard sections final addresses.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001990 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001991 EmitLabel("text_end", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001992 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001993 EmitLabel("data_end", 0);
1994
1995 // End text sections.
1996 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00001997 Asm->OutStreamer.SwitchSection(SectionMap[i]);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00001998 EmitLabel("section_end", i);
1999 }
2000
2001 // Emit common frame information.
2002 EmitCommonDebugFrame();
2003
2004 // Emit function debug frame information
2005 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2006 E = DebugFrames.end(); I != E; ++I)
2007 EmitFunctionDebugFrame(*I);
2008
2009 // Compute DIE offsets and sizes.
2010 SizeAndOffsets();
2011
2012 // Emit all the DIEs into a debug info section
2013 EmitDebugInfo();
2014
2015 // Corresponding abbreviations into a abbrev section.
2016 EmitAbbreviations();
2017
2018 // Emit source line correspondence into a debug line section.
2019 EmitDebugLines();
2020
2021 // Emit info into a debug pubnames section.
2022 EmitDebugPubNames();
2023
2024 // Emit info into a debug str section.
2025 EmitDebugStr();
2026
2027 // Emit info into a debug loc section.
2028 EmitDebugLoc();
2029
2030 // Emit info into a debug aranges section.
2031 EmitDebugARanges();
2032
2033 // Emit info into a debug ranges section.
2034 EmitDebugRanges();
2035
2036 // Emit info into a debug macinfo section.
2037 EmitDebugMacInfo();
2038
2039 // Emit inline info.
2040 EmitDebugInlineInfo();
2041
2042 if (TimePassesIsEnabled)
2043 DebugTimer->stopTimer();
2044}
2045
Devang Patel53bb5c92009-11-10 23:06:00 +00002046/// findAbstractVariable - Find abstract variable, if any, associated with Var.
2047DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &Var, unsigned FrameIdx,
2048 DILocation &ScopeLoc) {
2049
2050 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var.getNode());
2051 if (AbsDbgVariable)
2052 return AbsDbgVariable;
2053
2054 DbgScope *Scope = AbstractScopes.lookup(ScopeLoc.getScope().getNode());
2055 if (!Scope)
2056 return NULL;
2057
2058 AbsDbgVariable = new DbgVariable(Var, FrameIdx);
2059 Scope->AddVariable(AbsDbgVariable);
2060 AbstractVariables[Var.getNode()] = AbsDbgVariable;
2061 return AbsDbgVariable;
2062}
2063
Devang Patele717faa2009-10-06 01:26:37 +00002064/// CollectVariableInfo - Populate DbgScope entries with variables' info.
Devang Patelac1ceb32009-10-09 22:42:28 +00002065void DwarfDebug::CollectVariableInfo() {
2066 if (!MMI) return;
Devang Patel53bb5c92009-11-10 23:06:00 +00002067
Devang Patele717faa2009-10-06 01:26:37 +00002068 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
2069 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
2070 VE = VMap.end(); VI != VE; ++VI) {
Devang Patelac1ceb32009-10-09 22:42:28 +00002071 MetadataBase *MB = VI->first;
2072 MDNode *Var = dyn_cast_or_null<MDNode>(MB);
Devang Patel53bb5c92009-11-10 23:06:00 +00002073 if (!Var) continue;
Devang Pateleda31212009-10-08 18:48:03 +00002074 DIVariable DV (Var);
Devang Patel53bb5c92009-11-10 23:06:00 +00002075 std::pair< unsigned, MDNode *> VP = VI->second;
2076 DILocation ScopeLoc(VP.second);
2077
2078 DbgScope *Scope =
2079 ConcreteScopes.lookup(ScopeLoc.getOrigLocation().getNode());
2080 if (!Scope)
2081 Scope = DbgScopeMap.lookup(ScopeLoc.getScope().getNode());
Devang Patelfb0ee432009-11-10 23:20:04 +00002082 // If variable scope is not found then skip this variable.
2083 if (!Scope)
2084 continue;
Devang Patel53bb5c92009-11-10 23:06:00 +00002085
2086 DbgVariable *RegVar = new DbgVariable(DV, VP.first);
2087 Scope->AddVariable(RegVar);
2088 if (DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.first, ScopeLoc))
2089 RegVar->setAbstractVariable(AbsDbgVariable);
Devang Patele717faa2009-10-06 01:26:37 +00002090 }
2091}
2092
Devang Patel53bb5c92009-11-10 23:06:00 +00002093/// BeginScope - Process beginning of a scope starting at Label.
2094void DwarfDebug::BeginScope(const MachineInstr *MI, unsigned Label) {
Devang Patel0d20ac82009-10-06 01:50:42 +00002095 InsnToDbgScopeMapTy::iterator I = DbgScopeBeginMap.find(MI);
2096 if (I == DbgScopeBeginMap.end())
2097 return;
Devang Patel53bb5c92009-11-10 23:06:00 +00002098 ScopeVector &SD = DbgScopeBeginMap[MI];
2099 for (ScopeVector::iterator SDI = SD.begin(), SDE = SD.end();
Devang Patel0d20ac82009-10-06 01:50:42 +00002100 SDI != SDE; ++SDI)
2101 (*SDI)->setStartLabelID(Label);
2102}
2103
Devang Patel53bb5c92009-11-10 23:06:00 +00002104/// EndScope - Process end of a scope.
2105void DwarfDebug::EndScope(const MachineInstr *MI) {
Devang Patel0d20ac82009-10-06 01:50:42 +00002106 InsnToDbgScopeMapTy::iterator I = DbgScopeEndMap.find(MI);
Devang Patel8a4087d2009-10-06 03:15:38 +00002107 if (I == DbgScopeEndMap.end())
Devang Patel0d20ac82009-10-06 01:50:42 +00002108 return;
Devang Patel53bb5c92009-11-10 23:06:00 +00002109
2110 unsigned Label = MMI->NextLabelID();
2111 Asm->printLabel(Label);
2112
Devang Patel0d20ac82009-10-06 01:50:42 +00002113 SmallVector<DbgScope *, 2> &SD = I->second;
2114 for (SmallVector<DbgScope *, 2>::iterator SDI = SD.begin(), SDE = SD.end();
2115 SDI != SDE; ++SDI)
2116 (*SDI)->setEndLabelID(Label);
Devang Patel53bb5c92009-11-10 23:06:00 +00002117 return;
2118}
2119
2120/// createDbgScope - Create DbgScope for the scope.
2121void DwarfDebug::createDbgScope(MDNode *Scope, MDNode *InlinedAt) {
2122
2123 if (!InlinedAt) {
2124 DbgScope *WScope = DbgScopeMap.lookup(Scope);
2125 if (WScope)
2126 return;
2127 WScope = new DbgScope(NULL, DIDescriptor(Scope), NULL);
2128 DbgScopeMap.insert(std::make_pair(Scope, WScope));
Devang Patel2f105c62009-11-11 00:18:40 +00002129 if (DIDescriptor(Scope).isLexicalBlock())
2130 createDbgScope(DILexicalBlock(Scope).getContext().getNode(), NULL);
Devang Patel53bb5c92009-11-10 23:06:00 +00002131 return;
2132 }
2133
2134 DbgScope *WScope = DbgScopeMap.lookup(InlinedAt);
2135 if (WScope)
2136 return;
2137
2138 WScope = new DbgScope(NULL, DIDescriptor(Scope), InlinedAt);
2139 DbgScopeMap.insert(std::make_pair(InlinedAt, WScope));
2140 DILocation DL(InlinedAt);
2141 createDbgScope(DL.getScope().getNode(), DL.getOrigLocation().getNode());
Devang Patel0d20ac82009-10-06 01:50:42 +00002142}
2143
Devang Patelaf9e8472009-10-01 20:31:14 +00002144/// ExtractScopeInformation - Scan machine instructions in this function
2145/// and collect DbgScopes. Return true, if atleast one scope was found.
2146bool DwarfDebug::ExtractScopeInformation(MachineFunction *MF) {
2147 // If scope information was extracted using .dbg intrinsics then there is not
2148 // any need to extract these information by scanning each instruction.
2149 if (!DbgScopeMap.empty())
2150 return false;
2151
Devang Patel53bb5c92009-11-10 23:06:00 +00002152 // Scan each instruction and create scopes. First build working set of scopes.
Devang Patelaf9e8472009-10-01 20:31:14 +00002153 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2154 I != E; ++I) {
2155 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2156 II != IE; ++II) {
2157 const MachineInstr *MInsn = II;
2158 DebugLoc DL = MInsn->getDebugLoc();
Devang Patel53bb5c92009-11-10 23:06:00 +00002159 if (DL.isUnknown()) continue;
Devang Patelaf9e8472009-10-01 20:31:14 +00002160 DebugLocTuple DLT = MF->getDebugLocTuple(DL);
Devang Patel53bb5c92009-11-10 23:06:00 +00002161 if (!DLT.Scope) continue;
Devang Patelaf9e8472009-10-01 20:31:14 +00002162 // There is no need to create another DIE for compile unit. For all
2163 // other scopes, create one DbgScope now. This will be translated
2164 // into a scope DIE at the end.
Devang Patel53bb5c92009-11-10 23:06:00 +00002165 if (DIDescriptor(DLT.Scope).isCompileUnit()) continue;
2166 createDbgScope(DLT.Scope, DLT.InlinedAtLoc);
2167 }
2168 }
2169
2170
2171 // Build scope hierarchy using working set of scopes.
2172 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
2173 I != E; ++I) {
2174 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
2175 II != IE; ++II) {
2176 const MachineInstr *MInsn = II;
2177 DebugLoc DL = MInsn->getDebugLoc();
2178 if (DL.isUnknown()) continue;
2179 DebugLocTuple DLT = MF->getDebugLocTuple(DL);
2180 if (!DLT.Scope) continue;
2181 // There is no need to create another DIE for compile unit. For all
2182 // other scopes, create one DbgScope now. This will be translated
2183 // into a scope DIE at the end.
2184 if (DIDescriptor(DLT.Scope).isCompileUnit()) continue;
2185 DbgScope *Scope = getUpdatedDbgScope(DLT.Scope, MInsn, DLT.InlinedAtLoc);
2186 Scope->setLastInsn(MInsn);
Devang Patelaf9e8472009-10-01 20:31:14 +00002187 }
2188 }
2189
2190 // If a scope's last instruction is not set then use its child scope's
2191 // last instruction as this scope's last instrunction.
Devang Patelbdf45cb2009-10-27 20:47:17 +00002192 for (ValueMap<MDNode *, DbgScope *>::iterator DI = DbgScopeMap.begin(),
Devang Patelaf9e8472009-10-01 20:31:14 +00002193 DE = DbgScopeMap.end(); DI != DE; ++DI) {
Devang Patel53bb5c92009-11-10 23:06:00 +00002194 if (DI->second->isAbstractScope())
2195 continue;
Devang Patelaf9e8472009-10-01 20:31:14 +00002196 assert (DI->second->getFirstInsn() && "Invalid first instruction!");
2197 DI->second->FixInstructionMarkers();
2198 assert (DI->second->getLastInsn() && "Invalid last instruction!");
2199 }
2200
2201 // Each scope has first instruction and last instruction to mark beginning
2202 // and end of a scope respectively. Create an inverse map that list scopes
2203 // starts (and ends) with an instruction. One instruction may start (or end)
2204 // multiple scopes.
Devang Patelbdf45cb2009-10-27 20:47:17 +00002205 for (ValueMap<MDNode *, DbgScope *>::iterator DI = DbgScopeMap.begin(),
Devang Patelaf9e8472009-10-01 20:31:14 +00002206 DE = DbgScopeMap.end(); DI != DE; ++DI) {
2207 DbgScope *S = DI->second;
Devang Patel53bb5c92009-11-10 23:06:00 +00002208 if (S->isAbstractScope())
2209 continue;
Devang Patelaf9e8472009-10-01 20:31:14 +00002210 const MachineInstr *MI = S->getFirstInsn();
2211 assert (MI && "DbgScope does not have first instruction!");
2212
2213 InsnToDbgScopeMapTy::iterator IDI = DbgScopeBeginMap.find(MI);
2214 if (IDI != DbgScopeBeginMap.end())
2215 IDI->second.push_back(S);
2216 else
Devang Patel53bb5c92009-11-10 23:06:00 +00002217 DbgScopeBeginMap[MI].push_back(S);
Devang Patelaf9e8472009-10-01 20:31:14 +00002218
2219 MI = S->getLastInsn();
2220 assert (MI && "DbgScope does not have last instruction!");
2221 IDI = DbgScopeEndMap.find(MI);
2222 if (IDI != DbgScopeEndMap.end())
2223 IDI->second.push_back(S);
2224 else
Devang Patel53bb5c92009-11-10 23:06:00 +00002225 DbgScopeEndMap[MI].push_back(S);
Devang Patelaf9e8472009-10-01 20:31:14 +00002226 }
2227
2228 return !DbgScopeMap.empty();
2229}
2230
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002231/// BeginFunction - Gather pre-function debug information. Assumes being
2232/// emitted immediately after the function entry point.
2233void DwarfDebug::BeginFunction(MachineFunction *MF) {
2234 this->MF = MF;
2235
2236 if (!ShouldEmitDwarfDebug()) return;
2237
2238 if (TimePassesIsEnabled)
2239 DebugTimer->startTimer();
2240
Devang Patel60b35bd2009-10-06 18:37:31 +00002241#ifdef ATTACH_DEBUG_INFO_TO_AN_INSN
2242 if (!ExtractScopeInformation(MF))
2243 return;
Devang Patelac1ceb32009-10-09 22:42:28 +00002244 CollectVariableInfo();
Devang Patel60b35bd2009-10-06 18:37:31 +00002245#endif
2246
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002247 // Begin accumulating function debug information.
2248 MMI->BeginFunction(MF);
2249
2250 // Assumes in correct section after the entry point.
2251 EmitLabel("func_begin", ++SubprogramCount);
2252
2253 // Emit label for the implicitly defined dbg.stoppoint at the start of the
2254 // function.
Devang Pateleda31212009-10-08 18:48:03 +00002255#ifdef ATTACH_DEBUG_INFO_TO_AN_INSN
Devang Patelac1ceb32009-10-09 22:42:28 +00002256 DebugLoc FDL = MF->getDefaultDebugLoc();
2257 if (!FDL.isUnknown()) {
2258 DebugLocTuple DLT = MF->getDebugLocTuple(FDL);
2259 unsigned LabelID = 0;
Devang Patel1619dc32009-10-13 23:28:53 +00002260 DISubprogram SP = getDISubprogram(DLT.Scope);
Devang Patelac1ceb32009-10-09 22:42:28 +00002261 if (!SP.isNull())
Devang Patel1619dc32009-10-13 23:28:53 +00002262 LabelID = RecordSourceLine(SP.getLineNumber(), 0, DLT.Scope);
Devang Patelac1ceb32009-10-09 22:42:28 +00002263 else
Devang Patel1619dc32009-10-13 23:28:53 +00002264 LabelID = RecordSourceLine(DLT.Line, DLT.Col, DLT.Scope);
Devang Patelac1ceb32009-10-09 22:42:28 +00002265 Asm->printLabel(LabelID);
2266 O << '\n';
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002267 }
Devang Patelac1ceb32009-10-09 22:42:28 +00002268#else
2269 DebugLoc FDL = MF->getDefaultDebugLoc();
2270 if (!FDL.isUnknown()) {
2271 DebugLocTuple DLT = MF->getDebugLocTuple(FDL);
Devang Patel1619dc32009-10-13 23:28:53 +00002272 unsigned LabelID = RecordSourceLine(DLT.Line, DLT.Col, DLT.Scope);
Devang Patelac1ceb32009-10-09 22:42:28 +00002273 Asm->printLabel(LabelID);
2274 O << '\n';
2275 }
2276#endif
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002277 if (TimePassesIsEnabled)
2278 DebugTimer->stopTimer();
2279}
2280
2281/// EndFunction - Gather and emit post-function debug information.
2282///
2283void DwarfDebug::EndFunction(MachineFunction *MF) {
2284 if (!ShouldEmitDwarfDebug()) return;
2285
2286 if (TimePassesIsEnabled)
2287 DebugTimer->startTimer();
2288
Devang Patelac1ceb32009-10-09 22:42:28 +00002289#ifdef ATTACH_DEBUG_INFO_TO_AN_INSN
2290 if (DbgScopeMap.empty())
2291 return;
2292#endif
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002293 // Define end label for subprogram.
2294 EmitLabel("func_end", SubprogramCount);
2295
2296 // Get function line info.
2297 if (!Lines.empty()) {
2298 // Get section line info.
Chris Lattner290c2f52009-08-03 23:20:21 +00002299 unsigned ID = SectionMap.insert(Asm->getCurrentSection());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002300 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2301 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2302 // Append the function info to section info.
2303 SectionLineInfos.insert(SectionLineInfos.end(),
2304 Lines.begin(), Lines.end());
2305 }
2306
Devang Patel53bb5c92009-11-10 23:06:00 +00002307#ifndef ATTACH_DEBUG_INFO_TO_AN_INSN
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002308 // Construct scopes for subprogram.
Devang Patel53bb5c92009-11-10 23:06:00 +00002309 if (CurrentFnDbgScope)
2310 ConstructCurrentFnDbgScope(CurrentFnDbgScope);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002311 else
2312 // FIXME: This is wrong. We are essentially getting past a problem with
2313 // debug information not being able to handle unreachable blocks that have
2314 // debug information in them. In particular, those unreachable blocks that
2315 // have "region end" info in them. That situation results in the "root
2316 // scope" not being created. If that's the case, then emit a "default"
2317 // scope, i.e., one that encompasses the whole function. This isn't
2318 // desirable. And a better way of handling this (and all of the debugging
2319 // information) needs to be explored.
2320 ConstructDefaultDbgScope(MF);
Devang Patel53bb5c92009-11-10 23:06:00 +00002321#else
2322 // Construct abstract scopes.
2323 for (SmallVector<DbgScope *, 4>::iterator AI = AbstractScopesList.begin(),
2324 AE = AbstractScopesList.end(); AI != AE; ++AI)
2325 ConstructScopeDIE(*AI);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002326
Devang Patel53bb5c92009-11-10 23:06:00 +00002327 ConstructScopeDIE(CurrentFnDbgScope);
2328#endif
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002329 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
2330 MMI->getFrameMoves()));
2331
2332 // Clear debug info
Devang Patel53bb5c92009-11-10 23:06:00 +00002333 if (CurrentFnDbgScope) {
2334 CurrentFnDbgScope = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002335 DbgScopeMap.clear();
Devang Patelaf9e8472009-10-01 20:31:14 +00002336 DbgScopeBeginMap.clear();
2337 DbgScopeEndMap.clear();
Devang Patel53bb5c92009-11-10 23:06:00 +00002338 ConcreteScopes.clear();
2339 AbstractScopesList.clear();
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002340 }
2341
2342 Lines.clear();
2343
2344 if (TimePassesIsEnabled)
2345 DebugTimer->stopTimer();
2346}
2347
2348/// RecordSourceLine - Records location information and associates it with a
2349/// label. Returns a unique label ID used to generate a label and provide
2350/// correspondence to the source line list.
Devang Patel3d910832009-09-30 22:51:28 +00002351unsigned DwarfDebug::RecordSourceLine(unsigned Line, unsigned Col,
Devang Patelf84548d2009-10-05 18:03:19 +00002352 MDNode *S) {
Devang Patele4b27562009-08-28 23:24:31 +00002353 if (!MMI)
2354 return 0;
2355
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002356 if (TimePassesIsEnabled)
2357 DebugTimer->startTimer();
2358
Devang Patelf84548d2009-10-05 18:03:19 +00002359 const char *Dir = NULL;
2360 const char *Fn = NULL;
2361
2362 DIDescriptor Scope(S);
2363 if (Scope.isCompileUnit()) {
2364 DICompileUnit CU(S);
2365 Dir = CU.getDirectory();
2366 Fn = CU.getFilename();
2367 } else if (Scope.isSubprogram()) {
2368 DISubprogram SP(S);
2369 Dir = SP.getDirectory();
2370 Fn = SP.getFilename();
2371 } else if (Scope.isLexicalBlock()) {
2372 DILexicalBlock DB(S);
2373 Dir = DB.getDirectory();
2374 Fn = DB.getFilename();
2375 } else
2376 assert (0 && "Unexpected scope info");
2377
2378 unsigned Src = GetOrCreateSourceID(Dir, Fn);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002379 unsigned ID = MMI->NextLabelID();
2380 Lines.push_back(SrcLineInfo(Line, Col, Src, ID));
2381
2382 if (TimePassesIsEnabled)
2383 DebugTimer->stopTimer();
2384
2385 return ID;
2386}
2387
2388/// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be
2389/// timed. Look up the source id with the given directory and source file
2390/// names. If none currently exists, create a new id and insert it in the
2391/// SourceIds map. This can update DirectoryNames and SourceFileNames maps as
2392/// well.
2393unsigned DwarfDebug::getOrCreateSourceID(const std::string &DirName,
2394 const std::string &FileName) {
2395 if (TimePassesIsEnabled)
2396 DebugTimer->startTimer();
2397
Devang Patel5ccdd102009-09-29 18:40:58 +00002398 unsigned SrcId = GetOrCreateSourceID(DirName.c_str(), FileName.c_str());
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002399
2400 if (TimePassesIsEnabled)
2401 DebugTimer->stopTimer();
2402
2403 return SrcId;
2404}
2405
2406/// RecordRegionStart - Indicate the start of a region.
Devang Patele4b27562009-08-28 23:24:31 +00002407unsigned DwarfDebug::RecordRegionStart(MDNode *N) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002408 if (TimePassesIsEnabled)
2409 DebugTimer->startTimer();
2410
Devang Patele4b27562009-08-28 23:24:31 +00002411 DbgScope *Scope = getOrCreateScope(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002412 unsigned ID = MMI->NextLabelID();
2413 if (!Scope->getStartLabelID()) Scope->setStartLabelID(ID);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002414
2415 if (TimePassesIsEnabled)
2416 DebugTimer->stopTimer();
2417
2418 return ID;
2419}
2420
2421/// RecordRegionEnd - Indicate the end of a region.
Devang Patele4b27562009-08-28 23:24:31 +00002422unsigned DwarfDebug::RecordRegionEnd(MDNode *N) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002423 if (TimePassesIsEnabled)
2424 DebugTimer->startTimer();
2425
Devang Patele4b27562009-08-28 23:24:31 +00002426 DbgScope *Scope = getOrCreateScope(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002427 unsigned ID = MMI->NextLabelID();
2428 Scope->setEndLabelID(ID);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002429
2430 if (TimePassesIsEnabled)
2431 DebugTimer->stopTimer();
2432
2433 return ID;
2434}
2435
2436/// RecordVariable - Indicate the declaration of a local variable.
Devang Patele4b27562009-08-28 23:24:31 +00002437void DwarfDebug::RecordVariable(MDNode *N, unsigned FrameIndex) {
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002438 if (TimePassesIsEnabled)
2439 DebugTimer->startTimer();
2440
Devang Patele4b27562009-08-28 23:24:31 +00002441 DIDescriptor Desc(N);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002442 DbgScope *Scope = NULL;
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002443
Devang Patele4b27562009-08-28 23:24:31 +00002444 if (Desc.getTag() == dwarf::DW_TAG_variable)
2445 Scope = getOrCreateScope(DIGlobalVariable(N).getContext().getNode());
2446 else {
Devang Patele4b27562009-08-28 23:24:31 +00002447 MDNode *Context = DIVariable(N).getContext().getNode();
Devang Patel53bb5c92009-11-10 23:06:00 +00002448 Scope = getOrCreateScope(Context);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002449 }
2450
2451 assert(Scope && "Unable to find the variable's scope");
Devang Patel53bb5c92009-11-10 23:06:00 +00002452 DbgVariable *DV = new DbgVariable(DIVariable(N), FrameIndex);
Bill Wendlingf0fb9872009-05-20 23:19:06 +00002453 Scope->AddVariable(DV);
2454
2455 if (TimePassesIsEnabled)
2456 DebugTimer->stopTimer();
2457}
2458
Bill Wendling829e67b2009-05-20 23:22:40 +00002459//===----------------------------------------------------------------------===//
2460// Emit Methods
2461//===----------------------------------------------------------------------===//
2462
Bill Wendling94d04b82009-05-20 23:21:38 +00002463/// SizeAndOffsetDie - Compute the size and offset of a DIE.
2464///
2465unsigned DwarfDebug::SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2466 // Get the children.
2467 const std::vector<DIE *> &Children = Die->getChildren();
2468
2469 // If not last sibling and has children then add sibling offset attribute.
2470 if (!Last && !Children.empty()) Die->AddSiblingOffset();
2471
2472 // Record the abbreviation.
2473 AssignAbbrevNumber(Die->getAbbrev());
2474
2475 // Get the abbreviation for this DIE.
2476 unsigned AbbrevNumber = Die->getAbbrevNumber();
2477 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2478
2479 // Set DIE offset
2480 Die->setOffset(Offset);
2481
2482 // Start the size with the size of abbreviation code.
Chris Lattneraf76e592009-08-22 20:48:53 +00002483 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
Bill Wendling94d04b82009-05-20 23:21:38 +00002484
2485 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2486 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2487
2488 // Size the DIE attribute values.
2489 for (unsigned i = 0, N = Values.size(); i < N; ++i)
2490 // Size attribute value.
2491 Offset += Values[i]->SizeOf(TD, AbbrevData[i].getForm());
2492
2493 // Size the DIE children if any.
2494 if (!Children.empty()) {
2495 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
2496 "Children flag not set");
2497
2498 for (unsigned j = 0, M = Children.size(); j < M; ++j)
2499 Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2500
2501 // End of children marker.
2502 Offset += sizeof(int8_t);
2503 }
2504
2505 Die->setSize(Offset - Die->getOffset());
2506 return Offset;
2507}
2508
2509/// SizeAndOffsets - Compute the size and offset of all the DIEs.
2510///
2511void DwarfDebug::SizeAndOffsets() {
2512 // Compute size of compile unit header.
2513 static unsigned Offset =
2514 sizeof(int32_t) + // Length of Compilation Unit Info
2515 sizeof(int16_t) + // DWARF version number
2516 sizeof(int32_t) + // Offset Into Abbrev. Section
2517 sizeof(int8_t); // Pointer Size (in bytes)
2518
Devang Patel1dbc7712009-06-29 20:45:18 +00002519 SizeAndOffsetDie(ModuleCU->getDie(), Offset, true);
2520 CompileUnitOffsets[ModuleCU] = 0;
Bill Wendling94d04b82009-05-20 23:21:38 +00002521}
2522
2523/// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
2524/// tools to recognize the object file contains Dwarf information.
2525void DwarfDebug::EmitInitial() {
2526 // Check to see if we already emitted intial headers.
2527 if (didInitial) return;
2528 didInitial = true;
2529
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002530 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
Daniel Dunbarf612ff62009-09-19 20:40:05 +00002531
Bill Wendling94d04b82009-05-20 23:21:38 +00002532 // Dwarf sections base addresses.
Chris Lattner33adcfb2009-08-22 21:43:10 +00002533 if (MAI->doesDwarfRequireFrameSection()) {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002534 Asm->OutStreamer.SwitchSection(TLOF.getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002535 EmitLabel("section_debug_frame", 0);
2536 }
2537
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002538 Asm->OutStreamer.SwitchSection(TLOF.getDwarfInfoSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002539 EmitLabel("section_info", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002540 Asm->OutStreamer.SwitchSection(TLOF.getDwarfAbbrevSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002541 EmitLabel("section_abbrev", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002542 Asm->OutStreamer.SwitchSection(TLOF.getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002543 EmitLabel("section_aranges", 0);
2544
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002545 if (const MCSection *LineInfoDirective = TLOF.getDwarfMacroInfoSection()) {
2546 Asm->OutStreamer.SwitchSection(LineInfoDirective);
Bill Wendling94d04b82009-05-20 23:21:38 +00002547 EmitLabel("section_macinfo", 0);
2548 }
2549
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002550 Asm->OutStreamer.SwitchSection(TLOF.getDwarfLineSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002551 EmitLabel("section_line", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002552 Asm->OutStreamer.SwitchSection(TLOF.getDwarfLocSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002553 EmitLabel("section_loc", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002554 Asm->OutStreamer.SwitchSection(TLOF.getDwarfPubNamesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002555 EmitLabel("section_pubnames", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002556 Asm->OutStreamer.SwitchSection(TLOF.getDwarfStrSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002557 EmitLabel("section_str", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002558 Asm->OutStreamer.SwitchSection(TLOF.getDwarfRangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002559 EmitLabel("section_ranges", 0);
2560
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002561 Asm->OutStreamer.SwitchSection(TLOF.getTextSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002562 EmitLabel("text_begin", 0);
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002563 Asm->OutStreamer.SwitchSection(TLOF.getDataSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002564 EmitLabel("data_begin", 0);
2565}
2566
2567/// EmitDIE - Recusively Emits a debug information entry.
2568///
2569void DwarfDebug::EmitDIE(DIE *Die) {
2570 // Get the abbreviation for this DIE.
2571 unsigned AbbrevNumber = Die->getAbbrevNumber();
2572 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2573
2574 Asm->EOL();
2575
2576 // Emit the code (index) for the abbreviation.
2577 Asm->EmitULEB128Bytes(AbbrevNumber);
2578
2579 if (Asm->isVerbose())
2580 Asm->EOL(std::string("Abbrev [" +
2581 utostr(AbbrevNumber) +
2582 "] 0x" + utohexstr(Die->getOffset()) +
2583 ":0x" + utohexstr(Die->getSize()) + " " +
2584 dwarf::TagString(Abbrev->getTag())));
2585 else
2586 Asm->EOL();
2587
2588 SmallVector<DIEValue*, 32> &Values = Die->getValues();
2589 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2590
2591 // Emit the DIE attribute values.
2592 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2593 unsigned Attr = AbbrevData[i].getAttribute();
2594 unsigned Form = AbbrevData[i].getForm();
2595 assert(Form && "Too many attributes for DIE (check abbreviation)");
2596
2597 switch (Attr) {
2598 case dwarf::DW_AT_sibling:
2599 Asm->EmitInt32(Die->SiblingOffset());
2600 break;
2601 case dwarf::DW_AT_abstract_origin: {
2602 DIEEntry *E = cast<DIEEntry>(Values[i]);
2603 DIE *Origin = E->getEntry();
Devang Patel53bb5c92009-11-10 23:06:00 +00002604 unsigned Addr = Origin->getOffset();
Bill Wendling94d04b82009-05-20 23:21:38 +00002605 Asm->EmitInt32(Addr);
2606 break;
2607 }
2608 default:
2609 // Emit an attribute using the defined form.
2610 Values[i]->EmitValue(this, Form);
2611 break;
2612 }
2613
2614 Asm->EOL(dwarf::AttributeString(Attr));
2615 }
2616
2617 // Emit the DIE children if any.
2618 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2619 const std::vector<DIE *> &Children = Die->getChildren();
2620
2621 for (unsigned j = 0, M = Children.size(); j < M; ++j)
2622 EmitDIE(Children[j]);
2623
2624 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2625 }
2626}
2627
2628/// EmitDebugInfo / EmitDebugInfoPerCU - Emit the debug info section.
2629///
2630void DwarfDebug::EmitDebugInfoPerCU(CompileUnit *Unit) {
2631 DIE *Die = Unit->getDie();
2632
2633 // Emit the compile units header.
2634 EmitLabel("info_begin", Unit->getID());
2635
2636 // Emit size of content not including length itself
2637 unsigned ContentSize = Die->getSize() +
2638 sizeof(int16_t) + // DWARF version number
2639 sizeof(int32_t) + // Offset Into Abbrev. Section
2640 sizeof(int8_t) + // Pointer Size (in bytes)
2641 sizeof(int32_t); // FIXME - extra pad for gdb bug.
2642
2643 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2644 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF version number");
2645 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2646 Asm->EOL("Offset Into Abbrev. Section");
2647 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2648
2649 EmitDIE(Die);
2650 // FIXME - extra padding for gdb bug.
2651 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2652 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2653 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2654 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2655 EmitLabel("info_end", Unit->getID());
2656
2657 Asm->EOL();
2658}
2659
2660void DwarfDebug::EmitDebugInfo() {
2661 // Start debug info section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002662 Asm->OutStreamer.SwitchSection(
2663 Asm->getObjFileLowering().getDwarfInfoSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002664
Devang Patel1dbc7712009-06-29 20:45:18 +00002665 EmitDebugInfoPerCU(ModuleCU);
Bill Wendling94d04b82009-05-20 23:21:38 +00002666}
2667
2668/// EmitAbbreviations - Emit the abbreviation section.
2669///
2670void DwarfDebug::EmitAbbreviations() const {
2671 // Check to see if it is worth the effort.
2672 if (!Abbreviations.empty()) {
2673 // Start the debug abbrev section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002674 Asm->OutStreamer.SwitchSection(
2675 Asm->getObjFileLowering().getDwarfAbbrevSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002676
2677 EmitLabel("abbrev_begin", 0);
2678
2679 // For each abbrevation.
2680 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2681 // Get abbreviation data
2682 const DIEAbbrev *Abbrev = Abbreviations[i];
2683
2684 // Emit the abbrevations code (base 1 index.)
2685 Asm->EmitULEB128Bytes(Abbrev->getNumber());
2686 Asm->EOL("Abbreviation Code");
2687
2688 // Emit the abbreviations data.
2689 Abbrev->Emit(Asm);
2690
2691 Asm->EOL();
2692 }
2693
2694 // Mark end of abbreviations.
2695 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2696
2697 EmitLabel("abbrev_end", 0);
2698 Asm->EOL();
2699 }
2700}
2701
2702/// EmitEndOfLineMatrix - Emit the last address of the section and the end of
2703/// the line matrix.
2704///
2705void DwarfDebug::EmitEndOfLineMatrix(unsigned SectionEnd) {
2706 // Define last address of section.
2707 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2708 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2709 Asm->EmitInt8(dwarf::DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2710 EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2711
2712 // Mark end of matrix.
2713 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2714 Asm->EmitULEB128Bytes(1); Asm->EOL();
2715 Asm->EmitInt8(1); Asm->EOL();
2716}
2717
2718/// EmitDebugLines - Emit source line information.
2719///
2720void DwarfDebug::EmitDebugLines() {
2721 // If the target is using .loc/.file, the assembler will be emitting the
2722 // .debug_line table automatically.
Chris Lattner33adcfb2009-08-22 21:43:10 +00002723 if (MAI->hasDotLocAndDotFile())
Bill Wendling94d04b82009-05-20 23:21:38 +00002724 return;
2725
2726 // Minimum line delta, thus ranging from -10..(255-10).
2727 const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
2728 // Maximum line delta, thus ranging from -10..(255-10).
2729 const int MaxLineDelta = 255 + MinLineDelta;
2730
2731 // Start the dwarf line section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002732 Asm->OutStreamer.SwitchSection(
2733 Asm->getObjFileLowering().getDwarfLineSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002734
2735 // Construct the section header.
2736 EmitDifference("line_end", 0, "line_begin", 0, true);
2737 Asm->EOL("Length of Source Line Info");
2738 EmitLabel("line_begin", 0);
2739
2740 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF version number");
2741
2742 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2743 Asm->EOL("Prolog Length");
2744 EmitLabel("line_prolog_begin", 0);
2745
2746 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2747
2748 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2749
2750 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
2751
2752 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2753
2754 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
2755
2756 // Line number standard opcode encodings argument count
2757 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2758 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2759 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2760 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2761 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2762 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2763 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2764 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2765 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2766
2767 // Emit directories.
2768 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
2769 Asm->EmitString(getSourceDirectoryName(DI));
2770 Asm->EOL("Directory");
2771 }
2772
2773 Asm->EmitInt8(0); Asm->EOL("End of directories");
2774
2775 // Emit files.
2776 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
2777 // Remember source id starts at 1.
2778 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
2779 Asm->EmitString(getSourceFileName(Id.second));
2780 Asm->EOL("Source");
2781 Asm->EmitULEB128Bytes(Id.first);
2782 Asm->EOL("Directory #");
2783 Asm->EmitULEB128Bytes(0);
2784 Asm->EOL("Mod date");
2785 Asm->EmitULEB128Bytes(0);
2786 Asm->EOL("File size");
2787 }
2788
2789 Asm->EmitInt8(0); Asm->EOL("End of files");
2790
2791 EmitLabel("line_prolog_end", 0);
2792
2793 // A sequence for each text section.
2794 unsigned SecSrcLinesSize = SectionSourceLines.size();
2795
2796 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
2797 // Isolate current sections line info.
2798 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
2799
Chris Lattner93b6db32009-08-08 23:39:42 +00002800 /*if (Asm->isVerbose()) {
Chris Lattnera87dea42009-07-31 18:48:30 +00002801 const MCSection *S = SectionMap[j + 1];
Chris Lattner33adcfb2009-08-22 21:43:10 +00002802 O << '\t' << MAI->getCommentString() << " Section"
Bill Wendling94d04b82009-05-20 23:21:38 +00002803 << S->getName() << '\n';
Chris Lattner93b6db32009-08-08 23:39:42 +00002804 }*/
2805 Asm->EOL();
Bill Wendling94d04b82009-05-20 23:21:38 +00002806
2807 // Dwarf assumes we start with first line of first source file.
2808 unsigned Source = 1;
2809 unsigned Line = 1;
2810
2811 // Construct rows of the address, source, line, column matrix.
2812 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2813 const SrcLineInfo &LineInfo = LineInfos[i];
2814 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2815 if (!LabelID) continue;
2816
Caroline Ticec6f9d622009-09-11 18:25:54 +00002817 if (LineInfo.getLine() == 0) continue;
2818
Bill Wendling94d04b82009-05-20 23:21:38 +00002819 if (!Asm->isVerbose())
2820 Asm->EOL();
2821 else {
2822 std::pair<unsigned, unsigned> SourceID =
2823 getSourceDirectoryAndFileIds(LineInfo.getSourceID());
Chris Lattner33adcfb2009-08-22 21:43:10 +00002824 O << '\t' << MAI->getCommentString() << ' '
Bill Wendling94d04b82009-05-20 23:21:38 +00002825 << getSourceDirectoryName(SourceID.first) << ' '
2826 << getSourceFileName(SourceID.second)
2827 <<" :" << utostr_32(LineInfo.getLine()) << '\n';
2828 }
2829
2830 // Define the line address.
2831 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2832 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2833 Asm->EmitInt8(dwarf::DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2834 EmitReference("label", LabelID); Asm->EOL("Location label");
2835
2836 // If change of source, then switch to the new source.
2837 if (Source != LineInfo.getSourceID()) {
2838 Source = LineInfo.getSourceID();
2839 Asm->EmitInt8(dwarf::DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2840 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2841 }
2842
2843 // If change of line.
2844 if (Line != LineInfo.getLine()) {
2845 // Determine offset.
2846 int Offset = LineInfo.getLine() - Line;
2847 int Delta = Offset - MinLineDelta;
2848
2849 // Update line.
2850 Line = LineInfo.getLine();
2851
2852 // If delta is small enough and in range...
2853 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2854 // ... then use fast opcode.
2855 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2856 } else {
2857 // ... otherwise use long hand.
2858 Asm->EmitInt8(dwarf::DW_LNS_advance_line);
2859 Asm->EOL("DW_LNS_advance_line");
2860 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2861 Asm->EmitInt8(dwarf::DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2862 }
2863 } else {
2864 // Copy the previous row (different address or source)
2865 Asm->EmitInt8(dwarf::DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2866 }
2867 }
2868
2869 EmitEndOfLineMatrix(j + 1);
2870 }
2871
2872 if (SecSrcLinesSize == 0)
2873 // Because we're emitting a debug_line section, we still need a line
2874 // table. The linker and friends expect it to exist. If there's nothing to
2875 // put into it, emit an empty table.
2876 EmitEndOfLineMatrix(1);
2877
2878 EmitLabel("line_end", 0);
2879 Asm->EOL();
2880}
2881
2882/// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
2883///
2884void DwarfDebug::EmitCommonDebugFrame() {
Chris Lattner33adcfb2009-08-22 21:43:10 +00002885 if (!MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00002886 return;
2887
2888 int stackGrowth =
2889 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2890 TargetFrameInfo::StackGrowsUp ?
2891 TD->getPointerSize() : -TD->getPointerSize();
2892
2893 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002894 Asm->OutStreamer.SwitchSection(
2895 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002896
2897 EmitLabel("debug_frame_common", 0);
2898 EmitDifference("debug_frame_common_end", 0,
2899 "debug_frame_common_begin", 0, true);
2900 Asm->EOL("Length of Common Information Entry");
2901
2902 EmitLabel("debug_frame_common_begin", 0);
2903 Asm->EmitInt32((int)dwarf::DW_CIE_ID);
2904 Asm->EOL("CIE Identifier Tag");
2905 Asm->EmitInt8(dwarf::DW_CIE_VERSION);
2906 Asm->EOL("CIE Version");
2907 Asm->EmitString("");
2908 Asm->EOL("CIE Augmentation");
2909 Asm->EmitULEB128Bytes(1);
2910 Asm->EOL("CIE Code Alignment Factor");
2911 Asm->EmitSLEB128Bytes(stackGrowth);
2912 Asm->EOL("CIE Data Alignment Factor");
2913 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
2914 Asm->EOL("CIE RA Column");
2915
2916 std::vector<MachineMove> Moves;
2917 RI->getInitialFrameState(Moves);
2918
2919 EmitFrameMoves(NULL, 0, Moves, false);
2920
2921 Asm->EmitAlignment(2, 0, 0, false);
2922 EmitLabel("debug_frame_common_end", 0);
2923
2924 Asm->EOL();
2925}
2926
2927/// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2928/// section.
2929void
2930DwarfDebug::EmitFunctionDebugFrame(const FunctionDebugFrameInfo&DebugFrameInfo){
Chris Lattner33adcfb2009-08-22 21:43:10 +00002931 if (!MAI->doesDwarfRequireFrameSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00002932 return;
2933
2934 // Start the dwarf frame section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00002935 Asm->OutStreamer.SwitchSection(
2936 Asm->getObjFileLowering().getDwarfFrameSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00002937
2938 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2939 "debug_frame_begin", DebugFrameInfo.Number, true);
2940 Asm->EOL("Length of Frame Information Entry");
2941
2942 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2943
2944 EmitSectionOffset("debug_frame_common", "section_debug_frame",
2945 0, 0, true, false);
2946 Asm->EOL("FDE CIE offset");
2947
2948 EmitReference("func_begin", DebugFrameInfo.Number);
2949 Asm->EOL("FDE initial location");
2950 EmitDifference("func_end", DebugFrameInfo.Number,
2951 "func_begin", DebugFrameInfo.Number);
2952 Asm->EOL("FDE address range");
2953
2954 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves,
2955 false);
2956
2957 Asm->EmitAlignment(2, 0, 0, false);
2958 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2959
2960 Asm->EOL();
2961}
2962
2963void DwarfDebug::EmitDebugPubNamesPerCU(CompileUnit *Unit) {
2964 EmitDifference("pubnames_end", Unit->getID(),
2965 "pubnames_begin", Unit->getID(), true);
2966 Asm->EOL("Length of Public Names Info");
2967
2968 EmitLabel("pubnames_begin", Unit->getID());
2969
2970 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF Version");
2971
2972 EmitSectionOffset("info_begin", "section_info",
2973 Unit->getID(), 0, true, false);
2974 Asm->EOL("Offset of Compilation Unit Info");
2975
2976 EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),
2977 true);
2978 Asm->EOL("Compilation Unit Length");
2979
2980 StringMap<DIE*> &Globals = Unit->getGlobals();
2981 for (StringMap<DIE*>::const_iterator
2982 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2983 const char *Name = GI->getKeyData();
2984 DIE * Entity = GI->second;
2985
2986 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2987 Asm->EmitString(Name, strlen(Name)); Asm->EOL("External Name");
2988 }
2989
2990 Asm->EmitInt32(0); Asm->EOL("End Mark");
2991 EmitLabel("pubnames_end", Unit->getID());
2992
2993 Asm->EOL();
2994}
2995
2996/// EmitDebugPubNames - Emit visible names into a debug pubnames section.
2997///
2998void DwarfDebug::EmitDebugPubNames() {
2999 // Start the dwarf pubnames section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003000 Asm->OutStreamer.SwitchSection(
3001 Asm->getObjFileLowering().getDwarfPubNamesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003002
Devang Patel1dbc7712009-06-29 20:45:18 +00003003 EmitDebugPubNamesPerCU(ModuleCU);
Bill Wendling94d04b82009-05-20 23:21:38 +00003004}
3005
3006/// EmitDebugStr - Emit visible names into a debug str section.
3007///
3008void DwarfDebug::EmitDebugStr() {
3009 // Check to see if it is worth the effort.
3010 if (!StringPool.empty()) {
3011 // Start the dwarf str section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003012 Asm->OutStreamer.SwitchSection(
3013 Asm->getObjFileLowering().getDwarfStrSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003014
3015 // For each of strings in the string pool.
3016 for (unsigned StringID = 1, N = StringPool.size();
3017 StringID <= N; ++StringID) {
3018 // Emit a label for reference from debug information entries.
3019 EmitLabel("string", StringID);
3020
3021 // Emit the string itself.
3022 const std::string &String = StringPool[StringID];
3023 Asm->EmitString(String); Asm->EOL();
3024 }
3025
3026 Asm->EOL();
3027 }
3028}
3029
3030/// EmitDebugLoc - Emit visible names into a debug loc section.
3031///
3032void DwarfDebug::EmitDebugLoc() {
3033 // Start the dwarf loc section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003034 Asm->OutStreamer.SwitchSection(
3035 Asm->getObjFileLowering().getDwarfLocSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003036 Asm->EOL();
3037}
3038
3039/// EmitDebugARanges - Emit visible names into a debug aranges section.
3040///
3041void DwarfDebug::EmitDebugARanges() {
3042 // Start the dwarf aranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003043 Asm->OutStreamer.SwitchSection(
3044 Asm->getObjFileLowering().getDwarfARangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003045
3046 // FIXME - Mock up
3047#if 0
3048 CompileUnit *Unit = GetBaseCompileUnit();
3049
3050 // Don't include size of length
3051 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
3052
3053 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("Dwarf Version");
3054
3055 EmitReference("info_begin", Unit->getID());
3056 Asm->EOL("Offset of Compilation Unit Info");
3057
3058 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
3059
3060 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
3061
3062 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
3063 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
3064
3065 // Range 1
3066 EmitReference("text_begin", 0); Asm->EOL("Address");
3067 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
3068
3069 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
3070 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
3071#endif
3072
3073 Asm->EOL();
3074}
3075
3076/// EmitDebugRanges - Emit visible names into a debug ranges section.
3077///
3078void DwarfDebug::EmitDebugRanges() {
3079 // Start the dwarf ranges section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003080 Asm->OutStreamer.SwitchSection(
3081 Asm->getObjFileLowering().getDwarfRangesSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003082 Asm->EOL();
3083}
3084
3085/// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
3086///
3087void DwarfDebug::EmitDebugMacInfo() {
Daniel Dunbarf612ff62009-09-19 20:40:05 +00003088 if (const MCSection *LineInfo =
Chris Lattner18a4c162009-08-02 07:24:22 +00003089 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
Bill Wendling94d04b82009-05-20 23:21:38 +00003090 // Start the dwarf macinfo section.
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003091 Asm->OutStreamer.SwitchSection(LineInfo);
Bill Wendling94d04b82009-05-20 23:21:38 +00003092 Asm->EOL();
3093 }
3094}
3095
3096/// EmitDebugInlineInfo - Emit inline info using following format.
3097/// Section Header:
3098/// 1. length of section
3099/// 2. Dwarf version number
3100/// 3. address size.
3101///
3102/// Entries (one "entry" for each function that was inlined):
3103///
3104/// 1. offset into __debug_str section for MIPS linkage name, if exists;
3105/// otherwise offset into __debug_str for regular function name.
3106/// 2. offset into __debug_str section for regular function name.
3107/// 3. an unsigned LEB128 number indicating the number of distinct inlining
3108/// instances for the function.
3109///
3110/// The rest of the entry consists of a {die_offset, low_pc} pair for each
3111/// inlined instance; the die_offset points to the inlined_subroutine die in the
3112/// __debug_info section, and the low_pc is the starting address for the
3113/// inlining instance.
3114void DwarfDebug::EmitDebugInlineInfo() {
Chris Lattner33adcfb2009-08-22 21:43:10 +00003115 if (!MAI->doesDwarfUsesInlineInfoSection())
Bill Wendling94d04b82009-05-20 23:21:38 +00003116 return;
3117
Devang Patel1dbc7712009-06-29 20:45:18 +00003118 if (!ModuleCU)
Bill Wendling94d04b82009-05-20 23:21:38 +00003119 return;
3120
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003121 Asm->OutStreamer.SwitchSection(
3122 Asm->getObjFileLowering().getDwarfDebugInlineSection());
Bill Wendling94d04b82009-05-20 23:21:38 +00003123 Asm->EOL();
3124 EmitDifference("debug_inlined_end", 1,
3125 "debug_inlined_begin", 1, true);
3126 Asm->EOL("Length of Debug Inlined Information Entry");
3127
3128 EmitLabel("debug_inlined_begin", 1);
3129
3130 Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("Dwarf Version");
3131 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
3132
Devang Patel53bb5c92009-11-10 23:06:00 +00003133 for (SmallVector<MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
3134 E = InlinedSPNodes.end(); I != E; ++I) {
3135
3136// for (ValueMap<MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
3137 // I = InlineInfo.begin(), E = InlineInfo.end(); I != E; ++I) {
3138 MDNode *Node = *I;
3139 ValueMap<MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II = InlineInfo.find(Node);
3140 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
Devang Patele4b27562009-08-28 23:24:31 +00003141 DISubprogram SP(Node);
Devang Patel5ccdd102009-09-29 18:40:58 +00003142 const char *LName = SP.getLinkageName();
3143 const char *Name = SP.getName();
Bill Wendling94d04b82009-05-20 23:21:38 +00003144
Devang Patel5ccdd102009-09-29 18:40:58 +00003145 if (!LName)
Devang Patel53cb17d2009-07-16 01:01:22 +00003146 Asm->EmitString(Name);
3147 else {
Chris Lattner6c2f9e12009-08-19 05:49:37 +00003148 // Skip special LLVM prefix that is used to inform the asm printer to not
3149 // emit usual symbol prefix before the symbol name. This happens for
3150 // Objective-C symbol names and symbol whose name is replaced using GCC's
3151 // __asm__ attribute.
Devang Patel53cb17d2009-07-16 01:01:22 +00003152 if (LName[0] == 1)
3153 LName = &LName[1];
Devang Patel53bb5c92009-11-10 23:06:00 +00003154// Asm->EmitString(LName);
3155 EmitSectionOffset("string", "section_str",
3156 StringPool.idFor(LName), false, true);
3157
Devang Patel53cb17d2009-07-16 01:01:22 +00003158 }
Bill Wendling94d04b82009-05-20 23:21:38 +00003159 Asm->EOL("MIPS linkage name");
Devang Patel53bb5c92009-11-10 23:06:00 +00003160// Asm->EmitString(Name);
3161 EmitSectionOffset("string", "section_str",
3162 StringPool.idFor(Name), false, true);
3163 Asm->EOL("Function name");
Bill Wendling94d04b82009-05-20 23:21:38 +00003164 Asm->EmitULEB128Bytes(Labels.size()); Asm->EOL("Inline count");
3165
Devang Patel53bb5c92009-11-10 23:06:00 +00003166 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
Bill Wendling94d04b82009-05-20 23:21:38 +00003167 LE = Labels.end(); LI != LE; ++LI) {
Devang Patel53bb5c92009-11-10 23:06:00 +00003168 DIE *SP = LI->second;
Bill Wendling94d04b82009-05-20 23:21:38 +00003169 Asm->EmitInt32(SP->getOffset()); Asm->EOL("DIE offset");
3170
3171 if (TD->getPointerSize() == sizeof(int32_t))
Chris Lattner33adcfb2009-08-22 21:43:10 +00003172 O << MAI->getData32bitsDirective();
Bill Wendling94d04b82009-05-20 23:21:38 +00003173 else
Chris Lattner33adcfb2009-08-22 21:43:10 +00003174 O << MAI->getData64bitsDirective();
Bill Wendling94d04b82009-05-20 23:21:38 +00003175
Devang Patel53bb5c92009-11-10 23:06:00 +00003176 PrintLabelName("label", LI->first); Asm->EOL("low_pc");
Bill Wendling94d04b82009-05-20 23:21:38 +00003177 }
3178 }
3179
3180 EmitLabel("debug_inlined_end", 1);
3181 Asm->EOL();
3182}