Add line table debug info to COFF files when using a win32 triple.
[oota-llvm.git] / lib / CodeGen / AsmPrinter / DwarfDebug.cpp
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 #define DEBUG_TYPE "dwarfdebug"
15 #include "DwarfDebug.h"
16 #include "DIE.h"
17 #include "DIEHash.h"
18 #include "DwarfAccelTable.h"
19 #include "DwarfUnit.h"
20 #include "llvm/ADT/STLExtras.h"
21 #include "llvm/ADT/Statistic.h"
22 #include "llvm/ADT/StringExtras.h"
23 #include "llvm/ADT/Triple.h"
24 #include "llvm/CodeGen/MachineFunction.h"
25 #include "llvm/CodeGen/MachineModuleInfo.h"
26 #include "llvm/DIBuilder.h"
27 #include "llvm/DebugInfo.h"
28 #include "llvm/IR/Constants.h"
29 #include "llvm/IR/DataLayout.h"
30 #include "llvm/IR/Instructions.h"
31 #include "llvm/IR/Module.h"
32 #include "llvm/MC/MCAsmInfo.h"
33 #include "llvm/MC/MCSection.h"
34 #include "llvm/MC/MCStreamer.h"
35 #include "llvm/MC/MCSymbol.h"
36 #include "llvm/Support/CommandLine.h"
37 #include "llvm/Support/Debug.h"
38 #include "llvm/Support/Dwarf.h"
39 #include "llvm/Support/ErrorHandling.h"
40 #include "llvm/Support/FormattedStream.h"
41 #include "llvm/Support/MD5.h"
42 #include "llvm/Support/Path.h"
43 #include "llvm/Support/Timer.h"
44 #include "llvm/Support/ValueHandle.h"
45 #include "llvm/Target/TargetFrameLowering.h"
46 #include "llvm/Target/TargetLoweringObjectFile.h"
47 #include "llvm/Target/TargetMachine.h"
48 #include "llvm/Target/TargetOptions.h"
49 #include "llvm/Target/TargetRegisterInfo.h"
50 using namespace llvm;
51
52 static cl::opt<bool>
53 DisableDebugInfoPrinting("disable-debug-info-print", cl::Hidden,
54                          cl::desc("Disable debug info printing"));
55
56 static cl::opt<bool> UnknownLocations(
57     "use-unknown-locations", cl::Hidden,
58     cl::desc("Make an absence of debug location information explicit."),
59     cl::init(false));
60
61 static cl::opt<bool> GenerateCUHash("generate-cu-hash", cl::Hidden,
62                                     cl::desc("Add the CU hash as the dwo_id."),
63                                     cl::init(false));
64
65 static cl::opt<bool>
66 GenerateGnuPubSections("generate-gnu-dwarf-pub-sections", cl::Hidden,
67                        cl::desc("Generate GNU-style pubnames and pubtypes"),
68                        cl::init(false));
69
70 namespace {
71 enum DefaultOnOff { Default, Enable, Disable };
72 }
73
74 static cl::opt<DefaultOnOff>
75 DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
76                  cl::desc("Output prototype dwarf accelerator tables."),
77                  cl::values(clEnumVal(Default, "Default for platform"),
78                             clEnumVal(Enable, "Enabled"),
79                             clEnumVal(Disable, "Disabled"), clEnumValEnd),
80                  cl::init(Default));
81
82 static cl::opt<DefaultOnOff>
83 SplitDwarf("split-dwarf", cl::Hidden,
84            cl::desc("Output DWARF5 split debug info."),
85            cl::values(clEnumVal(Default, "Default for platform"),
86                       clEnumVal(Enable, "Enabled"),
87                       clEnumVal(Disable, "Disabled"), clEnumValEnd),
88            cl::init(Default));
89
90 static cl::opt<DefaultOnOff>
91 DwarfPubSections("generate-dwarf-pub-sections", cl::Hidden,
92                  cl::desc("Generate DWARF pubnames and pubtypes sections"),
93                  cl::values(clEnumVal(Default, "Default for platform"),
94                             clEnumVal(Enable, "Enabled"),
95                             clEnumVal(Disable, "Disabled"), clEnumValEnd),
96                  cl::init(Default));
97
98 static cl::opt<unsigned>
99 DwarfVersionNumber("dwarf-version", cl::Hidden,
100                    cl::desc("Generate DWARF for dwarf version."), cl::init(0));
101
102 static cl::opt<bool>
103 DwarfCURanges("generate-dwarf-cu-ranges", cl::Hidden,
104               cl::desc("Generate DW_AT_ranges for compile units"),
105               cl::init(false));
106
107 static const char *const DWARFGroupName = "DWARF Emission";
108 static const char *const DbgTimerName = "DWARF Debug Writer";
109
110 //===----------------------------------------------------------------------===//
111
112 namespace llvm {
113
114 /// resolve - Look in the DwarfDebug map for the MDNode that
115 /// corresponds to the reference.
116 template <typename T> T DbgVariable::resolve(DIRef<T> Ref) const {
117   return DD->resolve(Ref);
118 }
119
120 DIType DbgVariable::getType() const {
121   DIType Ty = Var.getType();
122   // FIXME: isBlockByrefVariable should be reformulated in terms of complex
123   // addresses instead.
124   if (Var.isBlockByrefVariable()) {
125     /* Byref variables, in Blocks, are declared by the programmer as
126        "SomeType VarName;", but the compiler creates a
127        __Block_byref_x_VarName struct, and gives the variable VarName
128        either the struct, or a pointer to the struct, as its type.  This
129        is necessary for various behind-the-scenes things the compiler
130        needs to do with by-reference variables in blocks.
131
132        However, as far as the original *programmer* is concerned, the
133        variable should still have type 'SomeType', as originally declared.
134
135        The following function dives into the __Block_byref_x_VarName
136        struct to find the original type of the variable.  This will be
137        passed back to the code generating the type for the Debug
138        Information Entry for the variable 'VarName'.  'VarName' will then
139        have the original type 'SomeType' in its debug information.
140
141        The original type 'SomeType' will be the type of the field named
142        'VarName' inside the __Block_byref_x_VarName struct.
143
144        NOTE: In order for this to not completely fail on the debugger
145        side, the Debug Information Entry for the variable VarName needs to
146        have a DW_AT_location that tells the debugger how to unwind through
147        the pointers and __Block_byref_x_VarName struct to find the actual
148        value of the variable.  The function addBlockByrefType does this.  */
149     DIType subType = Ty;
150     uint16_t tag = Ty.getTag();
151
152     if (tag == dwarf::DW_TAG_pointer_type)
153       subType = resolve(DIDerivedType(Ty).getTypeDerivedFrom());
154
155     DIArray Elements = DICompositeType(subType).getTypeArray();
156     for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
157       DIDerivedType DT(Elements.getElement(i));
158       if (getName() == DT.getName())
159         return (resolve(DT.getTypeDerivedFrom()));
160     }
161   }
162   return Ty;
163 }
164
165 } // end llvm namespace
166
167 /// Return Dwarf Version by checking module flags.
168 static unsigned getDwarfVersionFromModule(const Module *M) {
169   Value *Val = M->getModuleFlag("Dwarf Version");
170   if (!Val)
171     return dwarf::DWARF_VERSION;
172   return cast<ConstantInt>(Val)->getZExtValue();
173 }
174
175 DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
176     : Asm(A), MMI(Asm->MMI), FirstCU(0), SourceIdMap(DIEValueAllocator),
177       PrevLabel(NULL), GlobalRangeCount(0),
178       InfoHolder(A, "info_string", DIEValueAllocator), HasCURanges(false),
179       UsedNonDefaultText(false),
180       SkeletonHolder(A, "skel_string", DIEValueAllocator) {
181
182   DwarfInfoSectionSym = DwarfAbbrevSectionSym = DwarfStrSectionSym = 0;
183   DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = DwarfLineSectionSym = 0;
184   DwarfAddrSectionSym = 0;
185   DwarfAbbrevDWOSectionSym = DwarfStrDWOSectionSym = 0;
186   FunctionBeginSym = FunctionEndSym = 0;
187   CurFn = 0;
188   CurMI = 0;
189
190   // Turn on accelerator tables for Darwin by default, pubnames by
191   // default for non-Darwin, and handle split dwarf.
192   bool IsDarwin = Triple(A->getTargetTriple()).isOSDarwin();
193
194   if (DwarfAccelTables == Default)
195     HasDwarfAccelTables = IsDarwin;
196   else
197     HasDwarfAccelTables = DwarfAccelTables == Enable;
198
199   if (SplitDwarf == Default)
200     HasSplitDwarf = false;
201   else
202     HasSplitDwarf = SplitDwarf == Enable;
203
204   if (DwarfPubSections == Default)
205     HasDwarfPubSections = !IsDarwin;
206   else
207     HasDwarfPubSections = DwarfPubSections == Enable;
208
209   DwarfVersion = DwarfVersionNumber
210                      ? DwarfVersionNumber
211                      : getDwarfVersionFromModule(MMI->getModule());
212
213   {
214     NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
215     beginModule();
216   }
217 }
218
219 // Switch to the specified MCSection and emit an assembler
220 // temporary label to it if SymbolStem is specified.
221 static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
222                                 const char *SymbolStem = 0) {
223   Asm->OutStreamer.SwitchSection(Section);
224   if (!SymbolStem)
225     return 0;
226
227   MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
228   Asm->OutStreamer.EmitLabel(TmpSym);
229   return TmpSym;
230 }
231
232 DwarfFile::~DwarfFile() {
233   for (SmallVectorImpl<DwarfUnit *>::iterator I = CUs.begin(), E = CUs.end();
234        I != E; ++I)
235     delete *I;
236 }
237
238 MCSymbol *DwarfFile::getStringPoolSym() {
239   return Asm->GetTempSymbol(StringPref);
240 }
241
242 MCSymbol *DwarfFile::getStringPoolEntry(StringRef Str) {
243   std::pair<MCSymbol *, unsigned> &Entry =
244       StringPool.GetOrCreateValue(Str).getValue();
245   if (Entry.first)
246     return Entry.first;
247
248   Entry.second = NextStringPoolNumber++;
249   return Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
250 }
251
252 unsigned DwarfFile::getStringPoolIndex(StringRef Str) {
253   std::pair<MCSymbol *, unsigned> &Entry =
254       StringPool.GetOrCreateValue(Str).getValue();
255   if (Entry.first)
256     return Entry.second;
257
258   Entry.second = NextStringPoolNumber++;
259   Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
260   return Entry.second;
261 }
262
263 unsigned DwarfFile::getAddrPoolIndex(const MCSymbol *Sym) {
264   return getAddrPoolIndex(MCSymbolRefExpr::Create(Sym, Asm->OutContext));
265 }
266
267 unsigned DwarfFile::getAddrPoolIndex(const MCExpr *Sym) {
268   std::pair<DenseMap<const MCExpr *, unsigned>::iterator, bool> P =
269       AddressPool.insert(std::make_pair(Sym, NextAddrPoolNumber));
270   if (P.second)
271     ++NextAddrPoolNumber;
272   return P.first->second;
273 }
274
275 // Define a unique number for the abbreviation.
276 //
277 void DwarfFile::assignAbbrevNumber(DIEAbbrev &Abbrev) {
278   // Check the set for priors.
279   DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
280
281   // If it's newly added.
282   if (InSet == &Abbrev) {
283     // Add to abbreviation list.
284     Abbreviations.push_back(&Abbrev);
285
286     // Assign the vector position + 1 as its number.
287     Abbrev.setNumber(Abbreviations.size());
288   } else {
289     // Assign existing abbreviation number.
290     Abbrev.setNumber(InSet->getNumber());
291   }
292 }
293
294 static bool isObjCClass(StringRef Name) {
295   return Name.startswith("+") || Name.startswith("-");
296 }
297
298 static bool hasObjCCategory(StringRef Name) {
299   if (!isObjCClass(Name))
300     return false;
301
302   return Name.find(") ") != StringRef::npos;
303 }
304
305 static void getObjCClassCategory(StringRef In, StringRef &Class,
306                                  StringRef &Category) {
307   if (!hasObjCCategory(In)) {
308     Class = In.slice(In.find('[') + 1, In.find(' '));
309     Category = "";
310     return;
311   }
312
313   Class = In.slice(In.find('[') + 1, In.find('('));
314   Category = In.slice(In.find('[') + 1, In.find(' '));
315   return;
316 }
317
318 static StringRef getObjCMethodName(StringRef In) {
319   return In.slice(In.find(' ') + 1, In.find(']'));
320 }
321
322 // Helper for sorting sections into a stable output order.
323 static bool SectionSort(const MCSection *A, const MCSection *B) {
324   std::string LA = (A ? A->getLabelBeginName() : "");
325   std::string LB = (B ? B->getLabelBeginName() : "");
326   return LA < LB;
327 }
328
329 // Add the various names to the Dwarf accelerator table names.
330 // TODO: Determine whether or not we should add names for programs
331 // that do not have a DW_AT_name or DW_AT_linkage_name field - this
332 // is only slightly different than the lookup of non-standard ObjC names.
333 static void addSubprogramNames(DwarfUnit *TheU, DISubprogram SP, DIE *Die) {
334   if (!SP.isDefinition())
335     return;
336   TheU->addAccelName(SP.getName(), Die);
337
338   // If the linkage name is different than the name, go ahead and output
339   // that as well into the name table.
340   if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
341     TheU->addAccelName(SP.getLinkageName(), Die);
342
343   // If this is an Objective-C selector name add it to the ObjC accelerator
344   // too.
345   if (isObjCClass(SP.getName())) {
346     StringRef Class, Category;
347     getObjCClassCategory(SP.getName(), Class, Category);
348     TheU->addAccelObjC(Class, Die);
349     if (Category != "")
350       TheU->addAccelObjC(Category, Die);
351     // Also add the base method name to the name table.
352     TheU->addAccelName(getObjCMethodName(SP.getName()), Die);
353   }
354 }
355
356 /// isSubprogramContext - Return true if Context is either a subprogram
357 /// or another context nested inside a subprogram.
358 bool DwarfDebug::isSubprogramContext(const MDNode *Context) {
359   if (!Context)
360     return false;
361   DIDescriptor D(Context);
362   if (D.isSubprogram())
363     return true;
364   if (D.isType())
365     return isSubprogramContext(resolve(DIType(Context).getContext()));
366   return false;
367 }
368
369 // Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
370 // and DW_AT_high_pc attributes. If there are global variables in this
371 // scope then create and insert DIEs for these variables.
372 DIE *DwarfDebug::updateSubprogramScopeDIE(DwarfCompileUnit *SPCU,
373                                           DISubprogram SP) {
374   DIE *SPDie = SPCU->getDIE(SP);
375
376   assert(SPDie && "Unable to find subprogram DIE!");
377
378   // If we're updating an abstract DIE, then we will be adding the children and
379   // object pointer later on. But what we don't want to do is process the
380   // concrete DIE twice.
381   if (DIE *AbsSPDIE = AbstractSPDies.lookup(SP)) {
382     // Pick up abstract subprogram DIE.
383     SPDie =
384         SPCU->createAndAddDIE(dwarf::DW_TAG_subprogram, *SPCU->getUnitDie());
385     SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin, AbsSPDIE);
386   } else {
387     DISubprogram SPDecl = SP.getFunctionDeclaration();
388     if (!SPDecl.isSubprogram()) {
389       // There is not any need to generate specification DIE for a function
390       // defined at compile unit level. If a function is defined inside another
391       // function then gdb prefers the definition at top level and but does not
392       // expect specification DIE in parent function. So avoid creating
393       // specification DIE for a function defined inside a function.
394       DIScope SPContext = resolve(SP.getContext());
395       if (SP.isDefinition() && !SPContext.isCompileUnit() &&
396           !SPContext.isFile() && !isSubprogramContext(SPContext)) {
397         SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
398
399         // Add arguments.
400         DICompositeType SPTy = SP.getType();
401         DIArray Args = SPTy.getTypeArray();
402         uint16_t SPTag = SPTy.getTag();
403         if (SPTag == dwarf::DW_TAG_subroutine_type)
404           for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
405             DIE *Arg =
406                 SPCU->createAndAddDIE(dwarf::DW_TAG_formal_parameter, *SPDie);
407             DIType ATy(Args.getElement(i));
408             SPCU->addType(Arg, ATy);
409             if (ATy.isArtificial())
410               SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
411             if (ATy.isObjectPointer())
412               SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer, Arg);
413           }
414         DIE *SPDeclDie = SPDie;
415         SPDie = SPCU->createAndAddDIE(dwarf::DW_TAG_subprogram,
416                                       *SPCU->getUnitDie());
417         SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification, SPDeclDie);
418       }
419     }
420   }
421
422   SPCU->addLabelAddress(SPDie, dwarf::DW_AT_low_pc, FunctionBeginSym);
423   SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc, FunctionEndSym);
424
425   // Add this range to the list of ranges for the CU.
426   RangeSpan Span(FunctionBeginSym, FunctionEndSym);
427   SPCU->addRange(llvm_move(Span));
428
429   const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
430   MachineLocation Location(RI->getFrameRegister(*Asm->MF));
431   SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
432
433   // Add name to the name table, we do this here because we're guaranteed
434   // to have concrete versions of our DW_TAG_subprogram nodes.
435   addSubprogramNames(SPCU, SP, SPDie);
436
437   return SPDie;
438 }
439
440 /// Check whether we should create a DIE for the given Scope, return true
441 /// if we don't create a DIE (the corresponding DIE is null).
442 bool DwarfDebug::isLexicalScopeDIENull(LexicalScope *Scope) {
443   if (Scope->isAbstractScope())
444     return false;
445
446   // We don't create a DIE if there is no Range.
447   const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
448   if (Ranges.empty())
449     return true;
450
451   if (Ranges.size() > 1)
452     return false;
453
454   // We don't create a DIE if we have a single Range and the end label
455   // is null.
456   SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
457   MCSymbol *End = getLabelAfterInsn(RI->second);
458   return !End;
459 }
460
461 static void addSectionLabel(AsmPrinter *Asm, DwarfUnit *U, DIE *D,
462                             dwarf::Attribute A, const MCSymbol *L,
463                             const MCSymbol *Sec) {
464   if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
465     U->addSectionLabel(D, A, L);
466   else
467     U->addSectionDelta(D, A, L, Sec);
468 }
469
470 void DwarfDebug::addScopeRangeList(DwarfCompileUnit *TheCU, DIE *ScopeDIE,
471                                    const SmallVectorImpl<InsnRange> &Range) {
472   // Emit offset in .debug_range as a relocatable label. emitDIE will handle
473   // emitting it appropriately.
474   MCSymbol *RangeSym = Asm->GetTempSymbol("debug_ranges", GlobalRangeCount++);
475   addSectionLabel(Asm, TheCU, ScopeDIE, dwarf::DW_AT_ranges, RangeSym,
476                   DwarfDebugRangeSectionSym);
477
478   RangeSpanList List(RangeSym);
479   for (SmallVectorImpl<InsnRange>::const_iterator RI = Range.begin(),
480                                                   RE = Range.end();
481        RI != RE; ++RI) {
482     RangeSpan Span(getLabelBeforeInsn(RI->first),
483                    getLabelAfterInsn(RI->second));
484     List.addRange(llvm_move(Span));
485   }
486
487   // Add the range list to the set of ranges to be emitted.
488   TheCU->addRangeList(llvm_move(List));
489 }
490
491 // Construct new DW_TAG_lexical_block for this scope and attach
492 // DW_AT_low_pc/DW_AT_high_pc labels.
493 DIE *DwarfDebug::constructLexicalScopeDIE(DwarfCompileUnit *TheCU,
494                                           LexicalScope *Scope) {
495   if (isLexicalScopeDIENull(Scope))
496     return 0;
497
498   DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
499   if (Scope->isAbstractScope())
500     return ScopeDIE;
501
502   const SmallVectorImpl<InsnRange> &ScopeRanges = Scope->getRanges();
503
504   // If we have multiple ranges, emit them into the range section.
505   if (ScopeRanges.size() > 1) {
506     addScopeRangeList(TheCU, ScopeDIE, ScopeRanges);
507     return ScopeDIE;
508   }
509
510   // Construct the address range for this DIE.
511   SmallVectorImpl<InsnRange>::const_iterator RI = ScopeRanges.begin();
512   MCSymbol *Start = getLabelBeforeInsn(RI->first);
513   MCSymbol *End = getLabelAfterInsn(RI->second);
514   assert(End && "End label should not be null!");
515
516   assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
517   assert(End->isDefined() && "Invalid end label for an inlined scope!");
518
519   TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
520   TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
521
522   return ScopeDIE;
523 }
524
525 // This scope represents inlined body of a function. Construct DIE to
526 // represent this concrete inlined copy of the function.
527 DIE *DwarfDebug::constructInlinedScopeDIE(DwarfCompileUnit *TheCU,
528                                           LexicalScope *Scope) {
529   const SmallVectorImpl<InsnRange> &ScopeRanges = Scope->getRanges();
530   assert(!ScopeRanges.empty() &&
531          "LexicalScope does not have instruction markers!");
532
533   if (!Scope->getScopeNode())
534     return NULL;
535   DIScope DS(Scope->getScopeNode());
536   DISubprogram InlinedSP = getDISubprogram(DS);
537   DIE *OriginDIE = TheCU->getDIE(InlinedSP);
538   if (!OriginDIE) {
539     DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
540     return NULL;
541   }
542
543   DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
544   TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin, OriginDIE);
545
546   // If we have multiple ranges, emit them into the range section.
547   if (ScopeRanges.size() > 1)
548     addScopeRangeList(TheCU, ScopeDIE, ScopeRanges);
549   else {
550     SmallVectorImpl<InsnRange>::const_iterator RI = ScopeRanges.begin();
551     MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
552     MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
553
554     if (StartLabel == 0 || EndLabel == 0)
555       llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
556
557     assert(StartLabel->isDefined() &&
558            "Invalid starting label for an inlined scope!");
559     assert(EndLabel->isDefined() && "Invalid end label for an inlined scope!");
560
561     TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
562     TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
563   }
564
565   InlinedSubprogramDIEs.insert(OriginDIE);
566
567   // Add the call site information to the DIE.
568   DILocation DL(Scope->getInlinedAt());
569   TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, None,
570                  getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
571                                      TheCU->getUniqueID()));
572   TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, None, DL.getLineNumber());
573
574   // Add name to the name table, we do this here because we're guaranteed
575   // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
576   addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
577
578   return ScopeDIE;
579 }
580
581 DIE *DwarfDebug::createScopeChildrenDIE(DwarfCompileUnit *TheCU,
582                                         LexicalScope *Scope,
583                                         SmallVectorImpl<DIE *> &Children) {
584   DIE *ObjectPointer = NULL;
585
586   // Collect arguments for current function.
587   if (LScopes.isCurrentFunctionScope(Scope))
588     for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
589       if (DbgVariable *ArgDV = CurrentFnArguments[i])
590         if (DIE *Arg =
591                 TheCU->constructVariableDIE(*ArgDV, Scope->isAbstractScope())) {
592           Children.push_back(Arg);
593           if (ArgDV->isObjectPointer())
594             ObjectPointer = Arg;
595         }
596
597   // Collect lexical scope children first.
598   const SmallVectorImpl<DbgVariable *> &Variables =
599       ScopeVariables.lookup(Scope);
600   for (unsigned i = 0, N = Variables.size(); i < N; ++i)
601     if (DIE *Variable = TheCU->constructVariableDIE(*Variables[i],
602                                                     Scope->isAbstractScope())) {
603       Children.push_back(Variable);
604       if (Variables[i]->isObjectPointer())
605         ObjectPointer = Variable;
606     }
607   const SmallVectorImpl<LexicalScope *> &Scopes = Scope->getChildren();
608   for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
609     if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
610       Children.push_back(Nested);
611   return ObjectPointer;
612 }
613
614 // Construct a DIE for this scope.
615 DIE *DwarfDebug::constructScopeDIE(DwarfCompileUnit *TheCU,
616                                    LexicalScope *Scope) {
617   if (!Scope || !Scope->getScopeNode())
618     return NULL;
619
620   DIScope DS(Scope->getScopeNode());
621
622   SmallVector<DIE *, 8> Children;
623   DIE *ObjectPointer = NULL;
624   bool ChildrenCreated = false;
625
626   // We try to create the scope DIE first, then the children DIEs. This will
627   // avoid creating un-used children then removing them later when we find out
628   // the scope DIE is null.
629   DIE *ScopeDIE = NULL;
630   if (Scope->getInlinedAt())
631     ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
632   else if (DS.isSubprogram()) {
633     ProcessedSPNodes.insert(DS);
634     if (Scope->isAbstractScope()) {
635       ScopeDIE = TheCU->getDIE(DS);
636       // Note down abstract DIE.
637       if (ScopeDIE)
638         AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
639     } else
640       ScopeDIE = updateSubprogramScopeDIE(TheCU, DISubprogram(DS));
641   } else {
642     // Early exit when we know the scope DIE is going to be null.
643     if (isLexicalScopeDIENull(Scope))
644       return NULL;
645
646     // We create children here when we know the scope DIE is not going to be
647     // null and the children will be added to the scope DIE.
648     ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
649     ChildrenCreated = true;
650
651     // There is no need to emit empty lexical block DIE.
652     std::pair<ImportedEntityMap::const_iterator,
653               ImportedEntityMap::const_iterator> Range =
654         std::equal_range(
655             ScopesWithImportedEntities.begin(),
656             ScopesWithImportedEntities.end(),
657             std::pair<const MDNode *, const MDNode *>(DS, (const MDNode *)0),
658             less_first());
659     if (Children.empty() && Range.first == Range.second)
660       return NULL;
661     ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
662     assert(ScopeDIE && "Scope DIE should not be null.");
663     for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
664          ++i)
665       constructImportedEntityDIE(TheCU, i->second, ScopeDIE);
666   }
667
668   if (!ScopeDIE) {
669     assert(Children.empty() &&
670            "We create children only when the scope DIE is not null.");
671     return NULL;
672   }
673   if (!ChildrenCreated)
674     // We create children when the scope DIE is not null.
675     ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
676
677   // Add children
678   for (SmallVectorImpl<DIE *>::iterator I = Children.begin(),
679                                         E = Children.end();
680        I != E; ++I)
681     ScopeDIE->addChild(*I);
682
683   if (DS.isSubprogram() && ObjectPointer != NULL)
684     TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer, ObjectPointer);
685
686   return ScopeDIE;
687 }
688
689 // Look up the source id with the given directory and source file names.
690 // If none currently exists, create a new id and insert it in the
691 // SourceIds map. This can update DirectoryNames and SourceFileNames maps
692 // as well.
693 unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName, StringRef DirName,
694                                          unsigned CUID) {
695   // If we use .loc in assembly, we can't separate .file entries according to
696   // compile units. Thus all files will belong to the default compile unit.
697
698   // FIXME: add a better feature test than hasRawTextSupport. Even better,
699   // extend .file to support this.
700   if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
701     CUID = 0;
702
703   // If FE did not provide a file name, then assume stdin.
704   if (FileName.empty())
705     return getOrCreateSourceID("<stdin>", StringRef(), CUID);
706
707   // TODO: this might not belong here. See if we can factor this better.
708   if (DirName == CompilationDir)
709     DirName = "";
710
711   // FileIDCUMap stores the current ID for the given compile unit.
712   unsigned SrcId = FileIDCUMap[CUID] + 1;
713
714   // We look up the CUID/file/dir by concatenating them with a zero byte.
715   SmallString<128> NamePair;
716   NamePair += utostr(CUID);
717   NamePair += '\0';
718   NamePair += DirName;
719   NamePair += '\0'; // Zero bytes are not allowed in paths.
720   NamePair += FileName;
721
722   StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
723   if (Ent.getValue() != SrcId)
724     return Ent.getValue();
725
726   FileIDCUMap[CUID] = SrcId;
727   // Print out a .file directive to specify files for .loc directives.
728   Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName, CUID);
729
730   return SrcId;
731 }
732
733 void DwarfDebug::addGnuPubAttributes(DwarfUnit *U, DIE *D) const {
734   if (!GenerateGnuPubSections)
735     return;
736
737   addSectionLabel(Asm, U, D, dwarf::DW_AT_GNU_pubnames,
738                   Asm->GetTempSymbol("gnu_pubnames", U->getUniqueID()),
739                   DwarfGnuPubNamesSectionSym);
740
741   addSectionLabel(Asm, U, D, dwarf::DW_AT_GNU_pubtypes,
742                   Asm->GetTempSymbol("gnu_pubtypes", U->getUniqueID()),
743                   DwarfGnuPubTypesSectionSym);
744 }
745
746 // Create new DwarfCompileUnit for the given metadata node with tag
747 // DW_TAG_compile_unit.
748 DwarfCompileUnit *DwarfDebug::constructDwarfCompileUnit(DICompileUnit DIUnit) {
749   StringRef FN = DIUnit.getFilename();
750   CompilationDir = DIUnit.getDirectory();
751
752   DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
753   DwarfCompileUnit *NewCU = new DwarfCompileUnit(
754       InfoHolder.getUnits().size(), Die, DIUnit, Asm, this, &InfoHolder);
755   InfoHolder.addUnit(NewCU);
756
757   FileIDCUMap[NewCU->getUniqueID()] = 0;
758   // Call this to emit a .file directive if it wasn't emitted for the source
759   // file this CU comes from yet.
760   getOrCreateSourceID(FN, CompilationDir, NewCU->getUniqueID());
761
762   NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
763   NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
764                  DIUnit.getLanguage());
765   NewCU->addString(Die, dwarf::DW_AT_name, FN);
766
767   // Define start line table label for each Compile Unit.
768   MCSymbol *LineTableStartSym =
769       Asm->GetTempSymbol("line_table_start", NewCU->getUniqueID());
770   Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
771                                                      NewCU->getUniqueID());
772
773   // Use a single line table if we are using .loc and generating assembly.
774   bool UseTheFirstCU =
775       (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport()) ||
776       (NewCU->getUniqueID() == 0);
777
778   if (!useSplitDwarf()) {
779     // DW_AT_stmt_list is a offset of line number information for this
780     // compile unit in debug_line section. For split dwarf this is
781     // left in the skeleton CU and so not included.
782     // The line table entries are not always emitted in assembly, so it
783     // is not okay to use line_table_start here.
784     if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
785       NewCU->addSectionLabel(Die, dwarf::DW_AT_stmt_list,
786                              UseTheFirstCU ? Asm->GetTempSymbol("section_line")
787                                            : LineTableStartSym);
788     else if (UseTheFirstCU)
789       NewCU->addSectionOffset(Die, dwarf::DW_AT_stmt_list, 0);
790     else
791       NewCU->addSectionDelta(Die, dwarf::DW_AT_stmt_list, LineTableStartSym,
792                              DwarfLineSectionSym);
793
794     // If we're using split dwarf the compilation dir is going to be in the
795     // skeleton CU and so we don't need to duplicate it here.
796     if (!CompilationDir.empty())
797       NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
798
799     addGnuPubAttributes(NewCU, Die);
800   }
801
802   if (DIUnit.isOptimized())
803     NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
804
805   StringRef Flags = DIUnit.getFlags();
806   if (!Flags.empty())
807     NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
808
809   if (unsigned RVer = DIUnit.getRunTimeVersion())
810     NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
811                    dwarf::DW_FORM_data1, RVer);
812
813   if (!FirstCU)
814     FirstCU = NewCU;
815
816   if (useSplitDwarf()) {
817     NewCU->initSection(Asm->getObjFileLowering().getDwarfInfoDWOSection(),
818                        DwarfInfoDWOSectionSym);
819     NewCU->setSkeleton(constructSkeletonCU(NewCU));
820   } else
821     NewCU->initSection(Asm->getObjFileLowering().getDwarfInfoSection(),
822                        DwarfInfoSectionSym);
823
824   CUMap.insert(std::make_pair(DIUnit, NewCU));
825   CUDieMap.insert(std::make_pair(Die, NewCU));
826   return NewCU;
827 }
828
829 // Construct subprogram DIE.
830 void DwarfDebug::constructSubprogramDIE(DwarfCompileUnit *TheCU,
831                                         const MDNode *N) {
832   // FIXME: We should only call this routine once, however, during LTO if a
833   // program is defined in multiple CUs we could end up calling it out of
834   // beginModule as we walk the CUs.
835
836   DwarfCompileUnit *&CURef = SPMap[N];
837   if (CURef)
838     return;
839   CURef = TheCU;
840
841   DISubprogram SP(N);
842   if (!SP.isDefinition())
843     // This is a method declaration which will be handled while constructing
844     // class type.
845     return;
846
847   DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
848
849   // Expose as a global name.
850   TheCU->addGlobalName(SP.getName(), SubprogramDie, resolve(SP.getContext()));
851 }
852
853 void DwarfDebug::constructImportedEntityDIE(DwarfCompileUnit *TheCU,
854                                             const MDNode *N) {
855   DIImportedEntity Module(N);
856   if (!Module.Verify())
857     return;
858   if (DIE *D = TheCU->getOrCreateContextDIE(Module.getContext()))
859     constructImportedEntityDIE(TheCU, Module, D);
860 }
861
862 void DwarfDebug::constructImportedEntityDIE(DwarfCompileUnit *TheCU,
863                                             const MDNode *N, DIE *Context) {
864   DIImportedEntity Module(N);
865   if (!Module.Verify())
866     return;
867   return constructImportedEntityDIE(TheCU, Module, Context);
868 }
869
870 void DwarfDebug::constructImportedEntityDIE(DwarfCompileUnit *TheCU,
871                                             const DIImportedEntity &Module,
872                                             DIE *Context) {
873   assert(Module.Verify() &&
874          "Use one of the MDNode * overloads to handle invalid metadata");
875   assert(Context && "Should always have a context for an imported_module");
876   DIE *IMDie = new DIE(Module.getTag());
877   TheCU->insertDIE(Module, IMDie);
878   DIE *EntityDie;
879   DIDescriptor Entity = Module.getEntity();
880   if (Entity.isNameSpace())
881     EntityDie = TheCU->getOrCreateNameSpace(DINameSpace(Entity));
882   else if (Entity.isSubprogram())
883     EntityDie = TheCU->getOrCreateSubprogramDIE(DISubprogram(Entity));
884   else if (Entity.isType())
885     EntityDie = TheCU->getOrCreateTypeDIE(DIType(Entity));
886   else
887     EntityDie = TheCU->getDIE(Entity);
888   unsigned FileID = getOrCreateSourceID(Module.getContext().getFilename(),
889                                         Module.getContext().getDirectory(),
890                                         TheCU->getUniqueID());
891   TheCU->addUInt(IMDie, dwarf::DW_AT_decl_file, None, FileID);
892   TheCU->addUInt(IMDie, dwarf::DW_AT_decl_line, None, Module.getLineNumber());
893   TheCU->addDIEEntry(IMDie, dwarf::DW_AT_import, EntityDie);
894   StringRef Name = Module.getName();
895   if (!Name.empty())
896     TheCU->addString(IMDie, dwarf::DW_AT_name, Name);
897   Context->addChild(IMDie);
898 }
899
900 // Emit all Dwarf sections that should come prior to the content. Create
901 // global DIEs and emit initial debug info sections. This is invoked by
902 // the target AsmPrinter.
903 void DwarfDebug::beginModule() {
904   if (DisableDebugInfoPrinting)
905     return;
906
907   const Module *M = MMI->getModule();
908
909   // If module has named metadata anchors then use them, otherwise scan the
910   // module using debug info finder to collect debug info.
911   NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
912   if (!CU_Nodes)
913     return;
914   TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
915
916   // Emit initial sections so we can reference labels later.
917   emitSectionLabels();
918
919   for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
920     DICompileUnit CUNode(CU_Nodes->getOperand(i));
921     DwarfCompileUnit *CU = constructDwarfCompileUnit(CUNode);
922     DIArray ImportedEntities = CUNode.getImportedEntities();
923     for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
924       ScopesWithImportedEntities.push_back(std::make_pair(
925           DIImportedEntity(ImportedEntities.getElement(i)).getContext(),
926           ImportedEntities.getElement(i)));
927     std::sort(ScopesWithImportedEntities.begin(),
928               ScopesWithImportedEntities.end(), less_first());
929     DIArray GVs = CUNode.getGlobalVariables();
930     for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
931       CU->createGlobalVariableDIE(DIGlobalVariable(GVs.getElement(i)));
932     DIArray SPs = CUNode.getSubprograms();
933     for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
934       constructSubprogramDIE(CU, SPs.getElement(i));
935     DIArray EnumTypes = CUNode.getEnumTypes();
936     for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
937       CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
938     DIArray RetainedTypes = CUNode.getRetainedTypes();
939     for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
940       CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
941     // Emit imported_modules last so that the relevant context is already
942     // available.
943     for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
944       constructImportedEntityDIE(CU, ImportedEntities.getElement(i));
945   }
946
947   // Tell MMI that we have debug info.
948   MMI->setDebugInfoAvailability(true);
949
950   // Prime section data.
951   SectionMap[Asm->getObjFileLowering().getTextSection()];
952 }
953
954 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
955 void DwarfDebug::computeInlinedDIEs() {
956   // Attach DW_AT_inline attribute with inlined subprogram DIEs.
957   for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
958                                        AE = InlinedSubprogramDIEs.end();
959        AI != AE; ++AI) {
960     DIE *ISP = *AI;
961     FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
962   }
963   for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
964                                                  AE = AbstractSPDies.end();
965        AI != AE; ++AI) {
966     DIE *ISP = AI->second;
967     if (InlinedSubprogramDIEs.count(ISP))
968       continue;
969     FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
970   }
971 }
972
973 // Collect info for variables that were optimized out.
974 void DwarfDebug::collectDeadVariables() {
975   const Module *M = MMI->getModule();
976
977   if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
978     for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
979       DICompileUnit TheCU(CU_Nodes->getOperand(i));
980       DIArray Subprograms = TheCU.getSubprograms();
981       for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
982         DISubprogram SP(Subprograms.getElement(i));
983         if (ProcessedSPNodes.count(SP) != 0)
984           continue;
985         if (!SP.isSubprogram())
986           continue;
987         if (!SP.isDefinition())
988           continue;
989         DIArray Variables = SP.getVariables();
990         if (Variables.getNumElements() == 0)
991           continue;
992
993         // Construct subprogram DIE and add variables DIEs.
994         DwarfCompileUnit *SPCU =
995             static_cast<DwarfCompileUnit *>(CUMap.lookup(TheCU));
996         assert(SPCU && "Unable to find Compile Unit!");
997         // FIXME: See the comment in constructSubprogramDIE about duplicate
998         // subprogram DIEs.
999         constructSubprogramDIE(SPCU, SP);
1000         DIE *SPDIE = SPCU->getDIE(SP);
1001         for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
1002           DIVariable DV(Variables.getElement(vi));
1003           if (!DV.isVariable())
1004             continue;
1005           DbgVariable NewVar(DV, NULL, this);
1006           if (DIE *VariableDIE = SPCU->constructVariableDIE(NewVar, false))
1007             SPDIE->addChild(VariableDIE);
1008         }
1009       }
1010     }
1011   }
1012 }
1013
1014 void DwarfDebug::finalizeModuleInfo() {
1015   // Collect info for variables that were optimized out.
1016   collectDeadVariables();
1017
1018   // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1019   computeInlinedDIEs();
1020
1021   // Handle anything that needs to be done on a per-unit basis after
1022   // all other generation.
1023   for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
1024                                                     E = getUnits().end();
1025        I != E; ++I) {
1026     DwarfUnit *TheU = *I;
1027     // Emit DW_AT_containing_type attribute to connect types with their
1028     // vtable holding type.
1029     TheU->constructContainingTypeDIEs();
1030
1031     // Add CU specific attributes if we need to add any.
1032     if (TheU->getUnitDie()->getTag() == dwarf::DW_TAG_compile_unit) {
1033       // If we're splitting the dwarf out now that we've got the entire
1034       // CU then add the dwo id to it.
1035       DwarfCompileUnit *SkCU =
1036           static_cast<DwarfCompileUnit *>(TheU->getSkeleton());
1037       if (useSplitDwarf()) {
1038         // This should be a unique identifier when we want to build .dwp files.
1039         uint64_t ID = 0;
1040         if (GenerateCUHash) {
1041           DIEHash CUHash;
1042           ID = CUHash.computeCUSignature(*TheU->getUnitDie());
1043         }
1044         TheU->addUInt(TheU->getUnitDie(), dwarf::DW_AT_GNU_dwo_id,
1045                       dwarf::DW_FORM_data8, ID);
1046         SkCU->addUInt(SkCU->getUnitDie(), dwarf::DW_AT_GNU_dwo_id,
1047                       dwarf::DW_FORM_data8, ID);
1048       }
1049
1050       // If we have code split among multiple sections or we've requested
1051       // it then emit a DW_AT_ranges attribute on the unit that will remain
1052       // in the .o file, otherwise add a DW_AT_low_pc.
1053       // FIXME: Also add a high pc if we can.
1054       // FIXME: We should use ranges if we have multiple compile units or
1055       // allow reordering of code ala .subsections_via_symbols in mach-o.
1056       DwarfCompileUnit *U = SkCU ? SkCU : static_cast<DwarfCompileUnit *>(TheU);
1057       if (useCURanges() && TheU->getRanges().size())
1058         addSectionLabel(Asm, U, U->getUnitDie(), dwarf::DW_AT_ranges,
1059                         Asm->GetTempSymbol("cu_ranges", U->getUniqueID()),
1060                         DwarfDebugRangeSectionSym);
1061       else
1062         U->addUInt(U->getUnitDie(), dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
1063                    0);
1064     }
1065   }
1066
1067   // Compute DIE offsets and sizes.
1068   InfoHolder.computeSizeAndOffsets();
1069   if (useSplitDwarf())
1070     SkeletonHolder.computeSizeAndOffsets();
1071 }
1072
1073 void DwarfDebug::endSections() {
1074   // Filter labels by section.
1075   for (size_t n = 0; n < ArangeLabels.size(); n++) {
1076     const SymbolCU &SCU = ArangeLabels[n];
1077     if (SCU.Sym->isInSection()) {
1078       // Make a note of this symbol and it's section.
1079       const MCSection *Section = &SCU.Sym->getSection();
1080       if (!Section->getKind().isMetadata())
1081         SectionMap[Section].push_back(SCU);
1082     } else {
1083       // Some symbols (e.g. common/bss on mach-o) can have no section but still
1084       // appear in the output. This sucks as we rely on sections to build
1085       // arange spans. We can do it without, but it's icky.
1086       SectionMap[NULL].push_back(SCU);
1087     }
1088   }
1089
1090   // Build a list of sections used.
1091   std::vector<const MCSection *> Sections;
1092   for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
1093        it++) {
1094     const MCSection *Section = it->first;
1095     Sections.push_back(Section);
1096   }
1097
1098   // Sort the sections into order.
1099   // This is only done to ensure consistent output order across different runs.
1100   std::sort(Sections.begin(), Sections.end(), SectionSort);
1101
1102   // Add terminating symbols for each section.
1103   for (unsigned ID = 0; ID < Sections.size(); ID++) {
1104     const MCSection *Section = Sections[ID];
1105     MCSymbol *Sym = NULL;
1106
1107     if (Section) {
1108       // We can't call MCSection::getLabelEndName, as it's only safe to do so
1109       // if we know the section name up-front. For user-created sections, the
1110       // resulting
1111       // label may not be valid to use as a label. (section names can use a
1112       // greater
1113       // set of characters on some systems)
1114       Sym = Asm->GetTempSymbol("debug_end", ID);
1115       Asm->OutStreamer.SwitchSection(Section);
1116       Asm->OutStreamer.EmitLabel(Sym);
1117     }
1118
1119     // Insert a final terminator.
1120     SectionMap[Section].push_back(SymbolCU(NULL, Sym));
1121   }
1122
1123   // For now only turn on CU ranges if we've explicitly asked for it,
1124   // we have -ffunction-sections enabled, or we've emitted a function
1125   // into a unique section. At this point all sections should be finalized
1126   // except for dwarf sections.
1127   HasCURanges = DwarfCURanges || UsedNonDefaultText ||
1128                 TargetMachine::getFunctionSections();
1129 }
1130
1131 // Emit all Dwarf sections that should come after the content.
1132 void DwarfDebug::endModule() {
1133   assert(CurFn == 0);
1134   assert(CurMI == 0);
1135
1136   if (!FirstCU)
1137     return;
1138
1139   // End any existing sections.
1140   // TODO: Does this need to happen?
1141   endSections();
1142
1143   // Finalize the debug info for the module.
1144   finalizeModuleInfo();
1145
1146   emitDebugStr();
1147
1148   // Emit all the DIEs into a debug info section.
1149   emitDebugInfo();
1150
1151   // Corresponding abbreviations into a abbrev section.
1152   emitAbbreviations();
1153
1154   // Emit info into a debug loc section.
1155   emitDebugLoc();
1156
1157   // Emit info into a debug aranges section.
1158   emitDebugARanges();
1159
1160   // Emit info into a debug ranges section.
1161   emitDebugRanges();
1162
1163   if (useSplitDwarf()) {
1164     emitDebugStrDWO();
1165     emitDebugInfoDWO();
1166     emitDebugAbbrevDWO();
1167     // Emit DWO addresses.
1168     InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
1169   }
1170
1171   // Emit info into the dwarf accelerator table sections.
1172   if (useDwarfAccelTables()) {
1173     emitAccelNames();
1174     emitAccelObjC();
1175     emitAccelNamespaces();
1176     emitAccelTypes();
1177   }
1178
1179   // Emit the pubnames and pubtypes sections if requested.
1180   if (HasDwarfPubSections) {
1181     emitDebugPubNames(GenerateGnuPubSections);
1182     emitDebugPubTypes(GenerateGnuPubSections);
1183   }
1184
1185   // clean up.
1186   SPMap.clear();
1187
1188   // Reset these for the next Module if we have one.
1189   FirstCU = NULL;
1190 }
1191
1192 // Find abstract variable, if any, associated with Var.
1193 DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
1194                                               DebugLoc ScopeLoc) {
1195   LLVMContext &Ctx = DV->getContext();
1196   // More then one inlined variable corresponds to one abstract variable.
1197   DIVariable Var = cleanseInlinedVariable(DV, Ctx);
1198   DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
1199   if (AbsDbgVariable)
1200     return AbsDbgVariable;
1201
1202   LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
1203   if (!Scope)
1204     return NULL;
1205
1206   AbsDbgVariable = new DbgVariable(Var, NULL, this);
1207   addScopeVariable(Scope, AbsDbgVariable);
1208   AbstractVariables[Var] = AbsDbgVariable;
1209   return AbsDbgVariable;
1210 }
1211
1212 // If Var is a current function argument then add it to CurrentFnArguments list.
1213 bool DwarfDebug::addCurrentFnArgument(DbgVariable *Var, LexicalScope *Scope) {
1214   if (!LScopes.isCurrentFunctionScope(Scope))
1215     return false;
1216   DIVariable DV = Var->getVariable();
1217   if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1218     return false;
1219   unsigned ArgNo = DV.getArgNumber();
1220   if (ArgNo == 0)
1221     return false;
1222
1223   size_t Size = CurrentFnArguments.size();
1224   if (Size == 0)
1225     CurrentFnArguments.resize(CurFn->getFunction()->arg_size());
1226   // llvm::Function argument size is not good indicator of how many
1227   // arguments does the function have at source level.
1228   if (ArgNo > Size)
1229     CurrentFnArguments.resize(ArgNo * 2);
1230   CurrentFnArguments[ArgNo - 1] = Var;
1231   return true;
1232 }
1233
1234 // Collect variable information from side table maintained by MMI.
1235 void DwarfDebug::collectVariableInfoFromMMITable(
1236     SmallPtrSet<const MDNode *, 16> &Processed) {
1237   MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1238   for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1239                                                          VE = VMap.end();
1240        VI != VE; ++VI) {
1241     const MDNode *Var = VI->first;
1242     if (!Var)
1243       continue;
1244     Processed.insert(Var);
1245     DIVariable DV(Var);
1246     const std::pair<unsigned, DebugLoc> &VP = VI->second;
1247
1248     LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
1249
1250     // If variable scope is not found then skip this variable.
1251     if (Scope == 0)
1252       continue;
1253
1254     DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
1255     DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable, this);
1256     RegVar->setFrameIndex(VP.first);
1257     if (!addCurrentFnArgument(RegVar, Scope))
1258       addScopeVariable(Scope, RegVar);
1259     if (AbsDbgVariable)
1260       AbsDbgVariable->setFrameIndex(VP.first);
1261   }
1262 }
1263
1264 // Return true if debug value, encoded by DBG_VALUE instruction, is in a
1265 // defined reg.
1266 static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
1267   assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
1268   return MI->getNumOperands() == 3 && MI->getOperand(0).isReg() &&
1269          MI->getOperand(0).getReg() &&
1270          (MI->getOperand(1).isImm() ||
1271           (MI->getOperand(1).isReg() && MI->getOperand(1).getReg() == 0U));
1272 }
1273
1274 // Get .debug_loc entry for the instruction range starting at MI.
1275 static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1276                                          const MCSymbol *FLabel,
1277                                          const MCSymbol *SLabel,
1278                                          const MachineInstr *MI) {
1279   const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1280
1281   assert(MI->getNumOperands() == 3);
1282   if (MI->getOperand(0).isReg()) {
1283     MachineLocation MLoc;
1284     // If the second operand is an immediate, this is a
1285     // register-indirect address.
1286     if (!MI->getOperand(1).isImm())
1287       MLoc.set(MI->getOperand(0).getReg());
1288     else
1289       MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
1290     return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1291   }
1292   if (MI->getOperand(0).isImm())
1293     return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1294   if (MI->getOperand(0).isFPImm())
1295     return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1296   if (MI->getOperand(0).isCImm())
1297     return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1298
1299   llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
1300 }
1301
1302 // Find variables for each lexical scope.
1303 void
1304 DwarfDebug::collectVariableInfo(SmallPtrSet<const MDNode *, 16> &Processed) {
1305
1306   // Grab the variable info that was squirreled away in the MMI side-table.
1307   collectVariableInfoFromMMITable(Processed);
1308
1309   for (SmallVectorImpl<const MDNode *>::const_iterator
1310            UVI = UserVariables.begin(),
1311            UVE = UserVariables.end();
1312        UVI != UVE; ++UVI) {
1313     const MDNode *Var = *UVI;
1314     if (Processed.count(Var))
1315       continue;
1316
1317     // History contains relevant DBG_VALUE instructions for Var and instructions
1318     // clobbering it.
1319     SmallVectorImpl<const MachineInstr *> &History = DbgValues[Var];
1320     if (History.empty())
1321       continue;
1322     const MachineInstr *MInsn = History.front();
1323
1324     DIVariable DV(Var);
1325     LexicalScope *Scope = NULL;
1326     if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1327         DISubprogram(DV.getContext()).describes(CurFn->getFunction()))
1328       Scope = LScopes.getCurrentFunctionScope();
1329     else if (MDNode *IA = DV.getInlinedAt())
1330       Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1331     else
1332       Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
1333     // If variable scope is not found then skip this variable.
1334     if (!Scope)
1335       continue;
1336
1337     Processed.insert(DV);
1338     assert(MInsn->isDebugValue() && "History must begin with debug value");
1339     DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
1340     DbgVariable *RegVar = new DbgVariable(DV, AbsVar, this);
1341     if (!addCurrentFnArgument(RegVar, Scope))
1342       addScopeVariable(Scope, RegVar);
1343     if (AbsVar)
1344       AbsVar->setMInsn(MInsn);
1345
1346     // Simplify ranges that are fully coalesced.
1347     if (History.size() <= 1 ||
1348         (History.size() == 2 && MInsn->isIdenticalTo(History.back()))) {
1349       RegVar->setMInsn(MInsn);
1350       continue;
1351     }
1352
1353     // Handle multiple DBG_VALUE instructions describing one variable.
1354     RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
1355
1356     for (SmallVectorImpl<const MachineInstr *>::const_iterator
1357              HI = History.begin(),
1358              HE = History.end();
1359          HI != HE; ++HI) {
1360       const MachineInstr *Begin = *HI;
1361       assert(Begin->isDebugValue() && "Invalid History entry");
1362
1363       // Check if DBG_VALUE is truncating a range.
1364       if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg() &&
1365           !Begin->getOperand(0).getReg())
1366         continue;
1367
1368       // Compute the range for a register location.
1369       const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1370       const MCSymbol *SLabel = 0;
1371
1372       if (HI + 1 == HE)
1373         // If Begin is the last instruction in History then its value is valid
1374         // until the end of the function.
1375         SLabel = FunctionEndSym;
1376       else {
1377         const MachineInstr *End = HI[1];
1378         DEBUG(dbgs() << "DotDebugLoc Pair:\n"
1379                      << "\t" << *Begin << "\t" << *End << "\n");
1380         if (End->isDebugValue())
1381           SLabel = getLabelBeforeInsn(End);
1382         else {
1383           // End is a normal instruction clobbering the range.
1384           SLabel = getLabelAfterInsn(End);
1385           assert(SLabel && "Forgot label after clobber instruction");
1386           ++HI;
1387         }
1388       }
1389
1390       // The value is valid until the next DBG_VALUE or clobber.
1391       DotDebugLocEntries.push_back(
1392           getDebugLocEntry(Asm, FLabel, SLabel, Begin));
1393     }
1394     DotDebugLocEntries.push_back(DotDebugLocEntry());
1395   }
1396
1397   // Collect info for variables that were optimized out.
1398   LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1399   DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1400   for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1401     DIVariable DV(Variables.getElement(i));
1402     if (!DV || !DV.isVariable() || !Processed.insert(DV))
1403       continue;
1404     if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
1405       addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
1406   }
1407 }
1408
1409 // Return Label preceding the instruction.
1410 MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
1411   MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1412   assert(Label && "Didn't insert label before instruction");
1413   return Label;
1414 }
1415
1416 // Return Label immediately following the instruction.
1417 MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
1418   return LabelsAfterInsn.lookup(MI);
1419 }
1420
1421 // Process beginning of an instruction.
1422 void DwarfDebug::beginInstruction(const MachineInstr *MI) {
1423   assert(CurMI == 0);
1424   CurMI = MI;
1425   // Check if source location changes, but ignore DBG_VALUE locations.
1426   if (!MI->isDebugValue()) {
1427     DebugLoc DL = MI->getDebugLoc();
1428     if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
1429       unsigned Flags = 0;
1430       PrevInstLoc = DL;
1431       if (DL == PrologEndLoc) {
1432         Flags |= DWARF2_FLAG_PROLOGUE_END;
1433         PrologEndLoc = DebugLoc();
1434       }
1435       if (PrologEndLoc.isUnknown())
1436         Flags |= DWARF2_FLAG_IS_STMT;
1437
1438       if (!DL.isUnknown()) {
1439         const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
1440         recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
1441       } else
1442         recordSourceLine(0, 0, 0, 0);
1443     }
1444   }
1445
1446   // Insert labels where requested.
1447   DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
1448       LabelsBeforeInsn.find(MI);
1449
1450   // No label needed.
1451   if (I == LabelsBeforeInsn.end())
1452     return;
1453
1454   // Label already assigned.
1455   if (I->second)
1456     return;
1457
1458   if (!PrevLabel) {
1459     PrevLabel = MMI->getContext().CreateTempSymbol();
1460     Asm->OutStreamer.EmitLabel(PrevLabel);
1461   }
1462   I->second = PrevLabel;
1463 }
1464
1465 // Process end of an instruction.
1466 void DwarfDebug::endInstruction() {
1467   assert(CurMI != 0);
1468   // Don't create a new label after DBG_VALUE instructions.
1469   // They don't generate code.
1470   if (!CurMI->isDebugValue())
1471     PrevLabel = 0;
1472
1473   DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
1474       LabelsAfterInsn.find(CurMI);
1475   CurMI = 0;
1476
1477   // No label needed.
1478   if (I == LabelsAfterInsn.end())
1479     return;
1480
1481   // Label already assigned.
1482   if (I->second)
1483     return;
1484
1485   // We need a label after this instruction.
1486   if (!PrevLabel) {
1487     PrevLabel = MMI->getContext().CreateTempSymbol();
1488     Asm->OutStreamer.EmitLabel(PrevLabel);
1489   }
1490   I->second = PrevLabel;
1491 }
1492
1493 // Each LexicalScope has first instruction and last instruction to mark
1494 // beginning and end of a scope respectively. Create an inverse map that list
1495 // scopes starts (and ends) with an instruction. One instruction may start (or
1496 // end) multiple scopes. Ignore scopes that are not reachable.
1497 void DwarfDebug::identifyScopeMarkers() {
1498   SmallVector<LexicalScope *, 4> WorkList;
1499   WorkList.push_back(LScopes.getCurrentFunctionScope());
1500   while (!WorkList.empty()) {
1501     LexicalScope *S = WorkList.pop_back_val();
1502
1503     const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
1504     if (!Children.empty())
1505       for (SmallVectorImpl<LexicalScope *>::const_iterator
1506                SI = Children.begin(),
1507                SE = Children.end();
1508            SI != SE; ++SI)
1509         WorkList.push_back(*SI);
1510
1511     if (S->isAbstractScope())
1512       continue;
1513
1514     const SmallVectorImpl<InsnRange> &Ranges = S->getRanges();
1515     if (Ranges.empty())
1516       continue;
1517     for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
1518                                                     RE = Ranges.end();
1519          RI != RE; ++RI) {
1520       assert(RI->first && "InsnRange does not have first instruction!");
1521       assert(RI->second && "InsnRange does not have second instruction!");
1522       requestLabelBeforeInsn(RI->first);
1523       requestLabelAfterInsn(RI->second);
1524     }
1525   }
1526 }
1527
1528 // Gather pre-function debug information.  Assumes being called immediately
1529 // after the function entry point has been emitted.
1530 void DwarfDebug::beginFunction(const MachineFunction *MF) {
1531   CurFn = MF;
1532
1533   // If there's no debug info for the function we're not going to do anything.
1534   if (!MMI->hasDebugInfo())
1535     return;
1536
1537   // Grab the lexical scopes for the function, if we don't have any of those
1538   // then we're not going to be able to do anything.
1539   LScopes.initialize(*MF);
1540   if (LScopes.empty())
1541     return;
1542
1543   assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1544
1545   // Make sure that each lexical scope will have a begin/end label.
1546   identifyScopeMarkers();
1547
1548   // Set DwarfDwarfCompileUnitID in MCContext to the Compile Unit this function
1549   // belongs to so that we add to the correct per-cu line table in the
1550   // non-asm case.
1551   LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1552   DwarfCompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1553   assert(TheCU && "Unable to find compile unit!");
1554   if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
1555     // Use a single line table if we are using .loc and generating assembly.
1556     Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1557   else
1558     Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
1559
1560   // Check the current section against the standard text section. If different
1561   // keep track so that we will know when we're emitting functions into multiple
1562   // sections.
1563   if (Asm->getObjFileLowering().getTextSection() != Asm->getCurrentSection())
1564     UsedNonDefaultText = true;
1565
1566   // Emit a label for the function so that we have a beginning address.
1567   FunctionBeginSym = Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber());
1568   // Assumes in correct section after the entry point.
1569   Asm->OutStreamer.EmitLabel(FunctionBeginSym);
1570
1571   const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
1572   // LiveUserVar - Map physreg numbers to the MDNode they contain.
1573   std::vector<const MDNode *> LiveUserVar(TRI->getNumRegs());
1574
1575   for (MachineFunction::const_iterator I = MF->begin(), E = MF->end(); I != E;
1576        ++I) {
1577     bool AtBlockEntry = true;
1578     for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1579          II != IE; ++II) {
1580       const MachineInstr *MI = II;
1581
1582       if (MI->isDebugValue()) {
1583         assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
1584
1585         // Keep track of user variables.
1586         const MDNode *Var =
1587             MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1588
1589         // Variable is in a register, we need to check for clobbers.
1590         if (isDbgValueInDefinedReg(MI))
1591           LiveUserVar[MI->getOperand(0).getReg()] = Var;
1592
1593         // Check the history of this variable.
1594         SmallVectorImpl<const MachineInstr *> &History = DbgValues[Var];
1595         if (History.empty()) {
1596           UserVariables.push_back(Var);
1597           // The first mention of a function argument gets the FunctionBeginSym
1598           // label, so arguments are visible when breaking at function entry.
1599           DIVariable DV(Var);
1600           if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
1601               getDISubprogram(DV.getContext()).describes(MF->getFunction()))
1602             LabelsBeforeInsn[MI] = FunctionBeginSym;
1603         } else {
1604           // We have seen this variable before. Try to coalesce DBG_VALUEs.
1605           const MachineInstr *Prev = History.back();
1606           if (Prev->isDebugValue()) {
1607             // Coalesce identical entries at the end of History.
1608             if (History.size() >= 2 &&
1609                 Prev->isIdenticalTo(History[History.size() - 2])) {
1610               DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
1611                            << "\t" << *Prev << "\t"
1612                            << *History[History.size() - 2] << "\n");
1613               History.pop_back();
1614             }
1615
1616             // Terminate old register assignments that don't reach MI;
1617             MachineFunction::const_iterator PrevMBB = Prev->getParent();
1618             if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1619                 isDbgValueInDefinedReg(Prev)) {
1620               // Previous register assignment needs to terminate at the end of
1621               // its basic block.
1622               MachineBasicBlock::const_iterator LastMI =
1623                   PrevMBB->getLastNonDebugInstr();
1624               if (LastMI == PrevMBB->end()) {
1625                 // Drop DBG_VALUE for empty range.
1626                 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
1627                              << "\t" << *Prev << "\n");
1628                 History.pop_back();
1629               } else if (llvm::next(PrevMBB) != PrevMBB->getParent()->end())
1630                 // Terminate after LastMI.
1631                 History.push_back(LastMI);
1632             }
1633           }
1634         }
1635         History.push_back(MI);
1636       } else {
1637         // Not a DBG_VALUE instruction.
1638         if (!MI->isLabel())
1639           AtBlockEntry = false;
1640
1641         // First known non-DBG_VALUE and non-frame setup location marks
1642         // the beginning of the function body.
1643         if (!MI->getFlag(MachineInstr::FrameSetup) &&
1644             (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
1645           PrologEndLoc = MI->getDebugLoc();
1646
1647         // Check if the instruction clobbers any registers with debug vars.
1648         for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1649                                               MOE = MI->operands_end();
1650              MOI != MOE; ++MOI) {
1651           if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1652             continue;
1653           for (MCRegAliasIterator AI(MOI->getReg(), TRI, true); AI.isValid();
1654                ++AI) {
1655             unsigned Reg = *AI;
1656             const MDNode *Var = LiveUserVar[Reg];
1657             if (!Var)
1658               continue;
1659             // Reg is now clobbered.
1660             LiveUserVar[Reg] = 0;
1661
1662             // Was MD last defined by a DBG_VALUE referring to Reg?
1663             DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1664             if (HistI == DbgValues.end())
1665               continue;
1666             SmallVectorImpl<const MachineInstr *> &History = HistI->second;
1667             if (History.empty())
1668               continue;
1669             const MachineInstr *Prev = History.back();
1670             // Sanity-check: Register assignments are terminated at the end of
1671             // their block.
1672             if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1673               continue;
1674             // Is the variable still in Reg?
1675             if (!isDbgValueInDefinedReg(Prev) ||
1676                 Prev->getOperand(0).getReg() != Reg)
1677               continue;
1678             // Var is clobbered. Make sure the next instruction gets a label.
1679             History.push_back(MI);
1680           }
1681         }
1682       }
1683     }
1684   }
1685
1686   for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1687        I != E; ++I) {
1688     SmallVectorImpl<const MachineInstr *> &History = I->second;
1689     if (History.empty())
1690       continue;
1691
1692     // Make sure the final register assignments are terminated.
1693     const MachineInstr *Prev = History.back();
1694     if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1695       const MachineBasicBlock *PrevMBB = Prev->getParent();
1696       MachineBasicBlock::const_iterator LastMI =
1697           PrevMBB->getLastNonDebugInstr();
1698       if (LastMI == PrevMBB->end())
1699         // Drop DBG_VALUE for empty range.
1700         History.pop_back();
1701       else if (PrevMBB != &PrevMBB->getParent()->back()) {
1702         // Terminate after LastMI.
1703         History.push_back(LastMI);
1704       }
1705     }
1706     // Request labels for the full history.
1707     for (unsigned i = 0, e = History.size(); i != e; ++i) {
1708       const MachineInstr *MI = History[i];
1709       if (MI->isDebugValue())
1710         requestLabelBeforeInsn(MI);
1711       else
1712         requestLabelAfterInsn(MI);
1713     }
1714   }
1715
1716   PrevInstLoc = DebugLoc();
1717   PrevLabel = FunctionBeginSym;
1718
1719   // Record beginning of function.
1720   if (!PrologEndLoc.isUnknown()) {
1721     DebugLoc FnStartDL =
1722         PrologEndLoc.getFnDebugLoc(MF->getFunction()->getContext());
1723     recordSourceLine(
1724         FnStartDL.getLine(), FnStartDL.getCol(),
1725         FnStartDL.getScope(MF->getFunction()->getContext()),
1726         // We'd like to list the prologue as "not statements" but GDB behaves
1727         // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
1728         DWARF2_FLAG_IS_STMT);
1729   }
1730 }
1731
1732 void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
1733   SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1734   DIVariable DV = Var->getVariable();
1735   // Variables with positive arg numbers are parameters.
1736   if (unsigned ArgNum = DV.getArgNumber()) {
1737     // Keep all parameters in order at the start of the variable list to ensure
1738     // function types are correct (no out-of-order parameters)
1739     //
1740     // This could be improved by only doing it for optimized builds (unoptimized
1741     // builds have the right order to begin with), searching from the back (this
1742     // would catch the unoptimized case quickly), or doing a binary search
1743     // rather than linear search.
1744     SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1745     while (I != Vars.end()) {
1746       unsigned CurNum = (*I)->getVariable().getArgNumber();
1747       // A local (non-parameter) variable has been found, insert immediately
1748       // before it.
1749       if (CurNum == 0)
1750         break;
1751       // A later indexed parameter has been found, insert immediately before it.
1752       if (CurNum > ArgNum)
1753         break;
1754       ++I;
1755     }
1756     Vars.insert(I, Var);
1757     return;
1758   }
1759
1760   Vars.push_back(Var);
1761 }
1762
1763 // Gather and emit post-function debug information.
1764 void DwarfDebug::endFunction(const MachineFunction *MF) {
1765   // Every beginFunction(MF) call should be followed by an endFunction(MF) call,
1766   // though the beginFunction may not be called at all.
1767   // We should handle both cases.
1768   if (CurFn == 0)
1769     CurFn = MF;
1770   else
1771     assert(CurFn == MF);
1772   assert(CurFn != 0);
1773
1774   if (!MMI->hasDebugInfo() || LScopes.empty()) {
1775     CurFn = 0;
1776     return;
1777   }
1778
1779   // Define end label for subprogram.
1780   FunctionEndSym = Asm->GetTempSymbol("func_end", Asm->getFunctionNumber());
1781   // Assumes in correct section after the entry point.
1782   Asm->OutStreamer.EmitLabel(FunctionEndSym);
1783   // Set DwarfDwarfCompileUnitID in MCContext to default value.
1784   Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1785
1786   SmallPtrSet<const MDNode *, 16> ProcessedVars;
1787   collectVariableInfo(ProcessedVars);
1788
1789   LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1790   DwarfCompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1791   assert(TheCU && "Unable to find compile unit!");
1792
1793   // Construct abstract scopes.
1794   ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1795   for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1796     LexicalScope *AScope = AList[i];
1797     DISubprogram SP(AScope->getScopeNode());
1798     if (SP.isSubprogram()) {
1799       // Collect info for variables that were optimized out.
1800       DIArray Variables = SP.getVariables();
1801       for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1802         DIVariable DV(Variables.getElement(i));
1803         if (!DV || !DV.isVariable() || !ProcessedVars.insert(DV))
1804           continue;
1805         // Check that DbgVariable for DV wasn't created earlier, when
1806         // findAbstractVariable() was called for inlined instance of DV.
1807         LLVMContext &Ctx = DV->getContext();
1808         DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1809         if (AbstractVariables.lookup(CleanDV))
1810           continue;
1811         if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
1812           addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
1813       }
1814     }
1815     if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
1816       constructScopeDIE(TheCU, AScope);
1817   }
1818
1819   DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
1820
1821   if (!CurFn->getTarget().Options.DisableFramePointerElim(*CurFn))
1822     TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
1823
1824   // Clear debug info
1825   for (ScopeVariablesMap::iterator I = ScopeVariables.begin(),
1826                                    E = ScopeVariables.end();
1827        I != E; ++I)
1828     DeleteContainerPointers(I->second);
1829   ScopeVariables.clear();
1830   DeleteContainerPointers(CurrentFnArguments);
1831   UserVariables.clear();
1832   DbgValues.clear();
1833   AbstractVariables.clear();
1834   LabelsBeforeInsn.clear();
1835   LabelsAfterInsn.clear();
1836   PrevLabel = NULL;
1837   CurFn = 0;
1838 }
1839
1840 // Register a source line with debug info. Returns the  unique label that was
1841 // emitted and which provides correspondence to the source line list.
1842 void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1843                                   unsigned Flags) {
1844   StringRef Fn;
1845   StringRef Dir;
1846   unsigned Src = 1;
1847   if (S) {
1848     DIDescriptor Scope(S);
1849
1850     if (Scope.isCompileUnit()) {
1851       DICompileUnit CU(S);
1852       Fn = CU.getFilename();
1853       Dir = CU.getDirectory();
1854     } else if (Scope.isFile()) {
1855       DIFile F(S);
1856       Fn = F.getFilename();
1857       Dir = F.getDirectory();
1858     } else if (Scope.isSubprogram()) {
1859       DISubprogram SP(S);
1860       Fn = SP.getFilename();
1861       Dir = SP.getDirectory();
1862     } else if (Scope.isLexicalBlockFile()) {
1863       DILexicalBlockFile DBF(S);
1864       Fn = DBF.getFilename();
1865       Dir = DBF.getDirectory();
1866     } else if (Scope.isLexicalBlock()) {
1867       DILexicalBlock DB(S);
1868       Fn = DB.getFilename();
1869       Dir = DB.getDirectory();
1870     } else
1871       llvm_unreachable("Unexpected scope info");
1872
1873     Src = getOrCreateSourceID(
1874         Fn, Dir, Asm->OutStreamer.getContext().getDwarfCompileUnitID());
1875   }
1876   Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
1877 }
1878
1879 //===----------------------------------------------------------------------===//
1880 // Emit Methods
1881 //===----------------------------------------------------------------------===//
1882
1883 // Compute the size and offset of a DIE. The offset is relative to start of the
1884 // CU. It returns the offset after laying out the DIE.
1885 unsigned DwarfFile::computeSizeAndOffset(DIE *Die, unsigned Offset) {
1886   // Get the children.
1887   const std::vector<DIE *> &Children = Die->getChildren();
1888
1889   // Record the abbreviation.
1890   assignAbbrevNumber(Die->getAbbrev());
1891
1892   // Get the abbreviation for this DIE.
1893   const DIEAbbrev &Abbrev = Die->getAbbrev();
1894
1895   // Set DIE offset
1896   Die->setOffset(Offset);
1897
1898   // Start the size with the size of abbreviation code.
1899   Offset += MCAsmInfo::getULEB128Size(Die->getAbbrevNumber());
1900
1901   const SmallVectorImpl<DIEValue *> &Values = Die->getValues();
1902   const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
1903
1904   // Size the DIE attribute values.
1905   for (unsigned i = 0, N = Values.size(); i < N; ++i)
1906     // Size attribute value.
1907     Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
1908
1909   // Size the DIE children if any.
1910   if (!Children.empty()) {
1911     assert(Abbrev.getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1912            "Children flag not set");
1913
1914     for (unsigned j = 0, M = Children.size(); j < M; ++j)
1915       Offset = computeSizeAndOffset(Children[j], Offset);
1916
1917     // End of children marker.
1918     Offset += sizeof(int8_t);
1919   }
1920
1921   Die->setSize(Offset - Die->getOffset());
1922   return Offset;
1923 }
1924
1925 // Compute the size and offset for each DIE.
1926 void DwarfFile::computeSizeAndOffsets() {
1927   // Offset from the first CU in the debug info section is 0 initially.
1928   unsigned SecOffset = 0;
1929
1930   // Iterate over each compile unit and set the size and offsets for each
1931   // DIE within each compile unit. All offsets are CU relative.
1932   for (SmallVectorImpl<DwarfUnit *>::const_iterator I = CUs.begin(),
1933                                                     E = CUs.end();
1934        I != E; ++I) {
1935     (*I)->setDebugInfoOffset(SecOffset);
1936
1937     // CU-relative offset is reset to 0 here.
1938     unsigned Offset = sizeof(int32_t) +      // Length of Unit Info
1939                       (*I)->getHeaderSize(); // Unit-specific headers
1940
1941     // EndOffset here is CU-relative, after laying out
1942     // all of the CU DIE.
1943     unsigned EndOffset = computeSizeAndOffset((*I)->getUnitDie(), Offset);
1944     SecOffset += EndOffset;
1945   }
1946 }
1947
1948 // Emit initial Dwarf sections with a label at the start of each one.
1949 void DwarfDebug::emitSectionLabels() {
1950   const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
1951
1952   // Dwarf sections base addresses.
1953   DwarfInfoSectionSym =
1954       emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
1955   if (useSplitDwarf())
1956     DwarfInfoDWOSectionSym =
1957         emitSectionSym(Asm, TLOF.getDwarfInfoDWOSection(), "section_info_dwo");
1958   DwarfAbbrevSectionSym =
1959       emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
1960   if (useSplitDwarf())
1961     DwarfAbbrevDWOSectionSym = emitSectionSym(
1962         Asm, TLOF.getDwarfAbbrevDWOSection(), "section_abbrev_dwo");
1963   emitSectionSym(Asm, TLOF.getDwarfARangesSection());
1964
1965   if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
1966     emitSectionSym(Asm, MacroInfo);
1967
1968   DwarfLineSectionSym =
1969       emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
1970   emitSectionSym(Asm, TLOF.getDwarfLocSection());
1971   if (GenerateGnuPubSections) {
1972     DwarfGnuPubNamesSectionSym =
1973         emitSectionSym(Asm, TLOF.getDwarfGnuPubNamesSection());
1974     DwarfGnuPubTypesSectionSym =
1975         emitSectionSym(Asm, TLOF.getDwarfGnuPubTypesSection());
1976   } else if (HasDwarfPubSections) {
1977     emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
1978     emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
1979   }
1980
1981   DwarfStrSectionSym =
1982       emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
1983   if (useSplitDwarf()) {
1984     DwarfStrDWOSectionSym =
1985         emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
1986     DwarfAddrSectionSym =
1987         emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
1988   }
1989   DwarfDebugRangeSectionSym =
1990       emitSectionSym(Asm, TLOF.getDwarfRangesSection(), "debug_range");
1991
1992   DwarfDebugLocSectionSym =
1993       emitSectionSym(Asm, TLOF.getDwarfLocSection(), "section_debug_loc");
1994 }
1995
1996 // Recursively emits a debug information entry.
1997 void DwarfDebug::emitDIE(DIE *Die) {
1998   // Get the abbreviation for this DIE.
1999   const DIEAbbrev &Abbrev = Die->getAbbrev();
2000
2001   // Emit the code (index) for the abbreviation.
2002   if (Asm->isVerbose())
2003     Asm->OutStreamer.AddComment("Abbrev [" + Twine(Abbrev.getNumber()) +
2004                                 "] 0x" + Twine::utohexstr(Die->getOffset()) +
2005                                 ":0x" + Twine::utohexstr(Die->getSize()) + " " +
2006                                 dwarf::TagString(Abbrev.getTag()));
2007   Asm->EmitULEB128(Abbrev.getNumber());
2008
2009   const SmallVectorImpl<DIEValue *> &Values = Die->getValues();
2010   const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
2011
2012   // Emit the DIE attribute values.
2013   for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2014     dwarf::Attribute Attr = AbbrevData[i].getAttribute();
2015     dwarf::Form Form = AbbrevData[i].getForm();
2016     assert(Form && "Too many attributes for DIE (check abbreviation)");
2017
2018     if (Asm->isVerbose())
2019       Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
2020
2021     switch (Attr) {
2022     case dwarf::DW_AT_abstract_origin:
2023     case dwarf::DW_AT_type:
2024     case dwarf::DW_AT_friend:
2025     case dwarf::DW_AT_specification:
2026     case dwarf::DW_AT_import:
2027     case dwarf::DW_AT_containing_type: {
2028       DIEEntry *E = cast<DIEEntry>(Values[i]);
2029       DIE *Origin = E->getEntry();
2030       unsigned Addr = Origin->getOffset();
2031       if (Form == dwarf::DW_FORM_ref_addr) {
2032         assert(!useSplitDwarf() && "TODO: dwo files can't have relocations.");
2033         // For DW_FORM_ref_addr, output the offset from beginning of debug info
2034         // section. Origin->getOffset() returns the offset from start of the
2035         // compile unit.
2036         DwarfCompileUnit *CU = CUDieMap.lookup(Origin->getUnit());
2037         assert(CU && "CUDie should belong to a CU.");
2038         Addr += CU->getDebugInfoOffset();
2039         if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2040           Asm->EmitLabelPlusOffset(CU->getSectionSym(), Addr,
2041                                    DIEEntry::getRefAddrSize(Asm));
2042         else
2043           Asm->EmitLabelOffsetDifference(CU->getSectionSym(), Addr,
2044                                          CU->getSectionSym(),
2045                                          DIEEntry::getRefAddrSize(Asm));
2046       } else {
2047         // Make sure Origin belong to the same CU.
2048         assert(Die->getUnit() == Origin->getUnit() &&
2049                "The referenced DIE should belong to the same CU in ref4");
2050         Asm->EmitInt32(Addr);
2051       }
2052       break;
2053     }
2054     case dwarf::DW_AT_location: {
2055       if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
2056         if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2057           Asm->EmitSectionOffset(L->getValue(), DwarfDebugLocSectionSym);
2058         else
2059           Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
2060       } else {
2061         Values[i]->EmitValue(Asm, Form);
2062       }
2063       break;
2064     }
2065     case dwarf::DW_AT_accessibility: {
2066       if (Asm->isVerbose()) {
2067         DIEInteger *V = cast<DIEInteger>(Values[i]);
2068         Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
2069       }
2070       Values[i]->EmitValue(Asm, Form);
2071       break;
2072     }
2073     default:
2074       // Emit an attribute using the defined form.
2075       Values[i]->EmitValue(Asm, Form);
2076       break;
2077     }
2078   }
2079
2080   // Emit the DIE children if any.
2081   if (Abbrev.getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2082     const std::vector<DIE *> &Children = Die->getChildren();
2083
2084     for (unsigned j = 0, M = Children.size(); j < M; ++j)
2085       emitDIE(Children[j]);
2086
2087     Asm->OutStreamer.AddComment("End Of Children Mark");
2088     Asm->EmitInt8(0);
2089   }
2090 }
2091
2092 // Emit the various dwarf units to the unit section USection with
2093 // the abbreviations going into ASection.
2094 void DwarfFile::emitUnits(DwarfDebug *DD, const MCSection *ASection,
2095                           const MCSymbol *ASectionSym) {
2096   for (SmallVectorImpl<DwarfUnit *>::iterator I = CUs.begin(), E = CUs.end();
2097        I != E; ++I) {
2098     DwarfUnit *TheU = *I;
2099     DIE *Die = TheU->getUnitDie();
2100     const MCSection *USection = TheU->getSection();
2101     Asm->OutStreamer.SwitchSection(USection);
2102
2103     // Emit the compile units header.
2104     Asm->OutStreamer.EmitLabel(TheU->getLabelBegin());
2105
2106     // Emit size of content not including length itself
2107     Asm->OutStreamer.AddComment("Length of Unit");
2108     Asm->EmitInt32(TheU->getHeaderSize() + Die->getSize());
2109
2110     TheU->emitHeader(ASection, ASectionSym);
2111
2112     DD->emitDIE(Die);
2113     Asm->OutStreamer.EmitLabel(TheU->getLabelEnd());
2114   }
2115 }
2116
2117 // Emit the debug info section.
2118 void DwarfDebug::emitDebugInfo() {
2119   DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2120
2121   Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfAbbrevSection(),
2122                    DwarfAbbrevSectionSym);
2123 }
2124
2125 // Emit the abbreviation section.
2126 void DwarfDebug::emitAbbreviations() {
2127   DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2128
2129   Holder.emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
2130 }
2131
2132 void DwarfFile::emitAbbrevs(const MCSection *Section) {
2133   // Check to see if it is worth the effort.
2134   if (!Abbreviations.empty()) {
2135     // Start the debug abbrev section.
2136     Asm->OutStreamer.SwitchSection(Section);
2137
2138     // For each abbrevation.
2139     for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2140       // Get abbreviation data
2141       const DIEAbbrev *Abbrev = Abbreviations[i];
2142
2143       // Emit the abbrevations code (base 1 index.)
2144       Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
2145
2146       // Emit the abbreviations data.
2147       Abbrev->Emit(Asm);
2148     }
2149
2150     // Mark end of abbreviations.
2151     Asm->EmitULEB128(0, "EOM(3)");
2152   }
2153 }
2154
2155 // Emit the last address of the section and the end of the line matrix.
2156 void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
2157   // Define last address of section.
2158   Asm->OutStreamer.AddComment("Extended Op");
2159   Asm->EmitInt8(0);
2160
2161   Asm->OutStreamer.AddComment("Op size");
2162   Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
2163   Asm->OutStreamer.AddComment("DW_LNE_set_address");
2164   Asm->EmitInt8(dwarf::DW_LNE_set_address);
2165
2166   Asm->OutStreamer.AddComment("Section end label");
2167
2168   Asm->OutStreamer.EmitSymbolValue(
2169       Asm->GetTempSymbol("section_end", SectionEnd),
2170       Asm->getDataLayout().getPointerSize());
2171
2172   // Mark end of matrix.
2173   Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2174   Asm->EmitInt8(0);
2175   Asm->EmitInt8(1);
2176   Asm->EmitInt8(1);
2177 }
2178
2179 // Emit visible names into a hashed accelerator table section.
2180 void DwarfDebug::emitAccelNames() {
2181   DwarfAccelTable AT(
2182       DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
2183   for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2184                                                     E = getUnits().end();
2185        I != E; ++I) {
2186     DwarfUnit *TheU = *I;
2187     const StringMap<std::vector<const DIE *> > &Names = TheU->getAccelNames();
2188     for (StringMap<std::vector<const DIE *> >::const_iterator
2189              GI = Names.begin(),
2190              GE = Names.end();
2191          GI != GE; ++GI) {
2192       StringRef Name = GI->getKey();
2193       const std::vector<const DIE *> &Entities = GI->second;
2194       for (std::vector<const DIE *>::const_iterator DI = Entities.begin(),
2195                                                     DE = Entities.end();
2196            DI != DE; ++DI)
2197         AT.AddName(Name, *DI);
2198     }
2199   }
2200
2201   AT.FinalizeTable(Asm, "Names");
2202   Asm->OutStreamer.SwitchSection(
2203       Asm->getObjFileLowering().getDwarfAccelNamesSection());
2204   MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2205   Asm->OutStreamer.EmitLabel(SectionBegin);
2206
2207   // Emit the full data.
2208   AT.Emit(Asm, SectionBegin, &InfoHolder);
2209 }
2210
2211 // Emit objective C classes and categories into a hashed accelerator table
2212 // section.
2213 void DwarfDebug::emitAccelObjC() {
2214   DwarfAccelTable AT(
2215       DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
2216   for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2217                                                     E = getUnits().end();
2218        I != E; ++I) {
2219     DwarfUnit *TheU = *I;
2220     const StringMap<std::vector<const DIE *> > &Names = TheU->getAccelObjC();
2221     for (StringMap<std::vector<const DIE *> >::const_iterator
2222              GI = Names.begin(),
2223              GE = Names.end();
2224          GI != GE; ++GI) {
2225       StringRef Name = GI->getKey();
2226       const std::vector<const DIE *> &Entities = GI->second;
2227       for (std::vector<const DIE *>::const_iterator DI = Entities.begin(),
2228                                                     DE = Entities.end();
2229            DI != DE; ++DI)
2230         AT.AddName(Name, *DI);
2231     }
2232   }
2233
2234   AT.FinalizeTable(Asm, "ObjC");
2235   Asm->OutStreamer.SwitchSection(
2236       Asm->getObjFileLowering().getDwarfAccelObjCSection());
2237   MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2238   Asm->OutStreamer.EmitLabel(SectionBegin);
2239
2240   // Emit the full data.
2241   AT.Emit(Asm, SectionBegin, &InfoHolder);
2242 }
2243
2244 // Emit namespace dies into a hashed accelerator table.
2245 void DwarfDebug::emitAccelNamespaces() {
2246   DwarfAccelTable AT(
2247       DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
2248   for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2249                                                     E = getUnits().end();
2250        I != E; ++I) {
2251     DwarfUnit *TheU = *I;
2252     const StringMap<std::vector<const DIE *> > &Names =
2253         TheU->getAccelNamespace();
2254     for (StringMap<std::vector<const DIE *> >::const_iterator
2255              GI = Names.begin(),
2256              GE = Names.end();
2257          GI != GE; ++GI) {
2258       StringRef Name = GI->getKey();
2259       const std::vector<const DIE *> &Entities = GI->second;
2260       for (std::vector<const DIE *>::const_iterator DI = Entities.begin(),
2261                                                     DE = Entities.end();
2262            DI != DE; ++DI)
2263         AT.AddName(Name, *DI);
2264     }
2265   }
2266
2267   AT.FinalizeTable(Asm, "namespac");
2268   Asm->OutStreamer.SwitchSection(
2269       Asm->getObjFileLowering().getDwarfAccelNamespaceSection());
2270   MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2271   Asm->OutStreamer.EmitLabel(SectionBegin);
2272
2273   // Emit the full data.
2274   AT.Emit(Asm, SectionBegin, &InfoHolder);
2275 }
2276
2277 // Emit type dies into a hashed accelerator table.
2278 void DwarfDebug::emitAccelTypes() {
2279   std::vector<DwarfAccelTable::Atom> Atoms;
2280   Atoms.push_back(
2281       DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
2282   Atoms.push_back(
2283       DwarfAccelTable::Atom(dwarf::DW_ATOM_die_tag, dwarf::DW_FORM_data2));
2284   Atoms.push_back(
2285       DwarfAccelTable::Atom(dwarf::DW_ATOM_type_flags, dwarf::DW_FORM_data1));
2286   DwarfAccelTable AT(Atoms);
2287   for (SmallVectorImpl<DwarfUnit *>::const_iterator I = getUnits().begin(),
2288                                                     E = getUnits().end();
2289        I != E; ++I) {
2290     DwarfUnit *TheU = *I;
2291     const StringMap<std::vector<std::pair<const DIE *, unsigned> > > &Names =
2292         TheU->getAccelTypes();
2293     for (StringMap<
2294              std::vector<std::pair<const DIE *, unsigned> > >::const_iterator
2295              GI = Names.begin(),
2296              GE = Names.end();
2297          GI != GE; ++GI) {
2298       StringRef Name = GI->getKey();
2299       const std::vector<std::pair<const DIE *, unsigned> > &Entities =
2300           GI->second;
2301       for (std::vector<std::pair<const DIE *, unsigned> >::const_iterator
2302                DI = Entities.begin(),
2303                DE = Entities.end();
2304            DI != DE; ++DI)
2305         AT.AddName(Name, DI->first, DI->second);
2306     }
2307   }
2308
2309   AT.FinalizeTable(Asm, "types");
2310   Asm->OutStreamer.SwitchSection(
2311       Asm->getObjFileLowering().getDwarfAccelTypesSection());
2312   MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2313   Asm->OutStreamer.EmitLabel(SectionBegin);
2314
2315   // Emit the full data.
2316   AT.Emit(Asm, SectionBegin, &InfoHolder);
2317 }
2318
2319 // Public name handling.
2320 // The format for the various pubnames:
2321 //
2322 // dwarf pubnames - offset/name pairs where the offset is the offset into the CU
2323 // for the DIE that is named.
2324 //
2325 // gnu pubnames - offset/index value/name tuples where the offset is the offset
2326 // into the CU and the index value is computed according to the type of value
2327 // for the DIE that is named.
2328 //
2329 // For type units the offset is the offset of the skeleton DIE. For split dwarf
2330 // it's the offset within the debug_info/debug_types dwo section, however, the
2331 // reference in the pubname header doesn't change.
2332
2333 /// computeIndexValue - Compute the gdb index value for the DIE and CU.
2334 static dwarf::PubIndexEntryDescriptor computeIndexValue(DwarfUnit *CU,
2335                                                         const DIE *Die) {
2336   dwarf::GDBIndexEntryLinkage Linkage = dwarf::GIEL_STATIC;
2337
2338   // We could have a specification DIE that has our most of our knowledge,
2339   // look for that now.
2340   DIEValue *SpecVal = Die->findAttribute(dwarf::DW_AT_specification);
2341   if (SpecVal) {
2342     DIE *SpecDIE = cast<DIEEntry>(SpecVal)->getEntry();
2343     if (SpecDIE->findAttribute(dwarf::DW_AT_external))
2344       Linkage = dwarf::GIEL_EXTERNAL;
2345   } else if (Die->findAttribute(dwarf::DW_AT_external))
2346     Linkage = dwarf::GIEL_EXTERNAL;
2347
2348   switch (Die->getTag()) {
2349   case dwarf::DW_TAG_class_type:
2350   case dwarf::DW_TAG_structure_type:
2351   case dwarf::DW_TAG_union_type:
2352   case dwarf::DW_TAG_enumeration_type:
2353     return dwarf::PubIndexEntryDescriptor(
2354         dwarf::GIEK_TYPE, CU->getLanguage() != dwarf::DW_LANG_C_plus_plus
2355                               ? dwarf::GIEL_STATIC
2356                               : dwarf::GIEL_EXTERNAL);
2357   case dwarf::DW_TAG_typedef:
2358   case dwarf::DW_TAG_base_type:
2359   case dwarf::DW_TAG_subrange_type:
2360     return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_TYPE, dwarf::GIEL_STATIC);
2361   case dwarf::DW_TAG_namespace:
2362     return dwarf::GIEK_TYPE;
2363   case dwarf::DW_TAG_subprogram:
2364     return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_FUNCTION, Linkage);
2365   case dwarf::DW_TAG_constant:
2366   case dwarf::DW_TAG_variable:
2367     return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE, Linkage);
2368   case dwarf::DW_TAG_enumerator:
2369     return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE,
2370                                           dwarf::GIEL_STATIC);
2371   default:
2372     return dwarf::GIEK_NONE;
2373   }
2374 }
2375
2376 /// emitDebugPubNames - Emit visible names into a debug pubnames section.
2377 ///
2378 void DwarfDebug::emitDebugPubNames(bool GnuStyle) {
2379   const MCSection *PSec =
2380       GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubNamesSection()
2381                : Asm->getObjFileLowering().getDwarfPubNamesSection();
2382
2383   DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2384   const SmallVectorImpl<DwarfUnit *> &Units = Holder.getUnits();
2385   for (unsigned i = 0; i != Units.size(); ++i) {
2386     DwarfUnit *TheU = Units[i];
2387     unsigned ID = TheU->getUniqueID();
2388
2389     // Start the dwarf pubnames section.
2390     Asm->OutStreamer.SwitchSection(PSec);
2391
2392     // Emit a label so we can reference the beginning of this pubname section.
2393     if (GnuStyle)
2394       Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubnames", ID));
2395
2396     // Emit the header.
2397     Asm->OutStreamer.AddComment("Length of Public Names Info");
2398     MCSymbol *BeginLabel = Asm->GetTempSymbol("pubnames_begin", ID);
2399     MCSymbol *EndLabel = Asm->GetTempSymbol("pubnames_end", ID);
2400     Asm->EmitLabelDifference(EndLabel, BeginLabel, 4);
2401
2402     Asm->OutStreamer.EmitLabel(BeginLabel);
2403
2404     Asm->OutStreamer.AddComment("DWARF Version");
2405     Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION);
2406
2407     Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2408     Asm->EmitSectionOffset(TheU->getLabelBegin(), TheU->getSectionSym());
2409
2410     Asm->OutStreamer.AddComment("Compilation Unit Length");
2411     Asm->EmitLabelDifference(TheU->getLabelEnd(), TheU->getLabelBegin(), 4);
2412
2413     // Emit the pubnames for this compilation unit.
2414     const StringMap<const DIE *> &Globals = getUnits()[ID]->getGlobalNames();
2415     for (StringMap<const DIE *>::const_iterator GI = Globals.begin(),
2416                                                 GE = Globals.end();
2417          GI != GE; ++GI) {
2418       const char *Name = GI->getKeyData();
2419       const DIE *Entity = GI->second;
2420
2421       Asm->OutStreamer.AddComment("DIE offset");
2422       Asm->EmitInt32(Entity->getOffset());
2423
2424       if (GnuStyle) {
2425         dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheU, Entity);
2426         Asm->OutStreamer.AddComment(
2427             Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
2428             dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
2429         Asm->EmitInt8(Desc.toBits());
2430       }
2431
2432       Asm->OutStreamer.AddComment("External Name");
2433       Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
2434     }
2435
2436     Asm->OutStreamer.AddComment("End Mark");
2437     Asm->EmitInt32(0);
2438     Asm->OutStreamer.EmitLabel(EndLabel);
2439   }
2440 }
2441
2442 void DwarfDebug::emitDebugPubTypes(bool GnuStyle) {
2443   const MCSection *PSec =
2444       GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubTypesSection()
2445                : Asm->getObjFileLowering().getDwarfPubTypesSection();
2446
2447   DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2448   const SmallVectorImpl<DwarfUnit *> &Units = Holder.getUnits();
2449   for (unsigned i = 0; i != Units.size(); ++i) {
2450     DwarfUnit *TheU = Units[i];
2451     unsigned ID = TheU->getUniqueID();
2452
2453     // Start the dwarf pubtypes section.
2454     Asm->OutStreamer.SwitchSection(PSec);
2455
2456     // Emit a label so we can reference the beginning of this pubtype section.
2457     if (GnuStyle)
2458       Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubtypes", ID));
2459
2460     // Emit the header.
2461     Asm->OutStreamer.AddComment("Length of Public Types Info");
2462     MCSymbol *BeginLabel = Asm->GetTempSymbol("pubtypes_begin", ID);
2463     MCSymbol *EndLabel = Asm->GetTempSymbol("pubtypes_end", ID);
2464     Asm->EmitLabelDifference(EndLabel, BeginLabel, 4);
2465
2466     Asm->OutStreamer.EmitLabel(BeginLabel);
2467
2468     Asm->OutStreamer.AddComment("DWARF Version");
2469     Asm->EmitInt16(dwarf::DW_PUBTYPES_VERSION);
2470
2471     Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2472     Asm->EmitSectionOffset(TheU->getLabelBegin(), TheU->getSectionSym());
2473
2474     Asm->OutStreamer.AddComment("Compilation Unit Length");
2475     Asm->EmitLabelDifference(TheU->getLabelEnd(), TheU->getLabelBegin(), 4);
2476
2477     // Emit the pubtypes.
2478     const StringMap<const DIE *> &Globals = getUnits()[ID]->getGlobalTypes();
2479     for (StringMap<const DIE *>::const_iterator GI = Globals.begin(),
2480                                                 GE = Globals.end();
2481          GI != GE; ++GI) {
2482       const char *Name = GI->getKeyData();
2483       const DIE *Entity = GI->second;
2484
2485       Asm->OutStreamer.AddComment("DIE offset");
2486       Asm->EmitInt32(Entity->getOffset());
2487
2488       if (GnuStyle) {
2489         dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheU, Entity);
2490         Asm->OutStreamer.AddComment(
2491             Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
2492             dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
2493         Asm->EmitInt8(Desc.toBits());
2494       }
2495
2496       Asm->OutStreamer.AddComment("External Name");
2497
2498       // Emit the name with a terminating null byte.
2499       Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
2500     }
2501
2502     Asm->OutStreamer.AddComment("End Mark");
2503     Asm->EmitInt32(0);
2504     Asm->OutStreamer.EmitLabel(EndLabel);
2505   }
2506 }
2507
2508 // Emit strings into a string section.
2509 void DwarfFile::emitStrings(const MCSection *StrSection,
2510                             const MCSection *OffsetSection = NULL,
2511                             const MCSymbol *StrSecSym = NULL) {
2512
2513   if (StringPool.empty())
2514     return;
2515
2516   // Start the dwarf str section.
2517   Asm->OutStreamer.SwitchSection(StrSection);
2518
2519   // Get all of the string pool entries and put them in an array by their ID so
2520   // we can sort them.
2521   SmallVector<
2522       std::pair<unsigned, StringMapEntry<std::pair<MCSymbol *, unsigned> > *>,
2523       64> Entries;
2524
2525   for (StringMap<std::pair<MCSymbol *, unsigned> >::iterator
2526            I = StringPool.begin(),
2527            E = StringPool.end();
2528        I != E; ++I)
2529     Entries.push_back(std::make_pair(I->second.second, &*I));
2530
2531   array_pod_sort(Entries.begin(), Entries.end());
2532
2533   for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
2534     // Emit a label for reference from debug information entries.
2535     Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
2536
2537     // Emit the string itself with a terminating null byte.
2538     Asm->OutStreamer.EmitBytes(
2539         StringRef(Entries[i].second->getKeyData(),
2540                   Entries[i].second->getKeyLength() + 1));
2541   }
2542
2543   // If we've got an offset section go ahead and emit that now as well.
2544   if (OffsetSection) {
2545     Asm->OutStreamer.SwitchSection(OffsetSection);
2546     unsigned offset = 0;
2547     unsigned size = 4; // FIXME: DWARF64 is 8.
2548     for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
2549       Asm->OutStreamer.EmitIntValue(offset, size);
2550       offset += Entries[i].second->getKeyLength() + 1;
2551     }
2552   }
2553 }
2554
2555 // Emit addresses into the section given.
2556 void DwarfFile::emitAddresses(const MCSection *AddrSection) {
2557
2558   if (AddressPool.empty())
2559     return;
2560
2561   // Start the dwarf addr section.
2562   Asm->OutStreamer.SwitchSection(AddrSection);
2563
2564   // Order the address pool entries by ID
2565   SmallVector<const MCExpr *, 64> Entries(AddressPool.size());
2566
2567   for (DenseMap<const MCExpr *, unsigned>::iterator I = AddressPool.begin(),
2568                                                     E = AddressPool.end();
2569        I != E; ++I)
2570     Entries[I->second] = I->first;
2571
2572   for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
2573     // Emit an expression for reference from debug information entries.
2574     if (const MCExpr *Expr = Entries[i])
2575       Asm->OutStreamer.EmitValue(Expr, Asm->getDataLayout().getPointerSize());
2576     else
2577       Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2578   }
2579 }
2580
2581 // Emit visible names into a debug str section.
2582 void DwarfDebug::emitDebugStr() {
2583   DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2584   Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2585 }
2586
2587 // Emit locations into the debug loc section.
2588 void DwarfDebug::emitDebugLoc() {
2589   if (DotDebugLocEntries.empty())
2590     return;
2591
2592   for (SmallVectorImpl<DotDebugLocEntry>::iterator
2593            I = DotDebugLocEntries.begin(),
2594            E = DotDebugLocEntries.end();
2595        I != E; ++I) {
2596     DotDebugLocEntry &Entry = *I;
2597     if (I + 1 != DotDebugLocEntries.end())
2598       Entry.Merge(I + 1);
2599   }
2600
2601   // Start the dwarf loc section.
2602   Asm->OutStreamer.SwitchSection(
2603       Asm->getObjFileLowering().getDwarfLocSection());
2604   unsigned char Size = Asm->getDataLayout().getPointerSize();
2605   Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2606   unsigned index = 1;
2607   for (SmallVectorImpl<DotDebugLocEntry>::iterator
2608            I = DotDebugLocEntries.begin(),
2609            E = DotDebugLocEntries.end();
2610        I != E; ++I, ++index) {
2611     DotDebugLocEntry &Entry = *I;
2612     if (Entry.isMerged())
2613       continue;
2614     if (Entry.isEmpty()) {
2615       Asm->OutStreamer.EmitIntValue(0, Size);
2616       Asm->OutStreamer.EmitIntValue(0, Size);
2617       Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
2618     } else {
2619       Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2620       Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2621       DIVariable DV(Entry.getVariable());
2622       Asm->OutStreamer.AddComment("Loc expr size");
2623       MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2624       MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2625       Asm->EmitLabelDifference(end, begin, 2);
2626       Asm->OutStreamer.EmitLabel(begin);
2627       if (Entry.isInt()) {
2628         DIBasicType BTy(DV.getType());
2629         if (BTy.Verify() && (BTy.getEncoding() == dwarf::DW_ATE_signed ||
2630                              BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2631           Asm->OutStreamer.AddComment("DW_OP_consts");
2632           Asm->EmitInt8(dwarf::DW_OP_consts);
2633           Asm->EmitSLEB128(Entry.getInt());
2634         } else {
2635           Asm->OutStreamer.AddComment("DW_OP_constu");
2636           Asm->EmitInt8(dwarf::DW_OP_constu);
2637           Asm->EmitULEB128(Entry.getInt());
2638         }
2639       } else if (Entry.isLocation()) {
2640         MachineLocation Loc = Entry.getLoc();
2641         if (!DV.hasComplexAddress())
2642           // Regular entry.
2643           Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
2644         else {
2645           // Complex address entry.
2646           unsigned N = DV.getNumAddrElements();
2647           unsigned i = 0;
2648           if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
2649             if (Loc.getOffset()) {
2650               i = 2;
2651               Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
2652               Asm->OutStreamer.AddComment("DW_OP_deref");
2653               Asm->EmitInt8(dwarf::DW_OP_deref);
2654               Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2655               Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2656               Asm->EmitSLEB128(DV.getAddrElement(1));
2657             } else {
2658               // If first address element is OpPlus then emit
2659               // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
2660               MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
2661               Asm->EmitDwarfRegOp(TLoc, DV.isIndirect());
2662               i = 2;
2663             }
2664           } else {
2665             Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
2666           }
2667
2668           // Emit remaining complex address elements.
2669           for (; i < N; ++i) {
2670             uint64_t Element = DV.getAddrElement(i);
2671             if (Element == DIBuilder::OpPlus) {
2672               Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2673               Asm->EmitULEB128(DV.getAddrElement(++i));
2674             } else if (Element == DIBuilder::OpDeref) {
2675               if (!Loc.isReg())
2676                 Asm->EmitInt8(dwarf::DW_OP_deref);
2677             } else
2678               llvm_unreachable("unknown Opcode found in complex address");
2679           }
2680         }
2681       }
2682       // else ... ignore constant fp. There is not any good way to
2683       // to represent them here in dwarf.
2684       Asm->OutStreamer.EmitLabel(end);
2685     }
2686   }
2687 }
2688
2689 struct SymbolCUSorter {
2690   SymbolCUSorter(const MCStreamer &s) : Streamer(s) {}
2691   const MCStreamer &Streamer;
2692
2693   bool operator()(const SymbolCU &A, const SymbolCU &B) {
2694     unsigned IA = A.Sym ? Streamer.GetSymbolOrder(A.Sym) : 0;
2695     unsigned IB = B.Sym ? Streamer.GetSymbolOrder(B.Sym) : 0;
2696
2697     // Symbols with no order assigned should be placed at the end.
2698     // (e.g. section end labels)
2699     if (IA == 0)
2700       IA = (unsigned)(-1);
2701     if (IB == 0)
2702       IB = (unsigned)(-1);
2703     return IA < IB;
2704   }
2705 };
2706
2707 static bool CUSort(const DwarfUnit *A, const DwarfUnit *B) {
2708   return (A->getUniqueID() < B->getUniqueID());
2709 }
2710
2711 struct ArangeSpan {
2712   const MCSymbol *Start, *End;
2713 };
2714
2715 // Emit a debug aranges section, containing a CU lookup for any
2716 // address we can tie back to a CU.
2717 void DwarfDebug::emitDebugARanges() {
2718   // Start the dwarf aranges section.
2719   Asm->OutStreamer.SwitchSection(
2720       Asm->getObjFileLowering().getDwarfARangesSection());
2721
2722   typedef DenseMap<DwarfCompileUnit *, std::vector<ArangeSpan> > SpansType;
2723
2724   SpansType Spans;
2725
2726   // Build a list of sections used.
2727   std::vector<const MCSection *> Sections;
2728   for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
2729        it++) {
2730     const MCSection *Section = it->first;
2731     Sections.push_back(Section);
2732   }
2733
2734   // Sort the sections into order.
2735   // This is only done to ensure consistent output order across different runs.
2736   std::sort(Sections.begin(), Sections.end(), SectionSort);
2737
2738   // Build a set of address spans, sorted by CU.
2739   for (size_t SecIdx = 0; SecIdx < Sections.size(); SecIdx++) {
2740     const MCSection *Section = Sections[SecIdx];
2741     SmallVector<SymbolCU, 8> &List = SectionMap[Section];
2742     if (List.size() < 2)
2743       continue;
2744
2745     // Sort the symbols by offset within the section.
2746     SymbolCUSorter sorter(Asm->OutStreamer);
2747     std::sort(List.begin(), List.end(), sorter);
2748
2749     // If we have no section (e.g. common), just write out
2750     // individual spans for each symbol.
2751     if (Section == NULL) {
2752       for (size_t n = 0; n < List.size(); n++) {
2753         const SymbolCU &Cur = List[n];
2754
2755         ArangeSpan Span;
2756         Span.Start = Cur.Sym;
2757         Span.End = NULL;
2758         if (Cur.CU)
2759           Spans[Cur.CU].push_back(Span);
2760       }
2761     } else {
2762       // Build spans between each label.
2763       const MCSymbol *StartSym = List[0].Sym;
2764       for (size_t n = 1; n < List.size(); n++) {
2765         const SymbolCU &Prev = List[n - 1];
2766         const SymbolCU &Cur = List[n];
2767
2768         // Try and build the longest span we can within the same CU.
2769         if (Cur.CU != Prev.CU) {
2770           ArangeSpan Span;
2771           Span.Start = StartSym;
2772           Span.End = Cur.Sym;
2773           Spans[Prev.CU].push_back(Span);
2774           StartSym = Cur.Sym;
2775         }
2776       }
2777     }
2778   }
2779
2780   unsigned PtrSize = Asm->getDataLayout().getPointerSize();
2781
2782   // Build a list of CUs used.
2783   std::vector<DwarfCompileUnit *> CUs;
2784   for (SpansType::iterator it = Spans.begin(); it != Spans.end(); it++) {
2785     DwarfCompileUnit *CU = it->first;
2786     CUs.push_back(CU);
2787   }
2788
2789   // Sort the CU list (again, to ensure consistent output order).
2790   std::sort(CUs.begin(), CUs.end(), CUSort);
2791
2792   // Emit an arange table for each CU we used.
2793   for (size_t CUIdx = 0; CUIdx < CUs.size(); CUIdx++) {
2794     DwarfCompileUnit *CU = CUs[CUIdx];
2795     std::vector<ArangeSpan> &List = Spans[CU];
2796
2797     // Emit size of content not including length itself.
2798     unsigned ContentSize =
2799         sizeof(int16_t) + // DWARF ARange version number
2800         sizeof(int32_t) + // Offset of CU in the .debug_info section
2801         sizeof(int8_t) +  // Pointer Size (in bytes)
2802         sizeof(int8_t);   // Segment Size (in bytes)
2803
2804     unsigned TupleSize = PtrSize * 2;
2805
2806     // 7.20 in the Dwarf specs requires the table to be aligned to a tuple.
2807     unsigned Padding =
2808         OffsetToAlignment(sizeof(int32_t) + ContentSize, TupleSize);
2809
2810     ContentSize += Padding;
2811     ContentSize += (List.size() + 1) * TupleSize;
2812
2813     // For each compile unit, write the list of spans it covers.
2814     Asm->OutStreamer.AddComment("Length of ARange Set");
2815     Asm->EmitInt32(ContentSize);
2816     Asm->OutStreamer.AddComment("DWARF Arange version number");
2817     Asm->EmitInt16(dwarf::DW_ARANGES_VERSION);
2818     Asm->OutStreamer.AddComment("Offset Into Debug Info Section");
2819     Asm->EmitSectionOffset(CU->getLocalLabelBegin(), CU->getLocalSectionSym());
2820     Asm->OutStreamer.AddComment("Address Size (in bytes)");
2821     Asm->EmitInt8(PtrSize);
2822     Asm->OutStreamer.AddComment("Segment Size (in bytes)");
2823     Asm->EmitInt8(0);
2824
2825     Asm->OutStreamer.EmitFill(Padding, 0xff);
2826
2827     for (unsigned n = 0; n < List.size(); n++) {
2828       const ArangeSpan &Span = List[n];
2829       Asm->EmitLabelReference(Span.Start, PtrSize);
2830
2831       // Calculate the size as being from the span start to it's end.
2832       if (Span.End) {
2833         Asm->EmitLabelDifference(Span.End, Span.Start, PtrSize);
2834       } else {
2835         // For symbols without an end marker (e.g. common), we
2836         // write a single arange entry containing just that one symbol.
2837         uint64_t Size = SymSize[Span.Start];
2838         if (Size == 0)
2839           Size = 1;
2840
2841         Asm->OutStreamer.EmitIntValue(Size, PtrSize);
2842       }
2843     }
2844
2845     Asm->OutStreamer.AddComment("ARange terminator");
2846     Asm->OutStreamer.EmitIntValue(0, PtrSize);
2847     Asm->OutStreamer.EmitIntValue(0, PtrSize);
2848   }
2849 }
2850
2851 // Emit visible names into a debug ranges section.
2852 void DwarfDebug::emitDebugRanges() {
2853   // Start the dwarf ranges section.
2854   Asm->OutStreamer.SwitchSection(
2855       Asm->getObjFileLowering().getDwarfRangesSection());
2856
2857   // Size for our labels.
2858   unsigned char Size = Asm->getDataLayout().getPointerSize();
2859
2860   // Grab the specific ranges for the compile units in the module.
2861   for (DenseMap<const MDNode *, DwarfCompileUnit *>::iterator I = CUMap.begin(),
2862                                                               E = CUMap.end();
2863        I != E; ++I) {
2864     DwarfCompileUnit *TheCU = I->second;
2865
2866     // Emit a symbol so we can find the beginning of our ranges.
2867     Asm->OutStreamer.EmitLabel(TheCU->getLabelRange());
2868
2869     // Iterate over the misc ranges for the compile units in the module.
2870     const SmallVectorImpl<RangeSpanList> &RangeLists = TheCU->getRangeLists();
2871     for (SmallVectorImpl<RangeSpanList>::const_iterator I = RangeLists.begin(),
2872                                                         E = RangeLists.end();
2873          I != E; ++I) {
2874       const RangeSpanList &List = *I;
2875
2876       // Emit our symbol so we can find the beginning of the range.
2877       Asm->OutStreamer.EmitLabel(List.getSym());
2878
2879       for (SmallVectorImpl<RangeSpan>::const_iterator
2880                RI = List.getRanges().begin(),
2881                RE = List.getRanges().end();
2882            RI != RE; ++RI) {
2883         const RangeSpan &Range = *RI;
2884         const MCSymbol *Begin = Range.getStart();
2885         const MCSymbol *End = Range.getEnd();
2886         assert(Begin && "Range without a begin symbol?");
2887         assert(End && "Range without an end symbol?");
2888         Asm->OutStreamer.EmitSymbolValue(Begin, Size);
2889         Asm->OutStreamer.EmitSymbolValue(End, Size);
2890       }
2891
2892       // And terminate the list with two 0 values.
2893       Asm->OutStreamer.EmitIntValue(0, Size);
2894       Asm->OutStreamer.EmitIntValue(0, Size);
2895     }
2896
2897     // Now emit a range for the CU itself.
2898     if (useCURanges()) {
2899       Asm->OutStreamer.EmitLabel(
2900           Asm->GetTempSymbol("cu_ranges", TheCU->getUniqueID()));
2901       const SmallVectorImpl<RangeSpan> &Ranges = TheCU->getRanges();
2902       for (uint32_t i = 0, e = Ranges.size(); i != e; ++i) {
2903         RangeSpan Range = Ranges[i];
2904         const MCSymbol *Begin = Range.getStart();
2905         const MCSymbol *End = Range.getEnd();
2906         assert(Begin && "Range without a begin symbol?");
2907         assert(End && "Range without an end symbol?");
2908         Asm->OutStreamer.EmitSymbolValue(Begin, Size);
2909         Asm->OutStreamer.EmitSymbolValue(End, Size);
2910       }
2911       // And terminate the list with two 0 values.
2912       Asm->OutStreamer.EmitIntValue(0, Size);
2913       Asm->OutStreamer.EmitIntValue(0, Size);
2914     }
2915   }
2916 }
2917
2918 // DWARF5 Experimental Separate Dwarf emitters.
2919
2920 void DwarfDebug::initSkeletonUnit(const DwarfUnit *U, DIE *Die,
2921                                   DwarfUnit *NewU) {
2922   NewU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
2923                        U->getCUNode().getSplitDebugFilename());
2924
2925   // Relocate to the beginning of the addr_base section, else 0 for the
2926   // beginning of the one for this compile unit.
2927   if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2928     NewU->addSectionLabel(Die, dwarf::DW_AT_GNU_addr_base, DwarfAddrSectionSym);
2929   else
2930     NewU->addSectionOffset(Die, dwarf::DW_AT_GNU_addr_base, 0);
2931
2932   if (!CompilationDir.empty())
2933     NewU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
2934
2935   addGnuPubAttributes(NewU, Die);
2936
2937   SkeletonHolder.addUnit(NewU);
2938 }
2939
2940 // This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2941 // DW_AT_low_pc, DW_AT_high_pc, DW_AT_ranges, DW_AT_dwo_name, DW_AT_dwo_id,
2942 // DW_AT_ranges_base, DW_AT_addr_base.
2943 // TODO: Implement DW_AT_ranges_base.
2944 DwarfCompileUnit *DwarfDebug::constructSkeletonCU(const DwarfCompileUnit *CU) {
2945
2946   DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
2947   DwarfCompileUnit *NewCU = new DwarfCompileUnit(
2948       CU->getUniqueID(), Die, CU->getCUNode(), Asm, this, &SkeletonHolder);
2949   NewCU->initSection(Asm->getObjFileLowering().getDwarfInfoSection(),
2950                      DwarfInfoSectionSym);
2951
2952   // DW_AT_stmt_list is a offset of line number information for this
2953   // compile unit in debug_line section.
2954   // FIXME: Should handle multiple compile units.
2955   if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2956     NewCU->addSectionLabel(Die, dwarf::DW_AT_stmt_list, DwarfLineSectionSym);
2957   else
2958     NewCU->addSectionOffset(Die, dwarf::DW_AT_stmt_list, 0);
2959
2960   initSkeletonUnit(CU, Die, NewCU);
2961
2962   return NewCU;
2963 }
2964
2965 // This DIE has the following attributes: DW_AT_comp_dir, DW_AT_dwo_name,
2966 // DW_AT_addr_base.
2967 DwarfTypeUnit *DwarfDebug::constructSkeletonTU(const DwarfTypeUnit *TU) {
2968
2969   DIE *Die = new DIE(dwarf::DW_TAG_type_unit);
2970   DwarfTypeUnit *NewTU = new DwarfTypeUnit(
2971       TU->getUniqueID(), Die, TU->getCUNode(), Asm, this, &SkeletonHolder);
2972   NewTU->setTypeSignature(TU->getTypeSignature());
2973   NewTU->setType(NULL);
2974   NewTU->initSection(
2975       Asm->getObjFileLowering().getDwarfTypesSection(TU->getTypeSignature()));
2976
2977   initSkeletonUnit(TU, Die, NewTU);
2978   return NewTU;
2979 }
2980
2981 // Emit the .debug_info.dwo section for separated dwarf. This contains the
2982 // compile units that would normally be in debug_info.
2983 void DwarfDebug::emitDebugInfoDWO() {
2984   assert(useSplitDwarf() && "No split dwarf debug info?");
2985   InfoHolder.emitUnits(this,
2986                        Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
2987                        DwarfAbbrevDWOSectionSym);
2988 }
2989
2990 // Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
2991 // abbreviations for the .debug_info.dwo section.
2992 void DwarfDebug::emitDebugAbbrevDWO() {
2993   assert(useSplitDwarf() && "No split dwarf?");
2994   InfoHolder.emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection());
2995 }
2996
2997 // Emit the .debug_str.dwo section for separated dwarf. This contains the
2998 // string section and is identical in format to traditional .debug_str
2999 // sections.
3000 void DwarfDebug::emitDebugStrDWO() {
3001   assert(useSplitDwarf() && "No split dwarf?");
3002   const MCSection *OffSec =
3003       Asm->getObjFileLowering().getDwarfStrOffDWOSection();
3004   const MCSymbol *StrSym = DwarfStrSectionSym;
3005   InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
3006                          OffSec, StrSym);
3007 }
3008
3009 void DwarfDebug::addDwarfTypeUnitType(DICompileUnit CUNode,
3010                                       StringRef Identifier, DIE *RefDie,
3011                                       DICompositeType CTy) {
3012
3013   const DwarfTypeUnit *&TU = DwarfTypeUnits[CTy];
3014   if (TU) {
3015     CUMap.begin()->second->addDIETypeSignature(RefDie, *TU);
3016     return;
3017   }
3018
3019   DIE *UnitDie = new DIE(dwarf::DW_TAG_type_unit);
3020   DwarfTypeUnit *NewTU = new DwarfTypeUnit(
3021       InfoHolder.getUnits().size(), UnitDie, CUNode, Asm, this, &InfoHolder);
3022   TU = NewTU;
3023   InfoHolder.addUnit(NewTU);
3024
3025   NewTU->addUInt(UnitDie, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
3026                  CUNode.getLanguage());
3027
3028   MD5 Hash;
3029   Hash.update(Identifier);
3030   // ... take the least significant 8 bytes and return those. Our MD5
3031   // implementation always returns its results in little endian, swap bytes
3032   // appropriately.
3033   MD5::MD5Result Result;
3034   Hash.final(Result);
3035   uint64_t Signature = *reinterpret_cast<support::ulittle64_t *>(Result + 8);
3036   NewTU->setTypeSignature(Signature);
3037   if (useSplitDwarf())
3038     NewTU->setSkeleton(constructSkeletonTU(NewTU));
3039
3040   NewTU->setType(NewTU->createTypeDIE(CTy));
3041
3042   NewTU->initSection(
3043       useSplitDwarf()
3044           ? Asm->getObjFileLowering().getDwarfTypesDWOSection(Signature)
3045           : Asm->getObjFileLowering().getDwarfTypesSection(Signature));
3046
3047   CUMap.begin()->second->addDIETypeSignature(RefDie, *NewTU);
3048 }