DwarfDebug.cpp revision 87370b8301fa39ee54bdcaae0618fd565e808466
1//===-- 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//===----------------------------------------------------------------------===//
13
14#include "DwarfDebug.h"
15#include "llvm/Module.h"
16#include "llvm/CodeGen/MachineModuleInfo.h"
17#include "llvm/Support/Timer.h"
18#include "llvm/Support/Mangler.h"
19#include "llvm/System/Path.h"
20#include "llvm/Target/TargetAsmInfo.h"
21#include "llvm/Target/TargetRegisterInfo.h"
22#include "llvm/Target/TargetData.h"
23#include "llvm/Target/TargetFrameInfo.h"
24using namespace llvm;
25
26static TimerGroup &getDwarfTimerGroup() {
27  static TimerGroup DwarfTimerGroup("Dwarf Debugging");
28  return DwarfTimerGroup;
29}
30
31//===----------------------------------------------------------------------===//
32
33/// Configuration values for initial hash set sizes (log2).
34///
35static const unsigned InitDiesSetSize          = 9; // log2(512)
36static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
37static const unsigned InitValuesSetSize        = 9; // log2(512)
38
39namespace llvm {
40
41//===----------------------------------------------------------------------===//
42/// CompileUnit - This dwarf writer support class manages information associate
43/// with a source file.
44class VISIBILITY_HIDDEN CompileUnit {
45  /// ID - File identifier for source.
46  ///
47  unsigned ID;
48
49  /// Die - Compile unit debug information entry.
50  ///
51  DIE *Die;
52
53  /// GVToDieMap - Tracks the mapping of unit level debug informaton
54  /// variables to debug information entries.
55  std::map<GlobalVariable *, DIE *> GVToDieMap;
56
57  /// GVToDIEEntryMap - Tracks the mapping of unit level debug informaton
58  /// descriptors to debug information entries using a DIEEntry proxy.
59  std::map<GlobalVariable *, DIEEntry *> GVToDIEEntryMap;
60
61  /// Globals - A map of globally visible named entities for this unit.
62  ///
63  StringMap<DIE*> Globals;
64
65  /// DiesSet - Used to uniquely define dies within the compile unit.
66  ///
67  FoldingSet<DIE> DiesSet;
68public:
69  CompileUnit(unsigned I, DIE *D)
70    : ID(I), Die(D), DiesSet(InitDiesSetSize) {}
71  ~CompileUnit() { delete Die; }
72
73  // Accessors.
74  unsigned getID() const { return ID; }
75  DIE* getDie() const { return Die; }
76  StringMap<DIE*> &getGlobals() { return Globals; }
77
78  /// hasContent - Return true if this compile unit has something to write out.
79  ///
80  bool hasContent() const { return !Die->getChildren().empty(); }
81
82  /// AddGlobal - Add a new global entity to the compile unit.
83  ///
84  void AddGlobal(const std::string &Name, DIE *Die) { Globals[Name] = Die; }
85
86  /// getDieMapSlotFor - Returns the debug information entry map slot for the
87  /// specified debug variable.
88  DIE *&getDieMapSlotFor(GlobalVariable *GV) { return GVToDieMap[GV]; }
89
90  /// getDIEEntrySlotFor - Returns the debug information entry proxy slot for the
91  /// specified debug variable.
92  DIEEntry *&getDIEEntrySlotFor(GlobalVariable *GV) {
93    return GVToDIEEntryMap[GV];
94  }
95
96  /// AddDie - Adds or interns the DIE to the compile unit.
97  ///
98  DIE *AddDie(DIE &Buffer) {
99    FoldingSetNodeID ID;
100    Buffer.Profile(ID);
101    void *Where;
102    DIE *Die = DiesSet.FindNodeOrInsertPos(ID, Where);
103
104    if (!Die) {
105      Die = new DIE(Buffer);
106      DiesSet.InsertNode(Die, Where);
107      this->Die->AddChild(Die);
108      Buffer.Detach();
109    }
110
111    return Die;
112  }
113};
114
115//===----------------------------------------------------------------------===//
116/// DbgVariable - This class is used to track local variable information.
117///
118class VISIBILITY_HIDDEN DbgVariable {
119  DIVariable Var;                    // Variable Descriptor.
120  unsigned FrameIndex;               // Variable frame index.
121  bool InlinedFnVar;                 // Variable for an inlined function.
122public:
123  DbgVariable(DIVariable V, unsigned I, bool IFV)
124    : Var(V), FrameIndex(I), InlinedFnVar(IFV)  {}
125
126  // Accessors.
127  DIVariable getVariable() const { return Var; }
128  unsigned getFrameIndex() const { return FrameIndex; }
129  bool isInlinedFnVar() const { return InlinedFnVar; }
130};
131
132//===----------------------------------------------------------------------===//
133/// DbgScope - This class is used to track scope information.
134///
135class DbgConcreteScope;
136class VISIBILITY_HIDDEN DbgScope {
137  DbgScope *Parent;                   // Parent to this scope.
138  DIDescriptor Desc;                  // Debug info descriptor for scope.
139                                      // Either subprogram or block.
140  unsigned StartLabelID;              // Label ID of the beginning of scope.
141  unsigned EndLabelID;                // Label ID of the end of scope.
142  SmallVector<DbgScope *, 4> Scopes;  // Scopes defined in scope.
143  SmallVector<DbgVariable *, 8> Variables;// Variables declared in scope.
144  SmallVector<DbgConcreteScope *, 8> ConcreteInsts;// Concrete insts of funcs.
145
146  // Private state for dump()
147  mutable unsigned IndentLevel;
148public:
149  DbgScope(DbgScope *P, DIDescriptor D)
150    : Parent(P), Desc(D), StartLabelID(0), EndLabelID(0), IndentLevel(0) {}
151  virtual ~DbgScope();
152
153  // Accessors.
154  DbgScope *getParent()          const { return Parent; }
155  DIDescriptor getDesc()         const { return Desc; }
156  unsigned getStartLabelID()     const { return StartLabelID; }
157  unsigned getEndLabelID()       const { return EndLabelID; }
158  SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
159  SmallVector<DbgVariable *, 8> &getVariables() { return Variables; }
160  SmallVector<DbgConcreteScope*,8> &getConcreteInsts() { return ConcreteInsts; }
161  void setStartLabelID(unsigned S) { StartLabelID = S; }
162  void setEndLabelID(unsigned E)   { EndLabelID = E; }
163
164  /// AddScope - Add a scope to the scope.
165  ///
166  void AddScope(DbgScope *S) { Scopes.push_back(S); }
167
168  /// AddVariable - Add a variable to the scope.
169  ///
170  void AddVariable(DbgVariable *V) { Variables.push_back(V); }
171
172  /// AddConcreteInst - Add a concrete instance to the scope.
173  ///
174  void AddConcreteInst(DbgConcreteScope *C) { ConcreteInsts.push_back(C); }
175
176#ifndef NDEBUG
177  void dump() const;
178#endif
179};
180
181#ifndef NDEBUG
182void DbgScope::dump() const {
183  std::string Indent(IndentLevel, ' ');
184
185  cerr << Indent; Desc.dump();
186  cerr << " [" << StartLabelID << ", " << EndLabelID << "]\n";
187
188  IndentLevel += 2;
189
190  for (unsigned i = 0, e = Scopes.size(); i != e; ++i)
191    if (Scopes[i] != this)
192      Scopes[i]->dump();
193
194  IndentLevel -= 2;
195}
196#endif
197
198//===----------------------------------------------------------------------===//
199/// DbgConcreteScope - This class is used to track a scope that holds concrete
200/// instance information.
201///
202class VISIBILITY_HIDDEN DbgConcreteScope : public DbgScope {
203  CompileUnit *Unit;
204  DIE *Die;                           // Debug info for this concrete scope.
205public:
206  DbgConcreteScope(DIDescriptor D) : DbgScope(NULL, D) {}
207
208  // Accessors.
209  DIE *getDie() const { return Die; }
210  void setDie(DIE *D) { Die = D; }
211};
212
213DbgScope::~DbgScope() {
214  for (unsigned i = 0, N = Scopes.size(); i < N; ++i)
215    delete Scopes[i];
216  for (unsigned j = 0, M = Variables.size(); j < M; ++j)
217    delete Variables[j];
218  for (unsigned k = 0, O = ConcreteInsts.size(); k < O; ++k)
219    delete ConcreteInsts[k];
220}
221
222} // end llvm namespace
223
224DwarfDebug::DwarfDebug(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
225  : Dwarf(OS, A, T, "dbg"), ModuleCU(0),
226    AbbreviationsSet(InitAbbreviationsSetSize), Abbreviations(),
227    ValuesSet(InitValuesSetSize), Values(), StringPool(), SectionMap(),
228    SectionSourceLines(), didInitial(false), shouldEmit(false),
229    FunctionDbgScope(0), DebugTimer(0) {
230  if (TimePassesIsEnabled)
231    DebugTimer = new Timer("Dwarf Debug Writer",
232                           getDwarfTimerGroup());
233}
234DwarfDebug::~DwarfDebug() {
235  for (unsigned j = 0, M = Values.size(); j < M; ++j)
236    delete Values[j];
237
238  for (DenseMap<const GlobalVariable *, DbgScope *>::iterator
239         I = AbstractInstanceRootMap.begin(),
240         E = AbstractInstanceRootMap.end(); I != E;++I)
241    delete I->second;
242
243  delete DebugTimer;
244}
245
246/// AssignAbbrevNumber - Define a unique number for the abbreviation.
247///
248void DwarfDebug::AssignAbbrevNumber(DIEAbbrev &Abbrev) {
249  // Profile the node so that we can make it unique.
250  FoldingSetNodeID ID;
251  Abbrev.Profile(ID);
252
253  // Check the set for priors.
254  DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
255
256  // If it's newly added.
257  if (InSet == &Abbrev) {
258    // Add to abbreviation list.
259    Abbreviations.push_back(&Abbrev);
260
261    // Assign the vector position + 1 as its number.
262    Abbrev.setNumber(Abbreviations.size());
263  } else {
264    // Assign existing abbreviation number.
265    Abbrev.setNumber(InSet->getNumber());
266  }
267}
268
269/// CreateDIEEntry - Creates a new DIEEntry to be a proxy for a debug
270/// information entry.
271DIEEntry *DwarfDebug::CreateDIEEntry(DIE *Entry) {
272  DIEEntry *Value;
273
274  if (Entry) {
275    FoldingSetNodeID ID;
276    DIEEntry::Profile(ID, Entry);
277    void *Where;
278    Value = static_cast<DIEEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where));
279
280    if (Value) return Value;
281
282    Value = new DIEEntry(Entry);
283    ValuesSet.InsertNode(Value, Where);
284  } else {
285    Value = new DIEEntry(Entry);
286  }
287
288  Values.push_back(Value);
289  return Value;
290}
291
292/// SetDIEEntry - Set a DIEEntry once the debug information entry is defined.
293///
294void DwarfDebug::SetDIEEntry(DIEEntry *Value, DIE *Entry) {
295  Value->setEntry(Entry);
296
297  // Add to values set if not already there.  If it is, we merely have a
298  // duplicate in the values list (no harm.)
299  ValuesSet.GetOrInsertNode(Value);
300}
301
302/// AddUInt - Add an unsigned integer attribute data and value.
303///
304void DwarfDebug::AddUInt(DIE *Die, unsigned Attribute,
305                         unsigned Form, uint64_t Integer) {
306  if (!Form) Form = DIEInteger::BestForm(false, Integer);
307
308  FoldingSetNodeID ID;
309  DIEInteger::Profile(ID, Integer);
310  void *Where;
311  DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
312
313  if (!Value) {
314    Value = new DIEInteger(Integer);
315    ValuesSet.InsertNode(Value, Where);
316    Values.push_back(Value);
317  }
318
319  Die->AddValue(Attribute, Form, Value);
320}
321
322/// AddSInt - Add an signed integer attribute data and value.
323///
324void DwarfDebug::AddSInt(DIE *Die, unsigned Attribute,
325                         unsigned Form, int64_t Integer) {
326  if (!Form) Form = DIEInteger::BestForm(true, Integer);
327
328  FoldingSetNodeID ID;
329  DIEInteger::Profile(ID, (uint64_t)Integer);
330  void *Where;
331  DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
332
333  if (!Value) {
334    Value = new DIEInteger(Integer);
335    ValuesSet.InsertNode(Value, Where);
336    Values.push_back(Value);
337  }
338
339  Die->AddValue(Attribute, Form, Value);
340}
341
342/// AddString - Add a string attribute data and value.
343///
344void DwarfDebug::AddString(DIE *Die, unsigned Attribute, unsigned Form,
345                           const std::string &String) {
346  FoldingSetNodeID ID;
347  DIEString::Profile(ID, String);
348  void *Where;
349  DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
350
351  if (!Value) {
352    Value = new DIEString(String);
353    ValuesSet.InsertNode(Value, Where);
354    Values.push_back(Value);
355  }
356
357  Die->AddValue(Attribute, Form, Value);
358}
359
360/// AddLabel - Add a Dwarf label attribute data and value.
361///
362void DwarfDebug::AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
363                          const DWLabel &Label) {
364  FoldingSetNodeID ID;
365  DIEDwarfLabel::Profile(ID, Label);
366  void *Where;
367  DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
368
369  if (!Value) {
370    Value = new DIEDwarfLabel(Label);
371    ValuesSet.InsertNode(Value, Where);
372    Values.push_back(Value);
373  }
374
375  Die->AddValue(Attribute, Form, Value);
376}
377
378/// AddObjectLabel - Add an non-Dwarf label attribute data and value.
379///
380void DwarfDebug::AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
381                                const std::string &Label) {
382  FoldingSetNodeID ID;
383  DIEObjectLabel::Profile(ID, Label);
384  void *Where;
385  DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
386
387  if (!Value) {
388    Value = new DIEObjectLabel(Label);
389    ValuesSet.InsertNode(Value, Where);
390    Values.push_back(Value);
391  }
392
393  Die->AddValue(Attribute, Form, Value);
394}
395
396/// AddSectionOffset - Add a section offset label attribute data and value.
397///
398void DwarfDebug::AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
399                                  const DWLabel &Label, const DWLabel &Section,
400                                  bool isEH, bool useSet) {
401  FoldingSetNodeID ID;
402  DIESectionOffset::Profile(ID, Label, Section);
403  void *Where;
404  DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
405
406  if (!Value) {
407    Value = new DIESectionOffset(Label, Section, isEH, useSet);
408    ValuesSet.InsertNode(Value, Where);
409    Values.push_back(Value);
410  }
411
412  Die->AddValue(Attribute, Form, Value);
413}
414
415/// AddDelta - Add a label delta attribute data and value.
416///
417void DwarfDebug::AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
418                          const DWLabel &Hi, const DWLabel &Lo) {
419  FoldingSetNodeID ID;
420  DIEDelta::Profile(ID, Hi, Lo);
421  void *Where;
422  DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
423
424  if (!Value) {
425    Value = new DIEDelta(Hi, Lo);
426    ValuesSet.InsertNode(Value, Where);
427    Values.push_back(Value);
428  }
429
430  Die->AddValue(Attribute, Form, Value);
431}
432
433/// AddBlock - Add block data.
434///
435void DwarfDebug::AddBlock(DIE *Die, unsigned Attribute, unsigned Form,
436                          DIEBlock *Block) {
437  Block->ComputeSize(TD);
438  FoldingSetNodeID ID;
439  Block->Profile(ID);
440  void *Where;
441  DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
442
443  if (!Value) {
444    Value = Block;
445    ValuesSet.InsertNode(Value, Where);
446    Values.push_back(Value);
447  } else {
448    // Already exists, reuse the previous one.
449    delete Block;
450    Block = cast<DIEBlock>(Value);
451  }
452
453  Die->AddValue(Attribute, Block->BestForm(), Value);
454}
455
456/// AddSourceLine - Add location information to specified debug information
457/// entry.
458void DwarfDebug::AddSourceLine(DIE *Die, const DIVariable *V) {
459  // If there is no compile unit specified, don't add a line #.
460  if (V->getCompileUnit().isNull())
461    return;
462
463  unsigned Line = V->getLineNumber();
464  unsigned FileID = FindCompileUnit(V->getCompileUnit()).getID();
465  assert(FileID && "Invalid file id");
466  AddUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
467  AddUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
468}
469
470/// AddSourceLine - Add location information to specified debug information
471/// entry.
472void DwarfDebug::AddSourceLine(DIE *Die, const DIGlobal *G) {
473  // If there is no compile unit specified, don't add a line #.
474  if (G->getCompileUnit().isNull())
475    return;
476
477  unsigned Line = G->getLineNumber();
478  unsigned FileID = FindCompileUnit(G->getCompileUnit()).getID();
479  assert(FileID && "Invalid file id");
480  AddUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
481  AddUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
482}
483void DwarfDebug::AddSourceLine(DIE *Die, const DIType *Ty) {
484  // If there is no compile unit specified, don't add a line #.
485  DICompileUnit CU = Ty->getCompileUnit();
486  if (CU.isNull())
487    return;
488
489  unsigned Line = Ty->getLineNumber();
490  unsigned FileID = FindCompileUnit(CU).getID();
491  assert(FileID && "Invalid file id");
492  AddUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
493  AddUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
494}
495
496/// AddAddress - Add an address attribute to a die based on the location
497/// provided.
498void DwarfDebug::AddAddress(DIE *Die, unsigned Attribute,
499                            const MachineLocation &Location) {
500  unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
501  DIEBlock *Block = new DIEBlock();
502
503  if (Location.isReg()) {
504    if (Reg < 32) {
505      AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
506    } else {
507      AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
508      AddUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
509    }
510  } else {
511    if (Reg < 32) {
512      AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
513    } else {
514      AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
515      AddUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
516    }
517
518    AddUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
519  }
520
521  AddBlock(Die, Attribute, 0, Block);
522}
523
524/// AddType - Add a new type attribute to the specified entity.
525void DwarfDebug::AddType(CompileUnit *DW_Unit, DIE *Entity, DIType Ty) {
526  if (Ty.isNull())
527    return;
528
529  // Check for pre-existence.
530  DIEEntry *&Slot = DW_Unit->getDIEEntrySlotFor(Ty.getGV());
531
532  // If it exists then use the existing value.
533  if (Slot) {
534    Entity->AddValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Slot);
535    return;
536  }
537
538  // Set up proxy.
539  Slot = CreateDIEEntry();
540
541  // Construct type.
542  DIE Buffer(dwarf::DW_TAG_base_type);
543  if (Ty.isBasicType(Ty.getTag()))
544    ConstructTypeDIE(DW_Unit, Buffer, DIBasicType(Ty.getGV()));
545  else if (Ty.isDerivedType(Ty.getTag()))
546    ConstructTypeDIE(DW_Unit, Buffer, DIDerivedType(Ty.getGV()));
547  else {
548    assert(Ty.isCompositeType(Ty.getTag()) && "Unknown kind of DIType");
549    ConstructTypeDIE(DW_Unit, Buffer, DICompositeType(Ty.getGV()));
550  }
551
552  // Add debug information entry to entity and appropriate context.
553  DIE *Die = NULL;
554  DIDescriptor Context = Ty.getContext();
555  if (!Context.isNull())
556    Die = DW_Unit->getDieMapSlotFor(Context.getGV());
557
558  if (Die) {
559    DIE *Child = new DIE(Buffer);
560    Die->AddChild(Child);
561    Buffer.Detach();
562    SetDIEEntry(Slot, Child);
563  } else {
564    Die = DW_Unit->AddDie(Buffer);
565    SetDIEEntry(Slot, Die);
566  }
567
568  Entity->AddValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Slot);
569}
570
571/// ConstructTypeDIE - Construct basic type die from DIBasicType.
572void DwarfDebug::ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
573                                  DIBasicType BTy) {
574  // Get core information.
575  std::string Name;
576  BTy.getName(Name);
577  Buffer.setTag(dwarf::DW_TAG_base_type);
578  AddUInt(&Buffer, dwarf::DW_AT_encoding,  dwarf::DW_FORM_data1,
579          BTy.getEncoding());
580
581  // Add name if not anonymous or intermediate type.
582  if (!Name.empty())
583    AddString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
584  uint64_t Size = BTy.getSizeInBits() >> 3;
585  AddUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
586}
587
588/// ConstructTypeDIE - Construct derived type die from DIDerivedType.
589void DwarfDebug::ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
590                                  DIDerivedType DTy) {
591  // Get core information.
592  std::string Name;
593  DTy.getName(Name);
594  uint64_t Size = DTy.getSizeInBits() >> 3;
595  unsigned Tag = DTy.getTag();
596
597  // FIXME - Workaround for templates.
598  if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
599
600  Buffer.setTag(Tag);
601
602  // Map to main type, void will not have a type.
603  DIType FromTy = DTy.getTypeDerivedFrom();
604  AddType(DW_Unit, &Buffer, FromTy);
605
606  // Add name if not anonymous or intermediate type.
607  if (!Name.empty())
608    AddString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
609
610  // Add size if non-zero (derived types might be zero-sized.)
611  if (Size)
612    AddUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
613
614  // Add source line info if available and TyDesc is not a forward declaration.
615  if (!DTy.isForwardDecl())
616    AddSourceLine(&Buffer, &DTy);
617}
618
619/// ConstructTypeDIE - Construct type DIE from DICompositeType.
620void DwarfDebug::ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
621                                  DICompositeType CTy) {
622  // Get core information.
623  std::string Name;
624  CTy.getName(Name);
625
626  uint64_t Size = CTy.getSizeInBits() >> 3;
627  unsigned Tag = CTy.getTag();
628  Buffer.setTag(Tag);
629
630  switch (Tag) {
631  case dwarf::DW_TAG_vector_type:
632  case dwarf::DW_TAG_array_type:
633    ConstructArrayTypeDIE(DW_Unit, Buffer, &CTy);
634    break;
635  case dwarf::DW_TAG_enumeration_type: {
636    DIArray Elements = CTy.getTypeArray();
637
638    // Add enumerators to enumeration type.
639    for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
640      DIE *ElemDie = NULL;
641      DIEnumerator Enum(Elements.getElement(i).getGV());
642      ElemDie = ConstructEnumTypeDIE(DW_Unit, &Enum);
643      Buffer.AddChild(ElemDie);
644    }
645  }
646    break;
647  case dwarf::DW_TAG_subroutine_type: {
648    // Add return type.
649    DIArray Elements = CTy.getTypeArray();
650    DIDescriptor RTy = Elements.getElement(0);
651    AddType(DW_Unit, &Buffer, DIType(RTy.getGV()));
652
653    // Add prototype flag.
654    AddUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
655
656    // Add arguments.
657    for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
658      DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
659      DIDescriptor Ty = Elements.getElement(i);
660      AddType(DW_Unit, Arg, DIType(Ty.getGV()));
661      Buffer.AddChild(Arg);
662    }
663  }
664    break;
665  case dwarf::DW_TAG_structure_type:
666  case dwarf::DW_TAG_union_type:
667  case dwarf::DW_TAG_class_type: {
668    // Add elements to structure type.
669    DIArray Elements = CTy.getTypeArray();
670
671    // A forward struct declared type may not have elements available.
672    if (Elements.isNull())
673      break;
674
675    // Add elements to structure type.
676    for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
677      DIDescriptor Element = Elements.getElement(i);
678      DIE *ElemDie = NULL;
679      if (Element.getTag() == dwarf::DW_TAG_subprogram)
680        ElemDie = CreateSubprogramDIE(DW_Unit,
681                                      DISubprogram(Element.getGV()));
682      else
683        ElemDie = CreateMemberDIE(DW_Unit,
684                                  DIDerivedType(Element.getGV()));
685      Buffer.AddChild(ElemDie);
686    }
687
688    // FIXME: We'd like an API to register additional attributes for the
689    // frontend to use while synthesizing, and then we'd use that api in clang
690    // instead of this.
691    if (Name == "__block_literal_generic")
692      AddUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
693
694    unsigned RLang = CTy.getRunTimeLang();
695    if (RLang)
696      AddUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
697              dwarf::DW_FORM_data1, RLang);
698    break;
699  }
700  default:
701    break;
702  }
703
704  // Add name if not anonymous or intermediate type.
705  if (!Name.empty())
706    AddString(&Buffer, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
707
708  if (Tag == dwarf::DW_TAG_enumeration_type ||
709      Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type) {
710    // Add size if non-zero (derived types might be zero-sized.)
711    if (Size)
712      AddUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
713    else {
714      // Add zero size if it is not a forward declaration.
715      if (CTy.isForwardDecl())
716        AddUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
717      else
718        AddUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
719    }
720
721    // Add source line info if available.
722    if (!CTy.isForwardDecl())
723      AddSourceLine(&Buffer, &CTy);
724  }
725}
726
727/// ConstructSubrangeDIE - Construct subrange DIE from DISubrange.
728void DwarfDebug::ConstructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
729  int64_t L = SR.getLo();
730  int64_t H = SR.getHi();
731  DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
732
733  if (L != H) {
734    AddDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
735    if (L)
736      AddSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
737    AddSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
738  }
739
740  Buffer.AddChild(DW_Subrange);
741}
742
743/// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType.
744void DwarfDebug::ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
745                                       DICompositeType *CTy) {
746  Buffer.setTag(dwarf::DW_TAG_array_type);
747  if (CTy->getTag() == dwarf::DW_TAG_vector_type)
748    AddUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
749
750  // Emit derived type.
751  AddType(DW_Unit, &Buffer, CTy->getTypeDerivedFrom());
752  DIArray Elements = CTy->getTypeArray();
753
754  // Construct an anonymous type for index type.
755  DIE IdxBuffer(dwarf::DW_TAG_base_type);
756  AddUInt(&IdxBuffer, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
757  AddUInt(&IdxBuffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
758          dwarf::DW_ATE_signed);
759  DIE *IndexTy = DW_Unit->AddDie(IdxBuffer);
760
761  // Add subranges to array type.
762  for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
763    DIDescriptor Element = Elements.getElement(i);
764    if (Element.getTag() == dwarf::DW_TAG_subrange_type)
765      ConstructSubrangeDIE(Buffer, DISubrange(Element.getGV()), IndexTy);
766  }
767}
768
769/// ConstructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
770DIE *DwarfDebug::ConstructEnumTypeDIE(CompileUnit *DW_Unit, DIEnumerator *ETy) {
771  DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
772  std::string Name;
773  ETy->getName(Name);
774  AddString(Enumerator, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
775  int64_t Value = ETy->getEnumValue();
776  AddSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
777  return Enumerator;
778}
779
780/// CreateGlobalVariableDIE - Create new DIE using GV.
781DIE *DwarfDebug::CreateGlobalVariableDIE(CompileUnit *DW_Unit,
782                                         const DIGlobalVariable &GV) {
783  DIE *GVDie = new DIE(dwarf::DW_TAG_variable);
784  std::string Name;
785  GV.getDisplayName(Name);
786  AddString(GVDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
787  std::string LinkageName;
788  GV.getLinkageName(LinkageName);
789  if (!LinkageName.empty()) {
790    Mangler *Mg = Asm->getMangler();
791    AddString(GVDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
792              Mg ? Mg->makeNameProper(LinkageName) : LinkageName);
793  }
794  AddType(DW_Unit, GVDie, GV.getType());
795  if (!GV.isLocalToUnit())
796    AddUInt(GVDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
797  AddSourceLine(GVDie, &GV);
798  return GVDie;
799}
800
801/// CreateMemberDIE - Create new member DIE.
802DIE *DwarfDebug::CreateMemberDIE(CompileUnit *DW_Unit, const DIDerivedType &DT){
803  DIE *MemberDie = new DIE(DT.getTag());
804  std::string Name;
805  DT.getName(Name);
806  if (!Name.empty())
807    AddString(MemberDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
808
809  AddType(DW_Unit, MemberDie, DT.getTypeDerivedFrom());
810
811  AddSourceLine(MemberDie, &DT);
812
813  uint64_t Size = DT.getSizeInBits();
814  uint64_t FieldSize = DT.getOriginalTypeSize();
815
816  if (Size != FieldSize) {
817    // Handle bitfield.
818    AddUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
819    AddUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
820
821    uint64_t Offset = DT.getOffsetInBits();
822    uint64_t FieldOffset = Offset;
823    uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
824    uint64_t HiMark = (Offset + FieldSize) & AlignMask;
825    FieldOffset = (HiMark - FieldSize);
826    Offset -= FieldOffset;
827
828    // Maybe we need to work from the other end.
829    if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
830    AddUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
831  }
832
833  DIEBlock *Block = new DIEBlock();
834  AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
835  AddUInt(Block, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
836  AddBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, Block);
837
838  if (DT.isProtected())
839    AddUInt(MemberDie, dwarf::DW_AT_accessibility, 0,
840            dwarf::DW_ACCESS_protected);
841  else if (DT.isPrivate())
842    AddUInt(MemberDie, dwarf::DW_AT_accessibility, 0,
843            dwarf::DW_ACCESS_private);
844
845  return MemberDie;
846}
847
848/// CreateSubprogramDIE - Create new DIE using SP.
849DIE *DwarfDebug::CreateSubprogramDIE(CompileUnit *DW_Unit,
850                                     const DISubprogram &SP,
851                                     bool IsConstructor,
852                                     bool IsInlined) {
853  DIE *SPDie = new DIE(dwarf::DW_TAG_subprogram);
854
855  std::string Name;
856  SP.getName(Name);
857  AddString(SPDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
858
859  std::string LinkageName;
860  SP.getLinkageName(LinkageName);
861
862  if (!LinkageName.empty()) {
863    Mangler *Mg = Asm->getMangler();
864    AddString(SPDie, dwarf::DW_AT_MIPS_linkage_name, dwarf::DW_FORM_string,
865              Mg ? Mg->makeNameProper(LinkageName) : LinkageName);
866  }
867
868  AddSourceLine(SPDie, &SP);
869
870  DICompositeType SPTy = SP.getType();
871  DIArray Args = SPTy.getTypeArray();
872
873  // Add prototyped tag, if C or ObjC.
874  unsigned Lang = SP.getCompileUnit().getLanguage();
875  if (Lang == dwarf::DW_LANG_C99 || Lang == dwarf::DW_LANG_C89 ||
876      Lang == dwarf::DW_LANG_ObjC)
877    AddUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
878
879  // Add Return Type.
880  unsigned SPTag = SPTy.getTag();
881  if (!IsConstructor) {
882    if (Args.isNull() || SPTag != dwarf::DW_TAG_subroutine_type)
883      AddType(DW_Unit, SPDie, SPTy);
884    else
885      AddType(DW_Unit, SPDie, DIType(Args.getElement(0).getGV()));
886  }
887
888  if (!SP.isDefinition()) {
889    AddUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
890
891    // Add arguments. Do not add arguments for subprogram definition. They will
892    // be handled through RecordVariable.
893    if (SPTag == dwarf::DW_TAG_subroutine_type)
894      for (unsigned i = 1, N =  Args.getNumElements(); i < N; ++i) {
895        DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
896        AddType(DW_Unit, Arg, DIType(Args.getElement(i).getGV()));
897        AddUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1); // ??
898        SPDie->AddChild(Arg);
899      }
900  }
901
902  if (!SP.isLocalToUnit() && !IsInlined)
903    AddUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
904
905  // DW_TAG_inlined_subroutine may refer to this DIE.
906  DIE *&Slot = DW_Unit->getDieMapSlotFor(SP.getGV());
907  Slot = SPDie;
908  return SPDie;
909}
910
911/// FindCompileUnit - Get the compile unit for the given descriptor.
912///
913CompileUnit &DwarfDebug::FindCompileUnit(DICompileUnit Unit) const {
914  DenseMap<Value *, CompileUnit *>::const_iterator I =
915    CompileUnitMap.find(Unit.getGV());
916  assert(I != CompileUnitMap.end() && "Missing compile unit.");
917  return *I->second;
918}
919
920/// CreateDbgScopeVariable - Create a new scope variable.
921///
922DIE *DwarfDebug::CreateDbgScopeVariable(DbgVariable *DV, CompileUnit *Unit) {
923  // Get the descriptor.
924  const DIVariable &VD = DV->getVariable();
925
926  // Translate tag to proper Dwarf tag.  The result variable is dropped for
927  // now.
928  unsigned Tag;
929  switch (VD.getTag()) {
930  case dwarf::DW_TAG_return_variable:
931    return NULL;
932  case dwarf::DW_TAG_arg_variable:
933    Tag = dwarf::DW_TAG_formal_parameter;
934    break;
935  case dwarf::DW_TAG_auto_variable:    // fall thru
936  default:
937    Tag = dwarf::DW_TAG_variable;
938    break;
939  }
940
941  // Define variable debug information entry.
942  DIE *VariableDie = new DIE(Tag);
943  std::string Name;
944  VD.getName(Name);
945  AddString(VariableDie, dwarf::DW_AT_name, dwarf::DW_FORM_string, Name);
946
947  // Add source line info if available.
948  AddSourceLine(VariableDie, &VD);
949
950  // Add variable type.
951  AddType(Unit, VariableDie, VD.getType());
952
953  // Add variable address.
954  if (!DV->isInlinedFnVar()) {
955    // Variables for abstract instances of inlined functions don't get a
956    // location.
957    MachineLocation Location;
958    Location.set(RI->getFrameRegister(*MF),
959                 RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
960    AddAddress(VariableDie, dwarf::DW_AT_location, Location);
961  }
962
963  return VariableDie;
964}
965
966/// getOrCreateScope - Returns the scope associated with the given descriptor.
967///
968DbgScope *DwarfDebug::getOrCreateScope(GlobalVariable *V) {
969  DbgScope *&Slot = DbgScopeMap[V];
970  if (Slot) return Slot;
971
972  DbgScope *Parent = NULL;
973  DIBlock Block(V);
974
975  // Don't create a new scope if we already created one for an inlined function.
976  DenseMap<const GlobalVariable *, DbgScope *>::iterator
977    II = AbstractInstanceRootMap.find(V);
978  if (II != AbstractInstanceRootMap.end())
979    return LexicalScopeStack.back();
980
981  if (!Block.isNull()) {
982    DIDescriptor ParentDesc = Block.getContext();
983    Parent =
984      ParentDesc.isNull() ?  NULL : getOrCreateScope(ParentDesc.getGV());
985  }
986
987  Slot = new DbgScope(Parent, DIDescriptor(V));
988
989  if (Parent)
990    Parent->AddScope(Slot);
991  else
992    // First function is top level function.
993    FunctionDbgScope = Slot;
994
995  return Slot;
996}
997
998/// ConstructDbgScope - Construct the components of a scope.
999///
1000void DwarfDebug::ConstructDbgScope(DbgScope *ParentScope,
1001                                   unsigned ParentStartID,
1002                                   unsigned ParentEndID,
1003                                   DIE *ParentDie, CompileUnit *Unit) {
1004  // Add variables to scope.
1005  SmallVector<DbgVariable *, 8> &Variables = ParentScope->getVariables();
1006  for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
1007    DIE *VariableDie = CreateDbgScopeVariable(Variables[i], Unit);
1008    if (VariableDie) ParentDie->AddChild(VariableDie);
1009  }
1010
1011  // Add concrete instances to scope.
1012  SmallVector<DbgConcreteScope *, 8> &ConcreteInsts =
1013    ParentScope->getConcreteInsts();
1014  for (unsigned i = 0, N = ConcreteInsts.size(); i < N; ++i) {
1015    DbgConcreteScope *ConcreteInst = ConcreteInsts[i];
1016    DIE *Die = ConcreteInst->getDie();
1017
1018    unsigned StartID = ConcreteInst->getStartLabelID();
1019    unsigned EndID = ConcreteInst->getEndLabelID();
1020
1021    // Add the scope bounds.
1022    if (StartID)
1023      AddLabel(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1024               DWLabel("label", StartID));
1025    else
1026      AddLabel(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1027               DWLabel("func_begin", SubprogramCount));
1028
1029    if (EndID)
1030      AddLabel(Die, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1031               DWLabel("label", EndID));
1032    else
1033      AddLabel(Die, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1034               DWLabel("func_end", SubprogramCount));
1035
1036    ParentDie->AddChild(Die);
1037  }
1038
1039  // Add nested scopes.
1040  SmallVector<DbgScope *, 4> &Scopes = ParentScope->getScopes();
1041  for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1042    // Define the Scope debug information entry.
1043    DbgScope *Scope = Scopes[j];
1044
1045    unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1046    unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
1047
1048    // Ignore empty scopes.
1049    if (StartID == EndID && StartID != 0) continue;
1050
1051    // Do not ignore inlined scopes even if they don't have any variables or
1052    // scopes.
1053    if (Scope->getScopes().empty() && Scope->getVariables().empty() &&
1054        Scope->getConcreteInsts().empty())
1055      continue;
1056
1057    if (StartID == ParentStartID && EndID == ParentEndID) {
1058      // Just add stuff to the parent scope.
1059      ConstructDbgScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
1060    } else {
1061      DIE *ScopeDie = new DIE(dwarf::DW_TAG_lexical_block);
1062
1063      // Add the scope bounds.
1064      if (StartID)
1065        AddLabel(ScopeDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1066                 DWLabel("label", StartID));
1067      else
1068        AddLabel(ScopeDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1069                 DWLabel("func_begin", SubprogramCount));
1070
1071      if (EndID)
1072        AddLabel(ScopeDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1073                 DWLabel("label", EndID));
1074      else
1075        AddLabel(ScopeDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1076                 DWLabel("func_end", SubprogramCount));
1077
1078      // Add the scope's contents.
1079      ConstructDbgScope(Scope, StartID, EndID, ScopeDie, Unit);
1080      ParentDie->AddChild(ScopeDie);
1081    }
1082  }
1083}
1084
1085/// ConstructFunctionDbgScope - Construct the scope for the subprogram.
1086///
1087void DwarfDebug::ConstructFunctionDbgScope(DbgScope *RootScope,
1088                                           bool AbstractScope) {
1089  // Exit if there is no root scope.
1090  if (!RootScope) return;
1091  DIDescriptor Desc = RootScope->getDesc();
1092  if (Desc.isNull())
1093    return;
1094
1095  // Get the subprogram debug information entry.
1096  DISubprogram SPD(Desc.getGV());
1097
1098  // Get the subprogram die.
1099  DIE *SPDie = ModuleCU->getDieMapSlotFor(SPD.getGV());
1100  assert(SPDie && "Missing subprogram descriptor");
1101
1102  if (!AbstractScope) {
1103    // Add the function bounds.
1104    AddLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1105             DWLabel("func_begin", SubprogramCount));
1106    AddLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1107             DWLabel("func_end", SubprogramCount));
1108    MachineLocation Location(RI->getFrameRegister(*MF));
1109    AddAddress(SPDie, dwarf::DW_AT_frame_base, Location);
1110  }
1111
1112  ConstructDbgScope(RootScope, 0, 0, SPDie, ModuleCU);
1113}
1114
1115/// ConstructDefaultDbgScope - Construct a default scope for the subprogram.
1116///
1117void DwarfDebug::ConstructDefaultDbgScope(MachineFunction *MF) {
1118  const char *FnName = MF->getFunction()->getNameStart();
1119  StringMap<DIE*> &Globals = ModuleCU->getGlobals();
1120  StringMap<DIE*>::iterator GI = Globals.find(FnName);
1121  if (GI != Globals.end()) {
1122    DIE *SPDie = GI->second;
1123
1124    // Add the function bounds.
1125    AddLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1126             DWLabel("func_begin", SubprogramCount));
1127    AddLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
1128             DWLabel("func_end", SubprogramCount));
1129
1130    MachineLocation Location(RI->getFrameRegister(*MF));
1131    AddAddress(SPDie, dwarf::DW_AT_frame_base, Location);
1132  }
1133}
1134
1135/// GetOrCreateSourceID - Look up the source id with the given directory and
1136/// source file names. If none currently exists, create a new id and insert it
1137/// in the SourceIds map. This can update DirectoryNames and SourceFileNames
1138/// maps as well.
1139unsigned DwarfDebug::GetOrCreateSourceID(const std::string &DirName,
1140                                         const std::string &FileName) {
1141  unsigned DId;
1142  StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
1143  if (DI != DirectoryIdMap.end()) {
1144    DId = DI->getValue();
1145  } else {
1146    DId = DirectoryNames.size() + 1;
1147    DirectoryIdMap[DirName] = DId;
1148    DirectoryNames.push_back(DirName);
1149  }
1150
1151  unsigned FId;
1152  StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
1153  if (FI != SourceFileIdMap.end()) {
1154    FId = FI->getValue();
1155  } else {
1156    FId = SourceFileNames.size() + 1;
1157    SourceFileIdMap[FileName] = FId;
1158    SourceFileNames.push_back(FileName);
1159  }
1160
1161  DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
1162    SourceIdMap.find(std::make_pair(DId, FId));
1163  if (SI != SourceIdMap.end())
1164    return SI->second;
1165
1166  unsigned SrcId = SourceIds.size() + 1;  // DW_AT_decl_file cannot be 0.
1167  SourceIdMap[std::make_pair(DId, FId)] = SrcId;
1168  SourceIds.push_back(std::make_pair(DId, FId));
1169
1170  return SrcId;
1171}
1172
1173void DwarfDebug::ConstructCompileUnit(GlobalVariable *GV) {
1174  DICompileUnit DIUnit(GV);
1175  std::string Dir, FN, Prod;
1176  unsigned ID = GetOrCreateSourceID(DIUnit.getDirectory(Dir),
1177                                    DIUnit.getFilename(FN));
1178
1179  DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
1180  AddSectionOffset(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
1181                   DWLabel("section_line", 0), DWLabel("section_line", 0),
1182                   false);
1183  AddString(Die, dwarf::DW_AT_producer, dwarf::DW_FORM_string,
1184            DIUnit.getProducer(Prod));
1185  AddUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data1,
1186          DIUnit.getLanguage());
1187  AddString(Die, dwarf::DW_AT_name, dwarf::DW_FORM_string, FN);
1188
1189  if (!Dir.empty())
1190    AddString(Die, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string, Dir);
1191  if (DIUnit.isOptimized())
1192    AddUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1193
1194  std::string Flags;
1195  DIUnit.getFlags(Flags);
1196  if (!Flags.empty())
1197    AddString(Die, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string, Flags);
1198
1199  unsigned RVer = DIUnit.getRunTimeVersion();
1200  if (RVer)
1201    AddUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
1202            dwarf::DW_FORM_data1, RVer);
1203
1204  CompileUnit *Unit = new CompileUnit(ID, Die);
1205  if (!ModuleCU && DIUnit.isMain()) {
1206    // Use first compile unit marked as isMain as the compile unit
1207    // for this module.
1208    ModuleCU = Unit;
1209  }
1210
1211  CompileUnitMap[DIUnit.getGV()] = Unit;
1212  CompileUnits.push_back(Unit);
1213}
1214
1215void DwarfDebug::ConstructGlobalVariableDIE(GlobalVariable *GV) {
1216  DIGlobalVariable DI_GV(GV);
1217
1218  // Check for pre-existence.
1219  DIE *&Slot = ModuleCU->getDieMapSlotFor(DI_GV.getGV());
1220  if (Slot)
1221    return;
1222
1223  DIE *VariableDie = CreateGlobalVariableDIE(ModuleCU, DI_GV);
1224
1225  // Add address.
1226  DIEBlock *Block = new DIEBlock();
1227  AddUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1228  std::string GLN;
1229  AddObjectLabel(Block, 0, dwarf::DW_FORM_udata,
1230                 Asm->getGlobalLinkName(DI_GV.getGlobal(), GLN));
1231  AddBlock(VariableDie, dwarf::DW_AT_location, 0, Block);
1232
1233  // Add to map.
1234  Slot = VariableDie;
1235
1236  // Add to context owner.
1237  ModuleCU->getDie()->AddChild(VariableDie);
1238
1239  // Expose as global. FIXME - need to check external flag.
1240  std::string Name;
1241  ModuleCU->AddGlobal(DI_GV.getName(Name), VariableDie);
1242  return;
1243}
1244
1245void DwarfDebug::ConstructSubprogram(GlobalVariable *GV) {
1246  DISubprogram SP(GV);
1247
1248  // Check for pre-existence.
1249  DIE *&Slot = ModuleCU->getDieMapSlotFor(GV);
1250  if (Slot)
1251    return;
1252
1253  if (!SP.isDefinition())
1254    // This is a method declaration which will be handled while constructing
1255    // class type.
1256    return;
1257
1258  DIE *SubprogramDie = CreateSubprogramDIE(ModuleCU, SP);
1259
1260  // Add to map.
1261  Slot = SubprogramDie;
1262
1263  // Add to context owner.
1264  ModuleCU->getDie()->AddChild(SubprogramDie);
1265
1266  // Expose as global.
1267  std::string Name;
1268  ModuleCU->AddGlobal(SP.getName(Name), SubprogramDie);
1269  return;
1270}
1271
1272  /// BeginModule - Emit all Dwarf sections that should come prior to the
1273  /// content. Create global DIEs and emit initial debug info sections.
1274  /// This is inovked by the target AsmPrinter.
1275void DwarfDebug::BeginModule(Module *M, MachineModuleInfo *mmi) {
1276  this->M = M;
1277
1278  if (TimePassesIsEnabled)
1279    DebugTimer->startTimer();
1280
1281  SmallVector<GlobalVariable *, 2> CUs;
1282  SmallVector<GlobalVariable *, 4> GVs;
1283  SmallVector<GlobalVariable *, 4> SPs;
1284  CollectDebugInfoAnchors(*M, CUs, GVs, SPs);
1285
1286  // Create all the compile unit DIEs.
1287  for (SmallVector<GlobalVariable *, 2>::iterator I = CUs.begin(),
1288         E = CUs.end(); I != E; ++I)
1289    ConstructCompileUnit(*I);
1290
1291  if (CompileUnits.empty()) {
1292    if (TimePassesIsEnabled)
1293      DebugTimer->stopTimer();
1294
1295    return;
1296  }
1297
1298  // If main compile unit for this module is not seen than randomly
1299  // select first compile unit.
1300  if (!ModuleCU)
1301    ModuleCU = CompileUnits[0];
1302
1303  // If there is not any debug info available for any global variables and any
1304  // subprograms then there is not any debug info to emit.
1305  if (GVs.empty() && SPs.empty()) {
1306    if (TimePassesIsEnabled)
1307      DebugTimer->stopTimer();
1308
1309    return;
1310  }
1311
1312  // Create DIEs for each of the externally visible global variables.
1313  for (SmallVector<GlobalVariable *, 4>::iterator I = GVs.begin(),
1314         E = GVs.end(); I != E; ++I)
1315    ConstructGlobalVariableDIE(*I);
1316
1317  // Create DIEs for each of the externally visible subprograms.
1318  for (SmallVector<GlobalVariable *, 4>::iterator I = SPs.begin(),
1319         E = SPs.end(); I != E; ++I)
1320    ConstructSubprogram(*I);
1321
1322  MMI = mmi;
1323  shouldEmit = true;
1324  MMI->setDebugInfoAvailability(true);
1325
1326  // Prime section data.
1327  SectionMap.insert(TAI->getTextSection());
1328
1329  // Print out .file directives to specify files for .loc directives. These are
1330  // printed out early so that they precede any .loc directives.
1331  if (TAI->hasDotLocAndDotFile()) {
1332    for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
1333      // Remember source id starts at 1.
1334      std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
1335      sys::Path FullPath(getSourceDirectoryName(Id.first));
1336      bool AppendOk =
1337        FullPath.appendComponent(getSourceFileName(Id.second));
1338      assert(AppendOk && "Could not append filename to directory!");
1339      AppendOk = false;
1340      Asm->EmitFile(i, FullPath.toString());
1341      Asm->EOL();
1342    }
1343  }
1344
1345  // Emit initial sections
1346  EmitInitial();
1347
1348  if (TimePassesIsEnabled)
1349    DebugTimer->stopTimer();
1350}
1351
1352/// EndModule - Emit all Dwarf sections that should come after the content.
1353///
1354void DwarfDebug::EndModule() {
1355  if (!ShouldEmitDwarfDebug())
1356    return;
1357
1358  if (TimePassesIsEnabled)
1359    DebugTimer->startTimer();
1360
1361  // Standard sections final addresses.
1362  Asm->SwitchToSection(TAI->getTextSection());
1363  EmitLabel("text_end", 0);
1364  Asm->SwitchToSection(TAI->getDataSection());
1365  EmitLabel("data_end", 0);
1366
1367  // End text sections.
1368  for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
1369    Asm->SwitchToSection(SectionMap[i]);
1370    EmitLabel("section_end", i);
1371  }
1372
1373  // Emit common frame information.
1374  EmitCommonDebugFrame();
1375
1376  // Emit function debug frame information
1377  for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
1378         E = DebugFrames.end(); I != E; ++I)
1379    EmitFunctionDebugFrame(*I);
1380
1381  // Compute DIE offsets and sizes.
1382  SizeAndOffsets();
1383
1384  // Emit all the DIEs into a debug info section
1385  EmitDebugInfo();
1386
1387  // Corresponding abbreviations into a abbrev section.
1388  EmitAbbreviations();
1389
1390  // Emit source line correspondence into a debug line section.
1391  EmitDebugLines();
1392
1393  // Emit info into a debug pubnames section.
1394  EmitDebugPubNames();
1395
1396  // Emit info into a debug str section.
1397  EmitDebugStr();
1398
1399  // Emit info into a debug loc section.
1400  EmitDebugLoc();
1401
1402  // Emit info into a debug aranges section.
1403  EmitDebugARanges();
1404
1405  // Emit info into a debug ranges section.
1406  EmitDebugRanges();
1407
1408  // Emit info into a debug macinfo section.
1409  EmitDebugMacInfo();
1410
1411  // Emit inline info.
1412  EmitDebugInlineInfo();
1413
1414  if (TimePassesIsEnabled)
1415    DebugTimer->stopTimer();
1416}
1417
1418/// BeginFunction - Gather pre-function debug information.  Assumes being
1419/// emitted immediately after the function entry point.
1420void DwarfDebug::BeginFunction(MachineFunction *MF) {
1421  this->MF = MF;
1422
1423  if (!ShouldEmitDwarfDebug()) return;
1424
1425  if (TimePassesIsEnabled)
1426    DebugTimer->startTimer();
1427
1428  // Begin accumulating function debug information.
1429  MMI->BeginFunction(MF);
1430
1431  // Assumes in correct section after the entry point.
1432  EmitLabel("func_begin", ++SubprogramCount);
1433
1434  // Emit label for the implicitly defined dbg.stoppoint at the start of the
1435  // function.
1436  DebugLoc FDL = MF->getDefaultDebugLoc();
1437  if (!FDL.isUnknown()) {
1438    DebugLocTuple DLT = MF->getDebugLocTuple(FDL);
1439    unsigned LabelID = RecordSourceLine(DLT.Line, DLT.Col,
1440                                        DICompileUnit(DLT.CompileUnit));
1441    Asm->printLabel(LabelID);
1442  }
1443
1444  if (TimePassesIsEnabled)
1445    DebugTimer->stopTimer();
1446}
1447
1448/// EndFunction - Gather and emit post-function debug information.
1449///
1450void DwarfDebug::EndFunction(MachineFunction *MF) {
1451  if (!ShouldEmitDwarfDebug()) return;
1452
1453  if (TimePassesIsEnabled)
1454    DebugTimer->startTimer();
1455
1456  // Define end label for subprogram.
1457  EmitLabel("func_end", SubprogramCount);
1458
1459  // Get function line info.
1460  if (!Lines.empty()) {
1461    // Get section line info.
1462    unsigned ID = SectionMap.insert(Asm->CurrentSection_);
1463    if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
1464    std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
1465    // Append the function info to section info.
1466    SectionLineInfos.insert(SectionLineInfos.end(),
1467                            Lines.begin(), Lines.end());
1468  }
1469
1470  // Construct the DbgScope for abstract instances.
1471  for (SmallVector<DbgScope *, 32>::iterator
1472         I = AbstractInstanceRootList.begin(),
1473         E = AbstractInstanceRootList.end(); I != E; ++I)
1474    ConstructFunctionDbgScope(*I);
1475
1476  // Construct scopes for subprogram.
1477  if (FunctionDbgScope)
1478    ConstructFunctionDbgScope(FunctionDbgScope);
1479  else
1480    // FIXME: This is wrong. We are essentially getting past a problem with
1481    // debug information not being able to handle unreachable blocks that have
1482    // debug information in them. In particular, those unreachable blocks that
1483    // have "region end" info in them. That situation results in the "root
1484    // scope" not being created. If that's the case, then emit a "default"
1485    // scope, i.e., one that encompasses the whole function. This isn't
1486    // desirable. And a better way of handling this (and all of the debugging
1487    // information) needs to be explored.
1488    ConstructDefaultDbgScope(MF);
1489
1490  DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
1491                                               MMI->getFrameMoves()));
1492
1493  // Clear debug info
1494  if (FunctionDbgScope) {
1495    delete FunctionDbgScope;
1496    DbgScopeMap.clear();
1497    DbgAbstractScopeMap.clear();
1498    DbgConcreteScopeMap.clear();
1499    InlinedVariableScopes.clear();
1500    FunctionDbgScope = NULL;
1501    LexicalScopeStack.clear();
1502    AbstractInstanceRootList.clear();
1503    AbstractInstanceRootMap.clear();
1504  }
1505
1506  Lines.clear();
1507
1508  if (TimePassesIsEnabled)
1509    DebugTimer->stopTimer();
1510}
1511
1512/// RecordSourceLine - Records location information and associates it with a
1513/// label. Returns a unique label ID used to generate a label and provide
1514/// correspondence to the source line list.
1515unsigned DwarfDebug::RecordSourceLine(Value *V, unsigned Line, unsigned Col) {
1516  if (TimePassesIsEnabled)
1517    DebugTimer->startTimer();
1518
1519  CompileUnit *Unit = CompileUnitMap[V];
1520  assert(Unit && "Unable to find CompileUnit");
1521  unsigned ID = MMI->NextLabelID();
1522  Lines.push_back(SrcLineInfo(Line, Col, Unit->getID(), ID));
1523
1524  if (TimePassesIsEnabled)
1525    DebugTimer->stopTimer();
1526
1527  return ID;
1528}
1529
1530/// RecordSourceLine - Records location information and associates it with a
1531/// label. Returns a unique label ID used to generate a label and provide
1532/// correspondence to the source line list.
1533unsigned DwarfDebug::RecordSourceLine(unsigned Line, unsigned Col,
1534                                      DICompileUnit CU) {
1535  if (TimePassesIsEnabled)
1536    DebugTimer->startTimer();
1537
1538  std::string Dir, Fn;
1539  unsigned Src = GetOrCreateSourceID(CU.getDirectory(Dir),
1540                                     CU.getFilename(Fn));
1541  unsigned ID = MMI->NextLabelID();
1542  Lines.push_back(SrcLineInfo(Line, Col, Src, ID));
1543
1544  if (TimePassesIsEnabled)
1545    DebugTimer->stopTimer();
1546
1547  return ID;
1548}
1549
1550/// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be
1551/// timed. Look up the source id with the given directory and source file
1552/// names. If none currently exists, create a new id and insert it in the
1553/// SourceIds map. This can update DirectoryNames and SourceFileNames maps as
1554/// well.
1555unsigned DwarfDebug::getOrCreateSourceID(const std::string &DirName,
1556                                         const std::string &FileName) {
1557  if (TimePassesIsEnabled)
1558    DebugTimer->startTimer();
1559
1560  unsigned SrcId = GetOrCreateSourceID(DirName, FileName);
1561
1562  if (TimePassesIsEnabled)
1563    DebugTimer->stopTimer();
1564
1565  return SrcId;
1566}
1567
1568/// RecordRegionStart - Indicate the start of a region.
1569unsigned DwarfDebug::RecordRegionStart(GlobalVariable *V) {
1570  if (TimePassesIsEnabled)
1571    DebugTimer->startTimer();
1572
1573  DbgScope *Scope = getOrCreateScope(V);
1574  unsigned ID = MMI->NextLabelID();
1575  if (!Scope->getStartLabelID()) Scope->setStartLabelID(ID);
1576  LexicalScopeStack.push_back(Scope);
1577
1578  if (TimePassesIsEnabled)
1579    DebugTimer->stopTimer();
1580
1581  return ID;
1582}
1583
1584/// RecordRegionEnd - Indicate the end of a region.
1585unsigned DwarfDebug::RecordRegionEnd(GlobalVariable *V) {
1586  if (TimePassesIsEnabled)
1587    DebugTimer->startTimer();
1588
1589  DbgScope *Scope = getOrCreateScope(V);
1590  unsigned ID = MMI->NextLabelID();
1591  Scope->setEndLabelID(ID);
1592  // FIXME : region.end() may not be in the last basic block.
1593  // For now, do not pop last lexical scope because next basic
1594  // block may start new inlined function's body.
1595  unsigned LSSize = LexicalScopeStack.size();
1596  if (LSSize != 0 && LSSize != 1)
1597    LexicalScopeStack.pop_back();
1598
1599  if (TimePassesIsEnabled)
1600    DebugTimer->stopTimer();
1601
1602  return ID;
1603}
1604
1605/// RecordVariable - Indicate the declaration of a local variable.
1606void DwarfDebug::RecordVariable(GlobalVariable *GV, unsigned FrameIndex,
1607                                const MachineInstr *MI) {
1608  if (TimePassesIsEnabled)
1609    DebugTimer->startTimer();
1610
1611  DIDescriptor Desc(GV);
1612  DbgScope *Scope = NULL;
1613  bool InlinedFnVar = false;
1614
1615  if (Desc.getTag() == dwarf::DW_TAG_variable) {
1616    // GV is a global variable.
1617    DIGlobalVariable DG(GV);
1618    Scope = getOrCreateScope(DG.getContext().getGV());
1619  } else {
1620    DenseMap<const MachineInstr *, DbgScope *>::iterator
1621      SI = InlinedVariableScopes.find(MI);
1622
1623    if (SI != InlinedVariableScopes.end()) {
1624      // or GV is an inlined local variable.
1625      Scope = SI->second;
1626      InlinedFnVar = true;
1627    } else {
1628      DIVariable DV(GV);
1629      GlobalVariable *V = DV.getContext().getGV();
1630
1631      // or GV is a local variable.
1632      Scope = getOrCreateScope(V);
1633    }
1634  }
1635
1636  assert(Scope && "Unable to find the variable's scope");
1637  DbgVariable *DV = new DbgVariable(DIVariable(GV), FrameIndex, InlinedFnVar);
1638  Scope->AddVariable(DV);
1639
1640  if (TimePassesIsEnabled)
1641    DebugTimer->stopTimer();
1642}
1643
1644//// RecordInlinedFnStart - Indicate the start of inlined subroutine.
1645unsigned DwarfDebug::RecordInlinedFnStart(DISubprogram &SP, DICompileUnit CU,
1646                                          unsigned Line, unsigned Col) {
1647  unsigned LabelID = MMI->NextLabelID();
1648
1649  if (!TAI->doesDwarfUsesInlineInfoSection())
1650    return LabelID;
1651
1652  if (TimePassesIsEnabled)
1653    DebugTimer->startTimer();
1654
1655  GlobalVariable *GV = SP.getGV();
1656  DenseMap<const GlobalVariable *, DbgScope *>::iterator
1657    II = AbstractInstanceRootMap.find(GV);
1658
1659  if (II == AbstractInstanceRootMap.end()) {
1660    // Create an abstract instance entry for this inlined function if it doesn't
1661    // already exist.
1662    DbgScope *Scope = new DbgScope(NULL, DIDescriptor(GV));
1663
1664    // Get the compile unit context.
1665    DIE *SPDie = ModuleCU->getDieMapSlotFor(GV);
1666    if (!SPDie)
1667      SPDie = CreateSubprogramDIE(ModuleCU, SP, false, true);
1668
1669    // Mark as being inlined. This makes this subprogram entry an abstract
1670    // instance root.
1671    // FIXME: Our debugger doesn't care about the value of DW_AT_inline, only
1672    // that it's defined. That probably won't change in the future. However,
1673    // this could be more elegant.
1674    AddUInt(SPDie, dwarf::DW_AT_inline, 0, dwarf::DW_INL_declared_not_inlined);
1675
1676    // Keep track of the abstract scope for this function.
1677    DbgAbstractScopeMap[GV] = Scope;
1678
1679    AbstractInstanceRootMap[GV] = Scope;
1680    AbstractInstanceRootList.push_back(Scope);
1681  }
1682
1683  // Create a concrete inlined instance for this inlined function.
1684  DbgConcreteScope *ConcreteScope = new DbgConcreteScope(DIDescriptor(GV));
1685  DIE *ScopeDie = new DIE(dwarf::DW_TAG_inlined_subroutine);
1686  ScopeDie->setAbstractCompileUnit(ModuleCU);
1687
1688  DIE *Origin = ModuleCU->getDieMapSlotFor(GV);
1689  AddDIEEntry(ScopeDie, dwarf::DW_AT_abstract_origin,
1690              dwarf::DW_FORM_ref4, Origin);
1691  AddUInt(ScopeDie, dwarf::DW_AT_call_file, 0, ModuleCU->getID());
1692  AddUInt(ScopeDie, dwarf::DW_AT_call_line, 0, Line);
1693  AddUInt(ScopeDie, dwarf::DW_AT_call_column, 0, Col);
1694
1695  ConcreteScope->setDie(ScopeDie);
1696  ConcreteScope->setStartLabelID(LabelID);
1697  MMI->RecordUsedDbgLabel(LabelID);
1698
1699  LexicalScopeStack.back()->AddConcreteInst(ConcreteScope);
1700
1701  // Keep track of the concrete scope that's inlined into this function.
1702  DenseMap<GlobalVariable *, SmallVector<DbgScope *, 8> >::iterator
1703    SI = DbgConcreteScopeMap.find(GV);
1704
1705  if (SI == DbgConcreteScopeMap.end())
1706    DbgConcreteScopeMap[GV].push_back(ConcreteScope);
1707  else
1708    SI->second.push_back(ConcreteScope);
1709
1710  // Track the start label for this inlined function.
1711  DenseMap<GlobalVariable *, SmallVector<unsigned, 4> >::iterator
1712    I = InlineInfo.find(GV);
1713
1714  if (I == InlineInfo.end())
1715    InlineInfo[GV].push_back(LabelID);
1716  else
1717    I->second.push_back(LabelID);
1718
1719  if (TimePassesIsEnabled)
1720    DebugTimer->stopTimer();
1721
1722  return LabelID;
1723}
1724
1725/// RecordInlinedFnEnd - Indicate the end of inlined subroutine.
1726unsigned DwarfDebug::RecordInlinedFnEnd(DISubprogram &SP) {
1727  if (!TAI->doesDwarfUsesInlineInfoSection())
1728    return 0;
1729
1730  if (TimePassesIsEnabled)
1731    DebugTimer->startTimer();
1732
1733  GlobalVariable *GV = SP.getGV();
1734  DenseMap<GlobalVariable *, SmallVector<DbgScope *, 8> >::iterator
1735    I = DbgConcreteScopeMap.find(GV);
1736
1737  if (I == DbgConcreteScopeMap.end()) {
1738    // FIXME: Can this situation actually happen? And if so, should it?
1739    if (TimePassesIsEnabled)
1740      DebugTimer->stopTimer();
1741
1742    return 0;
1743  }
1744
1745  SmallVector<DbgScope *, 8> &Scopes = I->second;
1746  if (Scopes.empty()) {
1747    // Returned ID is 0 if this is unbalanced "end of inlined
1748    // scope". This could happen if optimizer eats dbg intrinsics
1749    // or "beginning of inlined scope" is not recoginized due to
1750    // missing location info. In such cases, ignore this region.end.
1751    return 0;
1752  }
1753
1754  DbgScope *Scope = Scopes.back(); Scopes.pop_back();
1755  unsigned ID = MMI->NextLabelID();
1756  MMI->RecordUsedDbgLabel(ID);
1757  Scope->setEndLabelID(ID);
1758
1759  if (TimePassesIsEnabled)
1760    DebugTimer->stopTimer();
1761
1762  return ID;
1763}
1764
1765/// RecordVariableScope - Record scope for the variable declared by
1766/// DeclareMI. DeclareMI must describe TargetInstrInfo::DECLARE. Record scopes
1767/// for only inlined subroutine variables. Other variables's scopes are
1768/// determined during RecordVariable().
1769void DwarfDebug::RecordVariableScope(DIVariable &DV,
1770                                     const MachineInstr *DeclareMI) {
1771  if (TimePassesIsEnabled)
1772    DebugTimer->startTimer();
1773
1774  DISubprogram SP(DV.getContext().getGV());
1775
1776  if (SP.isNull()) {
1777    if (TimePassesIsEnabled)
1778      DebugTimer->stopTimer();
1779
1780    return;
1781  }
1782
1783  DenseMap<GlobalVariable *, DbgScope *>::iterator
1784    I = DbgAbstractScopeMap.find(SP.getGV());
1785  if (I != DbgAbstractScopeMap.end())
1786    InlinedVariableScopes[DeclareMI] = I->second;
1787
1788  if (TimePassesIsEnabled)
1789    DebugTimer->stopTimer();
1790}
1791
1792//===----------------------------------------------------------------------===//
1793// Emit Methods
1794//===----------------------------------------------------------------------===//
1795
1796/// SizeAndOffsetDie - Compute the size and offset of a DIE.
1797///
1798unsigned DwarfDebug::SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
1799  // Get the children.
1800  const std::vector<DIE *> &Children = Die->getChildren();
1801
1802  // If not last sibling and has children then add sibling offset attribute.
1803  if (!Last && !Children.empty()) Die->AddSiblingOffset();
1804
1805  // Record the abbreviation.
1806  AssignAbbrevNumber(Die->getAbbrev());
1807
1808  // Get the abbreviation for this DIE.
1809  unsigned AbbrevNumber = Die->getAbbrevNumber();
1810  const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1811
1812  // Set DIE offset
1813  Die->setOffset(Offset);
1814
1815  // Start the size with the size of abbreviation code.
1816  Offset += TargetAsmInfo::getULEB128Size(AbbrevNumber);
1817
1818  const SmallVector<DIEValue*, 32> &Values = Die->getValues();
1819  const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1820
1821  // Size the DIE attribute values.
1822  for (unsigned i = 0, N = Values.size(); i < N; ++i)
1823    // Size attribute value.
1824    Offset += Values[i]->SizeOf(TD, AbbrevData[i].getForm());
1825
1826  // Size the DIE children if any.
1827  if (!Children.empty()) {
1828    assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1829           "Children flag not set");
1830
1831    for (unsigned j = 0, M = Children.size(); j < M; ++j)
1832      Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
1833
1834    // End of children marker.
1835    Offset += sizeof(int8_t);
1836  }
1837
1838  Die->setSize(Offset - Die->getOffset());
1839  return Offset;
1840}
1841
1842/// SizeAndOffsets - Compute the size and offset of all the DIEs.
1843///
1844void DwarfDebug::SizeAndOffsets() {
1845  // Compute size of compile unit header.
1846  static unsigned Offset =
1847    sizeof(int32_t) + // Length of Compilation Unit Info
1848    sizeof(int16_t) + // DWARF version number
1849    sizeof(int32_t) + // Offset Into Abbrev. Section
1850    sizeof(int8_t);   // Pointer Size (in bytes)
1851
1852  SizeAndOffsetDie(ModuleCU->getDie(), Offset, true);
1853  CompileUnitOffsets[ModuleCU] = 0;
1854}
1855
1856/// EmitInitial - Emit initial Dwarf declarations.  This is necessary for cc
1857/// tools to recognize the object file contains Dwarf information.
1858void DwarfDebug::EmitInitial() {
1859  // Check to see if we already emitted intial headers.
1860  if (didInitial) return;
1861  didInitial = true;
1862
1863  // Dwarf sections base addresses.
1864  if (TAI->doesDwarfRequireFrameSection()) {
1865    Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
1866    EmitLabel("section_debug_frame", 0);
1867  }
1868
1869  Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
1870  EmitLabel("section_info", 0);
1871  Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
1872  EmitLabel("section_abbrev", 0);
1873  Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
1874  EmitLabel("section_aranges", 0);
1875
1876  if (const char *LineInfoDirective = TAI->getDwarfMacroInfoSection()) {
1877    Asm->SwitchToDataSection(LineInfoDirective);
1878    EmitLabel("section_macinfo", 0);
1879  }
1880
1881  Asm->SwitchToDataSection(TAI->getDwarfLineSection());
1882  EmitLabel("section_line", 0);
1883  Asm->SwitchToDataSection(TAI->getDwarfLocSection());
1884  EmitLabel("section_loc", 0);
1885  Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
1886  EmitLabel("section_pubnames", 0);
1887  Asm->SwitchToDataSection(TAI->getDwarfStrSection());
1888  EmitLabel("section_str", 0);
1889  Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
1890  EmitLabel("section_ranges", 0);
1891
1892  Asm->SwitchToSection(TAI->getTextSection());
1893  EmitLabel("text_begin", 0);
1894  Asm->SwitchToSection(TAI->getDataSection());
1895  EmitLabel("data_begin", 0);
1896}
1897
1898/// EmitDIE - Recusively Emits a debug information entry.
1899///
1900void DwarfDebug::EmitDIE(DIE *Die) {
1901  // Get the abbreviation for this DIE.
1902  unsigned AbbrevNumber = Die->getAbbrevNumber();
1903  const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1904
1905  Asm->EOL();
1906
1907  // Emit the code (index) for the abbreviation.
1908  Asm->EmitULEB128Bytes(AbbrevNumber);
1909
1910  if (Asm->isVerbose())
1911    Asm->EOL(std::string("Abbrev [" +
1912                         utostr(AbbrevNumber) +
1913                         "] 0x" + utohexstr(Die->getOffset()) +
1914                         ":0x" + utohexstr(Die->getSize()) + " " +
1915                         dwarf::TagString(Abbrev->getTag())));
1916  else
1917    Asm->EOL();
1918
1919  SmallVector<DIEValue*, 32> &Values = Die->getValues();
1920  const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1921
1922  // Emit the DIE attribute values.
1923  for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1924    unsigned Attr = AbbrevData[i].getAttribute();
1925    unsigned Form = AbbrevData[i].getForm();
1926    assert(Form && "Too many attributes for DIE (check abbreviation)");
1927
1928    switch (Attr) {
1929    case dwarf::DW_AT_sibling:
1930      Asm->EmitInt32(Die->SiblingOffset());
1931      break;
1932    case dwarf::DW_AT_abstract_origin: {
1933      DIEEntry *E = cast<DIEEntry>(Values[i]);
1934      DIE *Origin = E->getEntry();
1935      unsigned Addr =
1936        CompileUnitOffsets[Die->getAbstractCompileUnit()] +
1937        Origin->getOffset();
1938
1939      Asm->EmitInt32(Addr);
1940      break;
1941    }
1942    default:
1943      // Emit an attribute using the defined form.
1944      Values[i]->EmitValue(this, Form);
1945      break;
1946    }
1947
1948    Asm->EOL(dwarf::AttributeString(Attr));
1949  }
1950
1951  // Emit the DIE children if any.
1952  if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
1953    const std::vector<DIE *> &Children = Die->getChildren();
1954
1955    for (unsigned j = 0, M = Children.size(); j < M; ++j)
1956      EmitDIE(Children[j]);
1957
1958    Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
1959  }
1960}
1961
1962/// EmitDebugInfo / EmitDebugInfoPerCU - Emit the debug info section.
1963///
1964void DwarfDebug::EmitDebugInfoPerCU(CompileUnit *Unit) {
1965  DIE *Die = Unit->getDie();
1966
1967  // Emit the compile units header.
1968  EmitLabel("info_begin", Unit->getID());
1969
1970  // Emit size of content not including length itself
1971  unsigned ContentSize = Die->getSize() +
1972    sizeof(int16_t) + // DWARF version number
1973    sizeof(int32_t) + // Offset Into Abbrev. Section
1974    sizeof(int8_t) +  // Pointer Size (in bytes)
1975    sizeof(int32_t);  // FIXME - extra pad for gdb bug.
1976
1977  Asm->EmitInt32(ContentSize);  Asm->EOL("Length of Compilation Unit Info");
1978  Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF version number");
1979  EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
1980  Asm->EOL("Offset Into Abbrev. Section");
1981  Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
1982
1983  EmitDIE(Die);
1984  // FIXME - extra padding for gdb bug.
1985  Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
1986  Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
1987  Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
1988  Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
1989  EmitLabel("info_end", Unit->getID());
1990
1991  Asm->EOL();
1992}
1993
1994void DwarfDebug::EmitDebugInfo() {
1995  // Start debug info section.
1996  Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
1997
1998  EmitDebugInfoPerCU(ModuleCU);
1999}
2000
2001/// EmitAbbreviations - Emit the abbreviation section.
2002///
2003void DwarfDebug::EmitAbbreviations() const {
2004  // Check to see if it is worth the effort.
2005  if (!Abbreviations.empty()) {
2006    // Start the debug abbrev section.
2007    Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2008
2009    EmitLabel("abbrev_begin", 0);
2010
2011    // For each abbrevation.
2012    for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2013      // Get abbreviation data
2014      const DIEAbbrev *Abbrev = Abbreviations[i];
2015
2016      // Emit the abbrevations code (base 1 index.)
2017      Asm->EmitULEB128Bytes(Abbrev->getNumber());
2018      Asm->EOL("Abbreviation Code");
2019
2020      // Emit the abbreviations data.
2021      Abbrev->Emit(Asm);
2022
2023      Asm->EOL();
2024    }
2025
2026    // Mark end of abbreviations.
2027    Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2028
2029    EmitLabel("abbrev_end", 0);
2030    Asm->EOL();
2031  }
2032}
2033
2034/// EmitEndOfLineMatrix - Emit the last address of the section and the end of
2035/// the line matrix.
2036///
2037void DwarfDebug::EmitEndOfLineMatrix(unsigned SectionEnd) {
2038  // Define last address of section.
2039  Asm->EmitInt8(0); Asm->EOL("Extended Op");
2040  Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2041  Asm->EmitInt8(dwarf::DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2042  EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2043
2044  // Mark end of matrix.
2045  Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2046  Asm->EmitULEB128Bytes(1); Asm->EOL();
2047  Asm->EmitInt8(1); Asm->EOL();
2048}
2049
2050/// EmitDebugLines - Emit source line information.
2051///
2052void DwarfDebug::EmitDebugLines() {
2053  // If the target is using .loc/.file, the assembler will be emitting the
2054  // .debug_line table automatically.
2055  if (TAI->hasDotLocAndDotFile())
2056    return;
2057
2058  // Minimum line delta, thus ranging from -10..(255-10).
2059  const int MinLineDelta = -(dwarf::DW_LNS_fixed_advance_pc + 1);
2060  // Maximum line delta, thus ranging from -10..(255-10).
2061  const int MaxLineDelta = 255 + MinLineDelta;
2062
2063  // Start the dwarf line section.
2064  Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2065
2066  // Construct the section header.
2067  EmitDifference("line_end", 0, "line_begin", 0, true);
2068  Asm->EOL("Length of Source Line Info");
2069  EmitLabel("line_begin", 0);
2070
2071  Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF version number");
2072
2073  EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2074  Asm->EOL("Prolog Length");
2075  EmitLabel("line_prolog_begin", 0);
2076
2077  Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2078
2079  Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2080
2081  Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
2082
2083  Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2084
2085  Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
2086
2087  // Line number standard opcode encodings argument count
2088  Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2089  Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2090  Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2091  Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2092  Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2093  Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2094  Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2095  Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2096  Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2097
2098  // Emit directories.
2099  for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
2100    Asm->EmitString(getSourceDirectoryName(DI));
2101    Asm->EOL("Directory");
2102  }
2103
2104  Asm->EmitInt8(0); Asm->EOL("End of directories");
2105
2106  // Emit files.
2107  for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
2108    // Remember source id starts at 1.
2109    std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
2110    Asm->EmitString(getSourceFileName(Id.second));
2111    Asm->EOL("Source");
2112    Asm->EmitULEB128Bytes(Id.first);
2113    Asm->EOL("Directory #");
2114    Asm->EmitULEB128Bytes(0);
2115    Asm->EOL("Mod date");
2116    Asm->EmitULEB128Bytes(0);
2117    Asm->EOL("File size");
2118  }
2119
2120  Asm->EmitInt8(0); Asm->EOL("End of files");
2121
2122  EmitLabel("line_prolog_end", 0);
2123
2124  // A sequence for each text section.
2125  unsigned SecSrcLinesSize = SectionSourceLines.size();
2126
2127  for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
2128    // Isolate current sections line info.
2129    const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
2130
2131    if (Asm->isVerbose()) {
2132      const Section* S = SectionMap[j + 1];
2133      O << '\t' << TAI->getCommentString() << " Section"
2134        << S->getName() << '\n';
2135    } else {
2136      Asm->EOL();
2137    }
2138
2139    // Dwarf assumes we start with first line of first source file.
2140    unsigned Source = 1;
2141    unsigned Line = 1;
2142
2143    // Construct rows of the address, source, line, column matrix.
2144    for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2145      const SrcLineInfo &LineInfo = LineInfos[i];
2146      unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2147      if (!LabelID) continue;
2148
2149      if (!Asm->isVerbose())
2150        Asm->EOL();
2151      else {
2152        std::pair<unsigned, unsigned> SourceID =
2153          getSourceDirectoryAndFileIds(LineInfo.getSourceID());
2154        O << '\t' << TAI->getCommentString() << ' '
2155          << getSourceDirectoryName(SourceID.first) << ' '
2156          << getSourceFileName(SourceID.second)
2157          <<" :" << utostr_32(LineInfo.getLine()) << '\n';
2158      }
2159
2160      // Define the line address.
2161      Asm->EmitInt8(0); Asm->EOL("Extended Op");
2162      Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2163      Asm->EmitInt8(dwarf::DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2164      EmitReference("label",  LabelID); Asm->EOL("Location label");
2165
2166      // If change of source, then switch to the new source.
2167      if (Source != LineInfo.getSourceID()) {
2168        Source = LineInfo.getSourceID();
2169        Asm->EmitInt8(dwarf::DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2170        Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2171      }
2172
2173      // If change of line.
2174      if (Line != LineInfo.getLine()) {
2175        // Determine offset.
2176        int Offset = LineInfo.getLine() - Line;
2177        int Delta = Offset - MinLineDelta;
2178
2179        // Update line.
2180        Line = LineInfo.getLine();
2181
2182        // If delta is small enough and in range...
2183        if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2184          // ... then use fast opcode.
2185          Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2186        } else {
2187          // ... otherwise use long hand.
2188          Asm->EmitInt8(dwarf::DW_LNS_advance_line);
2189          Asm->EOL("DW_LNS_advance_line");
2190          Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2191          Asm->EmitInt8(dwarf::DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2192        }
2193      } else {
2194        // Copy the previous row (different address or source)
2195        Asm->EmitInt8(dwarf::DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2196      }
2197    }
2198
2199    EmitEndOfLineMatrix(j + 1);
2200  }
2201
2202  if (SecSrcLinesSize == 0)
2203    // Because we're emitting a debug_line section, we still need a line
2204    // table. The linker and friends expect it to exist. If there's nothing to
2205    // put into it, emit an empty table.
2206    EmitEndOfLineMatrix(1);
2207
2208  EmitLabel("line_end", 0);
2209  Asm->EOL();
2210}
2211
2212/// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
2213///
2214void DwarfDebug::EmitCommonDebugFrame() {
2215  if (!TAI->doesDwarfRequireFrameSection())
2216    return;
2217
2218  int stackGrowth =
2219    Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2220      TargetFrameInfo::StackGrowsUp ?
2221    TD->getPointerSize() : -TD->getPointerSize();
2222
2223  // Start the dwarf frame section.
2224  Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2225
2226  EmitLabel("debug_frame_common", 0);
2227  EmitDifference("debug_frame_common_end", 0,
2228                 "debug_frame_common_begin", 0, true);
2229  Asm->EOL("Length of Common Information Entry");
2230
2231  EmitLabel("debug_frame_common_begin", 0);
2232  Asm->EmitInt32((int)dwarf::DW_CIE_ID);
2233  Asm->EOL("CIE Identifier Tag");
2234  Asm->EmitInt8(dwarf::DW_CIE_VERSION);
2235  Asm->EOL("CIE Version");
2236  Asm->EmitString("");
2237  Asm->EOL("CIE Augmentation");
2238  Asm->EmitULEB128Bytes(1);
2239  Asm->EOL("CIE Code Alignment Factor");
2240  Asm->EmitSLEB128Bytes(stackGrowth);
2241  Asm->EOL("CIE Data Alignment Factor");
2242  Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
2243  Asm->EOL("CIE RA Column");
2244
2245  std::vector<MachineMove> Moves;
2246  RI->getInitialFrameState(Moves);
2247
2248  EmitFrameMoves(NULL, 0, Moves, false);
2249
2250  Asm->EmitAlignment(2, 0, 0, false);
2251  EmitLabel("debug_frame_common_end", 0);
2252
2253  Asm->EOL();
2254}
2255
2256/// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2257/// section.
2258void
2259DwarfDebug::EmitFunctionDebugFrame(const FunctionDebugFrameInfo&DebugFrameInfo){
2260  if (!TAI->doesDwarfRequireFrameSection())
2261    return;
2262
2263  // Start the dwarf frame section.
2264  Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2265
2266  EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2267                 "debug_frame_begin", DebugFrameInfo.Number, true);
2268  Asm->EOL("Length of Frame Information Entry");
2269
2270  EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2271
2272  EmitSectionOffset("debug_frame_common", "section_debug_frame",
2273                    0, 0, true, false);
2274  Asm->EOL("FDE CIE offset");
2275
2276  EmitReference("func_begin", DebugFrameInfo.Number);
2277  Asm->EOL("FDE initial location");
2278  EmitDifference("func_end", DebugFrameInfo.Number,
2279                 "func_begin", DebugFrameInfo.Number);
2280  Asm->EOL("FDE address range");
2281
2282  EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves,
2283                 false);
2284
2285  Asm->EmitAlignment(2, 0, 0, false);
2286  EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2287
2288  Asm->EOL();
2289}
2290
2291void DwarfDebug::EmitDebugPubNamesPerCU(CompileUnit *Unit) {
2292  EmitDifference("pubnames_end", Unit->getID(),
2293                 "pubnames_begin", Unit->getID(), true);
2294  Asm->EOL("Length of Public Names Info");
2295
2296  EmitLabel("pubnames_begin", Unit->getID());
2297
2298  Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("DWARF Version");
2299
2300  EmitSectionOffset("info_begin", "section_info",
2301                    Unit->getID(), 0, true, false);
2302  Asm->EOL("Offset of Compilation Unit Info");
2303
2304  EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),
2305                 true);
2306  Asm->EOL("Compilation Unit Length");
2307
2308  StringMap<DIE*> &Globals = Unit->getGlobals();
2309  for (StringMap<DIE*>::const_iterator
2310         GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2311    const char *Name = GI->getKeyData();
2312    DIE * Entity = GI->second;
2313
2314    Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2315    Asm->EmitString(Name, strlen(Name)); Asm->EOL("External Name");
2316  }
2317
2318  Asm->EmitInt32(0); Asm->EOL("End Mark");
2319  EmitLabel("pubnames_end", Unit->getID());
2320
2321  Asm->EOL();
2322}
2323
2324/// EmitDebugPubNames - Emit visible names into a debug pubnames section.
2325///
2326void DwarfDebug::EmitDebugPubNames() {
2327  // Start the dwarf pubnames section.
2328  Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2329
2330  EmitDebugPubNamesPerCU(ModuleCU);
2331}
2332
2333/// EmitDebugStr - Emit visible names into a debug str section.
2334///
2335void DwarfDebug::EmitDebugStr() {
2336  // Check to see if it is worth the effort.
2337  if (!StringPool.empty()) {
2338    // Start the dwarf str section.
2339    Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2340
2341    // For each of strings in the string pool.
2342    for (unsigned StringID = 1, N = StringPool.size();
2343         StringID <= N; ++StringID) {
2344      // Emit a label for reference from debug information entries.
2345      EmitLabel("string", StringID);
2346
2347      // Emit the string itself.
2348      const std::string &String = StringPool[StringID];
2349      Asm->EmitString(String); Asm->EOL();
2350    }
2351
2352    Asm->EOL();
2353  }
2354}
2355
2356/// EmitDebugLoc - Emit visible names into a debug loc section.
2357///
2358void DwarfDebug::EmitDebugLoc() {
2359  // Start the dwarf loc section.
2360  Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2361  Asm->EOL();
2362}
2363
2364/// EmitDebugARanges - Emit visible names into a debug aranges section.
2365///
2366void DwarfDebug::EmitDebugARanges() {
2367  // Start the dwarf aranges section.
2368  Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2369
2370  // FIXME - Mock up
2371#if 0
2372  CompileUnit *Unit = GetBaseCompileUnit();
2373
2374  // Don't include size of length
2375  Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
2376
2377  Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("Dwarf Version");
2378
2379  EmitReference("info_begin", Unit->getID());
2380  Asm->EOL("Offset of Compilation Unit Info");
2381
2382  Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
2383
2384  Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2385
2386  Asm->EmitInt16(0);  Asm->EOL("Pad (1)");
2387  Asm->EmitInt16(0);  Asm->EOL("Pad (2)");
2388
2389  // Range 1
2390  EmitReference("text_begin", 0); Asm->EOL("Address");
2391  EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2392
2393  Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2394  Asm->EmitInt32(0); Asm->EOL("EOM (2)");
2395#endif
2396
2397  Asm->EOL();
2398}
2399
2400/// EmitDebugRanges - Emit visible names into a debug ranges section.
2401///
2402void DwarfDebug::EmitDebugRanges() {
2403  // Start the dwarf ranges section.
2404  Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2405  Asm->EOL();
2406}
2407
2408/// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
2409///
2410void DwarfDebug::EmitDebugMacInfo() {
2411  if (const char *LineInfoDirective = TAI->getDwarfMacroInfoSection()) {
2412    // Start the dwarf macinfo section.
2413    Asm->SwitchToDataSection(LineInfoDirective);
2414    Asm->EOL();
2415  }
2416}
2417
2418/// EmitDebugInlineInfo - Emit inline info using following format.
2419/// Section Header:
2420/// 1. length of section
2421/// 2. Dwarf version number
2422/// 3. address size.
2423///
2424/// Entries (one "entry" for each function that was inlined):
2425///
2426/// 1. offset into __debug_str section for MIPS linkage name, if exists;
2427///   otherwise offset into __debug_str for regular function name.
2428/// 2. offset into __debug_str section for regular function name.
2429/// 3. an unsigned LEB128 number indicating the number of distinct inlining
2430/// instances for the function.
2431///
2432/// The rest of the entry consists of a {die_offset, low_pc} pair for each
2433/// inlined instance; the die_offset points to the inlined_subroutine die in the
2434/// __debug_info section, and the low_pc is the starting address for the
2435/// inlining instance.
2436void DwarfDebug::EmitDebugInlineInfo() {
2437  if (!TAI->doesDwarfUsesInlineInfoSection())
2438    return;
2439
2440  if (!ModuleCU)
2441    return;
2442
2443  Asm->SwitchToDataSection(TAI->getDwarfDebugInlineSection());
2444  Asm->EOL();
2445  EmitDifference("debug_inlined_end", 1,
2446                 "debug_inlined_begin", 1, true);
2447  Asm->EOL("Length of Debug Inlined Information Entry");
2448
2449  EmitLabel("debug_inlined_begin", 1);
2450
2451  Asm->EmitInt16(dwarf::DWARF_VERSION); Asm->EOL("Dwarf Version");
2452  Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2453
2454  for (DenseMap<GlobalVariable *, SmallVector<unsigned, 4> >::iterator
2455         I = InlineInfo.begin(), E = InlineInfo.end(); I != E; ++I) {
2456    GlobalVariable *GV = I->first;
2457    SmallVector<unsigned, 4> &Labels = I->second;
2458    DISubprogram SP(GV);
2459    std::string Name;
2460    std::string LName;
2461
2462    SP.getLinkageName(LName);
2463    SP.getName(Name);
2464
2465    Asm->EmitString(LName.empty() ? Name : LName);
2466    Asm->EOL("MIPS linkage name");
2467
2468    Asm->EmitString(Name); Asm->EOL("Function name");
2469
2470    Asm->EmitULEB128Bytes(Labels.size()); Asm->EOL("Inline count");
2471
2472    for (SmallVector<unsigned, 4>::iterator LI = Labels.begin(),
2473           LE = Labels.end(); LI != LE; ++LI) {
2474      DIE *SP = ModuleCU->getDieMapSlotFor(GV);
2475      Asm->EmitInt32(SP->getOffset()); Asm->EOL("DIE offset");
2476
2477      if (TD->getPointerSize() == sizeof(int32_t))
2478        O << TAI->getData32bitsDirective();
2479      else
2480        O << TAI->getData64bitsDirective();
2481
2482      PrintLabelName("label", *LI); Asm->EOL("low_pc");
2483    }
2484  }
2485
2486  EmitLabel("debug_inlined_end", 1);
2487  Asm->EOL();
2488}
2489