Sink DwarfUnit::addVariableAddress into DwarfCompileUnit since type units don't have...
[oota-llvm.git] / lib / CodeGen / AsmPrinter / DwarfCompileUnit.cpp
1 #include "DwarfCompileUnit.h"
2
3 #include "llvm/CodeGen/MachineFunction.h"
4 #include "llvm/IR/DataLayout.h"
5 #include "llvm/IR/GlobalValue.h"
6 #include "llvm/IR/GlobalVariable.h"
7 #include "llvm/IR/Instruction.h"
8 #include "llvm/MC/MCAsmInfo.h"
9 #include "llvm/MC/MCStreamer.h"
10 #include "llvm/Target/TargetFrameLowering.h"
11 #include "llvm/Target/TargetLoweringObjectFile.h"
12 #include "llvm/Target/TargetMachine.h"
13 #include "llvm/Target/TargetSubtargetInfo.h"
14 #include "llvm/Target/TargetRegisterInfo.h"
15
16 namespace llvm {
17
18 DwarfCompileUnit::DwarfCompileUnit(unsigned UID, DICompileUnit Node,
19                                    AsmPrinter *A, DwarfDebug *DW,
20                                    DwarfFile *DWU)
21     : DwarfUnit(UID, dwarf::DW_TAG_compile_unit, Node, A, DW, DWU),
22       Skeleton(nullptr), LabelBegin(nullptr) {
23   insertDIE(Node, &getUnitDie());
24 }
25
26 /// addLabelAddress - Add a dwarf label attribute data and value using
27 /// DW_FORM_addr or DW_FORM_GNU_addr_index.
28 ///
29 void DwarfCompileUnit::addLabelAddress(DIE &Die, dwarf::Attribute Attribute,
30                                        const MCSymbol *Label) {
31
32   // Don't use the address pool in non-fission or in the skeleton unit itself.
33   // FIXME: Once GDB supports this, it's probably worthwhile using the address
34   // pool from the skeleton - maybe even in non-fission (possibly fewer
35   // relocations by sharing them in the pool, but we have other ideas about how
36   // to reduce the number of relocations as well/instead).
37   if (!DD->useSplitDwarf() || !Skeleton)
38     return addLocalLabelAddress(Die, Attribute, Label);
39
40   if (Label)
41     DD->addArangeLabel(SymbolCU(this, Label));
42
43   unsigned idx = DD->getAddressPool().getIndex(Label);
44   DIEValue *Value = new (DIEValueAllocator) DIEInteger(idx);
45   Die.addValue(Attribute, dwarf::DW_FORM_GNU_addr_index, Value);
46 }
47
48 void DwarfCompileUnit::addLocalLabelAddress(DIE &Die,
49                                             dwarf::Attribute Attribute,
50                                             const MCSymbol *Label) {
51   if (Label)
52     DD->addArangeLabel(SymbolCU(this, Label));
53
54   Die.addValue(Attribute, dwarf::DW_FORM_addr,
55                Label ? (DIEValue *)new (DIEValueAllocator) DIELabel(Label)
56                      : new (DIEValueAllocator) DIEInteger(0));
57 }
58
59 unsigned DwarfCompileUnit::getOrCreateSourceID(StringRef FileName,
60                                                StringRef DirName) {
61   // If we print assembly, we can't separate .file entries according to
62   // compile units. Thus all files will belong to the default compile unit.
63
64   // FIXME: add a better feature test than hasRawTextSupport. Even better,
65   // extend .file to support this.
66   return Asm->OutStreamer.EmitDwarfFileDirective(
67       0, DirName, FileName,
68       Asm->OutStreamer.hasRawTextSupport() ? 0 : getUniqueID());
69 }
70
71 // Return const expression if value is a GEP to access merged global
72 // constant. e.g.
73 // i8* getelementptr ({ i8, i8, i8, i8 }* @_MergedGlobals, i32 0, i32 0)
74 static const ConstantExpr *getMergedGlobalExpr(const Value *V) {
75   const ConstantExpr *CE = dyn_cast_or_null<ConstantExpr>(V);
76   if (!CE || CE->getNumOperands() != 3 ||
77       CE->getOpcode() != Instruction::GetElementPtr)
78     return nullptr;
79
80   // First operand points to a global struct.
81   Value *Ptr = CE->getOperand(0);
82   if (!isa<GlobalValue>(Ptr) ||
83       !isa<StructType>(cast<PointerType>(Ptr->getType())->getElementType()))
84     return nullptr;
85
86   // Second operand is zero.
87   const ConstantInt *CI = dyn_cast_or_null<ConstantInt>(CE->getOperand(1));
88   if (!CI || !CI->isZero())
89     return nullptr;
90
91   // Third operand is offset.
92   if (!isa<ConstantInt>(CE->getOperand(2)))
93     return nullptr;
94
95   return CE;
96 }
97
98 /// getOrCreateGlobalVariableDIE - get or create global variable DIE.
99 DIE *DwarfCompileUnit::getOrCreateGlobalVariableDIE(DIGlobalVariable GV) {
100   // Check for pre-existence.
101   if (DIE *Die = getDIE(GV))
102     return Die;
103
104   assert(GV.isGlobalVariable());
105
106   DIScope GVContext = GV.getContext();
107   DIType GTy = DD->resolve(GV.getType());
108
109   // Construct the context before querying for the existence of the DIE in
110   // case such construction creates the DIE.
111   DIE *ContextDIE = getOrCreateContextDIE(GVContext);
112
113   // Add to map.
114   DIE *VariableDIE = &createAndAddDIE(GV.getTag(), *ContextDIE, GV);
115   DIScope DeclContext;
116
117   if (DIDerivedType SDMDecl = GV.getStaticDataMemberDeclaration()) {
118     DeclContext = resolve(SDMDecl.getContext());
119     assert(SDMDecl.isStaticMember() && "Expected static member decl");
120     assert(GV.isDefinition());
121     // We need the declaration DIE that is in the static member's class.
122     DIE *VariableSpecDIE = getOrCreateStaticMemberDIE(SDMDecl);
123     addDIEEntry(*VariableDIE, dwarf::DW_AT_specification, *VariableSpecDIE);
124   } else {
125     DeclContext = GV.getContext();
126     // Add name and type.
127     addString(*VariableDIE, dwarf::DW_AT_name, GV.getDisplayName());
128     addType(*VariableDIE, GTy);
129
130     // Add scoping info.
131     if (!GV.isLocalToUnit())
132       addFlag(*VariableDIE, dwarf::DW_AT_external);
133
134     // Add line number info.
135     addSourceLine(*VariableDIE, GV);
136   }
137
138   if (!GV.isDefinition())
139     addFlag(*VariableDIE, dwarf::DW_AT_declaration);
140
141   // Add location.
142   bool addToAccelTable = false;
143   bool isGlobalVariable = GV.getGlobal() != nullptr;
144   if (isGlobalVariable) {
145     addToAccelTable = true;
146     DIELoc *Loc = new (DIEValueAllocator) DIELoc();
147     const MCSymbol *Sym = Asm->getSymbol(GV.getGlobal());
148     if (GV.getGlobal()->isThreadLocal()) {
149       // FIXME: Make this work with -gsplit-dwarf.
150       unsigned PointerSize = Asm->getDataLayout().getPointerSize();
151       assert((PointerSize == 4 || PointerSize == 8) &&
152              "Add support for other sizes if necessary");
153       // Based on GCC's support for TLS:
154       if (!DD->useSplitDwarf()) {
155         // 1) Start with a constNu of the appropriate pointer size
156         addUInt(*Loc, dwarf::DW_FORM_data1,
157                 PointerSize == 4 ? dwarf::DW_OP_const4u : dwarf::DW_OP_const8u);
158         // 2) containing the (relocated) offset of the TLS variable
159         //    within the module's TLS block.
160         addExpr(*Loc, dwarf::DW_FORM_udata,
161                 Asm->getObjFileLowering().getDebugThreadLocalSymbol(Sym));
162       } else {
163         addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_const_index);
164         addUInt(*Loc, dwarf::DW_FORM_udata,
165                 DD->getAddressPool().getIndex(Sym, /* TLS */ true));
166       }
167       // 3) followed by a custom OP to make the debugger do a TLS lookup.
168       addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_push_tls_address);
169     } else {
170       DD->addArangeLabel(SymbolCU(this, Sym));
171       addOpAddress(*Loc, Sym);
172     }
173
174     addBlock(*VariableDIE, dwarf::DW_AT_location, Loc);
175     // Add the linkage name.
176     StringRef LinkageName = GV.getLinkageName();
177     if (!LinkageName.empty())
178       // From DWARF4: DIEs to which DW_AT_linkage_name may apply include:
179       // TAG_common_block, TAG_constant, TAG_entry_point, TAG_subprogram and
180       // TAG_variable.
181       addString(*VariableDIE,
182                 DD->getDwarfVersion() >= 4 ? dwarf::DW_AT_linkage_name
183                                            : dwarf::DW_AT_MIPS_linkage_name,
184                 GlobalValue::getRealLinkageName(LinkageName));
185   } else if (const ConstantInt *CI =
186                  dyn_cast_or_null<ConstantInt>(GV.getConstant())) {
187     addConstantValue(*VariableDIE, CI, GTy);
188   } else if (const ConstantExpr *CE = getMergedGlobalExpr(GV.getConstant())) {
189     addToAccelTable = true;
190     // GV is a merged global.
191     DIELoc *Loc = new (DIEValueAllocator) DIELoc();
192     Value *Ptr = CE->getOperand(0);
193     MCSymbol *Sym = Asm->getSymbol(cast<GlobalValue>(Ptr));
194     DD->addArangeLabel(SymbolCU(this, Sym));
195     addOpAddress(*Loc, Sym);
196     addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
197     SmallVector<Value *, 3> Idx(CE->op_begin() + 1, CE->op_end());
198     addUInt(*Loc, dwarf::DW_FORM_udata,
199             Asm->getDataLayout().getIndexedOffset(Ptr->getType(), Idx));
200     addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
201     addBlock(*VariableDIE, dwarf::DW_AT_location, Loc);
202   }
203
204   if (addToAccelTable) {
205     DD->addAccelName(GV.getName(), *VariableDIE);
206
207     // If the linkage name is different than the name, go ahead and output
208     // that as well into the name table.
209     if (GV.getLinkageName() != "" && GV.getName() != GV.getLinkageName())
210       DD->addAccelName(GV.getLinkageName(), *VariableDIE);
211   }
212
213   addGlobalName(GV.getName(), *VariableDIE, DeclContext);
214   return VariableDIE;
215 }
216
217 void DwarfCompileUnit::addRange(RangeSpan Range) {
218   bool SameAsPrevCU = this == DD->getPrevCU();
219   DD->setPrevCU(this);
220   // If we have no current ranges just add the range and return, otherwise,
221   // check the current section and CU against the previous section and CU we
222   // emitted into and the subprogram was contained within. If these are the
223   // same then extend our current range, otherwise add this as a new range.
224   if (CURanges.empty() || !SameAsPrevCU ||
225       (&CURanges.back().getEnd()->getSection() !=
226        &Range.getEnd()->getSection())) {
227     CURanges.push_back(Range);
228     return;
229   }
230
231   CURanges.back().setEnd(Range.getEnd());
232 }
233
234 void DwarfCompileUnit::addSectionLabel(DIE &Die, dwarf::Attribute Attribute,
235                                        const MCSymbol *Label,
236                                        const MCSymbol *Sec) {
237   if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
238     addLabel(Die, Attribute,
239              DD->getDwarfVersion() >= 4 ? dwarf::DW_FORM_sec_offset
240                                         : dwarf::DW_FORM_data4,
241              Label);
242   else
243     addSectionDelta(Die, Attribute, Label, Sec);
244 }
245
246 void DwarfCompileUnit::initStmtList(MCSymbol *DwarfLineSectionSym) {
247   // Define start line table label for each Compile Unit.
248   MCSymbol *LineTableStartSym =
249       Asm->OutStreamer.getDwarfLineTableSymbol(getUniqueID());
250
251   stmtListIndex = UnitDie.getValues().size();
252
253   // DW_AT_stmt_list is a offset of line number information for this
254   // compile unit in debug_line section. For split dwarf this is
255   // left in the skeleton CU and so not included.
256   // The line table entries are not always emitted in assembly, so it
257   // is not okay to use line_table_start here.
258   addSectionLabel(UnitDie, dwarf::DW_AT_stmt_list, LineTableStartSym,
259                   DwarfLineSectionSym);
260 }
261
262 void DwarfCompileUnit::applyStmtList(DIE &D) {
263   D.addValue(dwarf::DW_AT_stmt_list,
264              UnitDie.getAbbrev().getData()[stmtListIndex].getForm(),
265              UnitDie.getValues()[stmtListIndex]);
266 }
267
268 void DwarfCompileUnit::attachLowHighPC(DIE &D, const MCSymbol *Begin,
269                                        const MCSymbol *End) {
270   assert(Begin && "Begin label should not be null!");
271   assert(End && "End label should not be null!");
272   assert(Begin->isDefined() && "Invalid starting label");
273   assert(End->isDefined() && "Invalid end label");
274
275   addLabelAddress(D, dwarf::DW_AT_low_pc, Begin);
276   if (DD->getDwarfVersion() < 4)
277     addLabelAddress(D, dwarf::DW_AT_high_pc, End);
278   else
279     addLabelDelta(D, dwarf::DW_AT_high_pc, End, Begin);
280 }
281
282 // Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
283 // and DW_AT_high_pc attributes. If there are global variables in this
284 // scope then create and insert DIEs for these variables.
285 DIE &DwarfCompileUnit::updateSubprogramScopeDIE(DISubprogram SP) {
286   DIE *SPDie = getOrCreateSubprogramDIE(SP);
287
288   attachLowHighPC(*SPDie, DD->getFunctionBeginSym(), DD->getFunctionEndSym());
289   if (!DD->getCurrentFunction()->getTarget().Options.DisableFramePointerElim(
290           *DD->getCurrentFunction()))
291     addFlag(*SPDie, dwarf::DW_AT_APPLE_omit_frame_ptr);
292
293   // Only include DW_AT_frame_base in full debug info
294   if (getCUNode().getEmissionKind() != DIBuilder::LineTablesOnly) {
295     const TargetRegisterInfo *RI =
296         Asm->TM.getSubtargetImpl()->getRegisterInfo();
297     MachineLocation Location(RI->getFrameRegister(*Asm->MF));
298     addAddress(*SPDie, dwarf::DW_AT_frame_base, Location);
299   }
300
301   // Add name to the name table, we do this here because we're guaranteed
302   // to have concrete versions of our DW_TAG_subprogram nodes.
303   DD->addSubprogramNames(SP, *SPDie);
304
305   return *SPDie;
306 }
307
308 // Construct a DIE for this scope.
309 void DwarfCompileUnit::constructScopeDIE(
310     LexicalScope *Scope, SmallVectorImpl<std::unique_ptr<DIE>> &FinalChildren) {
311   if (!Scope || !Scope->getScopeNode())
312     return;
313
314   DIScope DS(Scope->getScopeNode());
315
316   assert((Scope->getInlinedAt() || !DS.isSubprogram()) &&
317          "Only handle inlined subprograms here, use "
318          "constructSubprogramScopeDIE for non-inlined "
319          "subprograms");
320
321   SmallVector<std::unique_ptr<DIE>, 8> Children;
322
323   // We try to create the scope DIE first, then the children DIEs. This will
324   // avoid creating un-used children then removing them later when we find out
325   // the scope DIE is null.
326   std::unique_ptr<DIE> ScopeDIE;
327   if (Scope->getParent() && DS.isSubprogram()) {
328     ScopeDIE = constructInlinedScopeDIE(Scope);
329     if (!ScopeDIE)
330       return;
331     // We create children when the scope DIE is not null.
332     createScopeChildrenDIE(Scope, Children);
333   } else {
334     // Early exit when we know the scope DIE is going to be null.
335     if (DD->isLexicalScopeDIENull(Scope))
336       return;
337
338     unsigned ChildScopeCount;
339
340     // We create children here when we know the scope DIE is not going to be
341     // null and the children will be added to the scope DIE.
342     createScopeChildrenDIE(Scope, Children, &ChildScopeCount);
343
344     // There is no need to emit empty lexical block DIE.
345     for (const auto &E : DD->findImportedEntitiesForScope(DS))
346       Children.push_back(
347           constructImportedEntityDIE(DIImportedEntity(E.second)));
348     // If there are only other scopes as children, put them directly in the
349     // parent instead, as this scope would serve no purpose.
350     if (Children.size() == ChildScopeCount) {
351       FinalChildren.insert(FinalChildren.end(),
352                            std::make_move_iterator(Children.begin()),
353                            std::make_move_iterator(Children.end()));
354       return;
355     }
356     ScopeDIE = constructLexicalScopeDIE(Scope);
357     assert(ScopeDIE && "Scope DIE should not be null.");
358   }
359
360   // Add children
361   for (auto &I : Children)
362     ScopeDIE->addChild(std::move(I));
363
364   FinalChildren.push_back(std::move(ScopeDIE));
365 }
366
367 void DwarfCompileUnit::addSectionDelta(DIE &Die, dwarf::Attribute Attribute,
368                                        const MCSymbol *Hi, const MCSymbol *Lo) {
369   DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
370   Die.addValue(Attribute, DD->getDwarfVersion() >= 4 ? dwarf::DW_FORM_sec_offset
371                                                      : dwarf::DW_FORM_data4,
372                Value);
373 }
374
375 void
376 DwarfCompileUnit::addScopeRangeList(DIE &ScopeDIE,
377                                     const SmallVectorImpl<InsnRange> &Range) {
378   // Emit offset in .debug_range as a relocatable label. emitDIE will handle
379   // emitting it appropriately.
380   MCSymbol *RangeSym =
381       Asm->GetTempSymbol("debug_ranges", DD->getNextRangeNumber());
382
383   auto *RangeSectionSym = DD->getRangeSectionSym();
384
385   // Under fission, ranges are specified by constant offsets relative to the
386   // CU's DW_AT_GNU_ranges_base.
387   if (DD->useSplitDwarf())
388     addSectionDelta(ScopeDIE, dwarf::DW_AT_ranges, RangeSym, RangeSectionSym);
389   else
390     addSectionLabel(ScopeDIE, dwarf::DW_AT_ranges, RangeSym, RangeSectionSym);
391
392   RangeSpanList List(RangeSym);
393   for (const InsnRange &R : Range)
394     List.addRange(RangeSpan(DD->getLabelBeforeInsn(R.first),
395                             DD->getLabelAfterInsn(R.second)));
396
397   // Add the range list to the set of ranges to be emitted.
398   addRangeList(std::move(List));
399 }
400
401 void DwarfCompileUnit::attachRangesOrLowHighPC(
402     DIE &Die, const SmallVectorImpl<InsnRange> &Ranges) {
403   assert(!Ranges.empty());
404   if (Ranges.size() == 1)
405     attachLowHighPC(Die, DD->getLabelBeforeInsn(Ranges.front().first),
406                     DD->getLabelAfterInsn(Ranges.front().second));
407   else
408     addScopeRangeList(Die, Ranges);
409 }
410
411 // This scope represents inlined body of a function. Construct DIE to
412 // represent this concrete inlined copy of the function.
413 std::unique_ptr<DIE>
414 DwarfCompileUnit::constructInlinedScopeDIE(LexicalScope *Scope) {
415   assert(Scope->getScopeNode());
416   DIScope DS(Scope->getScopeNode());
417   DISubprogram InlinedSP = getDISubprogram(DS);
418   // Find the subprogram's DwarfCompileUnit in the SPMap in case the subprogram
419   // was inlined from another compile unit.
420   DIE *OriginDIE = DU->getAbstractSPDies()[InlinedSP];
421   assert(OriginDIE && "Unable to find original DIE for an inlined subprogram.");
422
423   auto ScopeDIE = make_unique<DIE>(dwarf::DW_TAG_inlined_subroutine);
424   addDIEEntry(*ScopeDIE, dwarf::DW_AT_abstract_origin, *OriginDIE);
425
426   attachRangesOrLowHighPC(*ScopeDIE, Scope->getRanges());
427
428   // Add the call site information to the DIE.
429   DILocation DL(Scope->getInlinedAt());
430   addUInt(*ScopeDIE, dwarf::DW_AT_call_file, None,
431           getOrCreateSourceID(DL.getFilename(), DL.getDirectory()));
432   addUInt(*ScopeDIE, dwarf::DW_AT_call_line, None, DL.getLineNumber());
433
434   // Add name to the name table, we do this here because we're guaranteed
435   // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
436   DD->addSubprogramNames(InlinedSP, *ScopeDIE);
437
438   return ScopeDIE;
439 }
440
441 // Construct new DW_TAG_lexical_block for this scope and attach
442 // DW_AT_low_pc/DW_AT_high_pc labels.
443 std::unique_ptr<DIE>
444 DwarfCompileUnit::constructLexicalScopeDIE(LexicalScope *Scope) {
445   if (DD->isLexicalScopeDIENull(Scope))
446     return nullptr;
447
448   auto ScopeDIE = make_unique<DIE>(dwarf::DW_TAG_lexical_block);
449   if (Scope->isAbstractScope())
450     return ScopeDIE;
451
452   attachRangesOrLowHighPC(*ScopeDIE, Scope->getRanges());
453
454   return ScopeDIE;
455 }
456
457 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
458 std::unique_ptr<DIE> DwarfCompileUnit::constructVariableDIE(DbgVariable &DV,
459                                                             bool Abstract) {
460   auto D = constructVariableDIEImpl(DV, Abstract);
461   DV.setDIE(*D);
462   return D;
463 }
464
465 std::unique_ptr<DIE>
466 DwarfCompileUnit::constructVariableDIEImpl(const DbgVariable &DV,
467                                            bool Abstract) {
468   // Define variable debug information entry.
469   auto VariableDie = make_unique<DIE>(DV.getTag());
470
471   if (Abstract) {
472     applyVariableAttributes(DV, *VariableDie);
473     return VariableDie;
474   }
475
476   // Add variable address.
477
478   unsigned Offset = DV.getDotDebugLocOffset();
479   if (Offset != ~0U) {
480     addLocationList(*VariableDie, dwarf::DW_AT_location, Offset);
481     return VariableDie;
482   }
483
484   // Check if variable is described by a DBG_VALUE instruction.
485   if (const MachineInstr *DVInsn = DV.getMInsn()) {
486     assert(DVInsn->getNumOperands() == 4);
487     if (DVInsn->getOperand(0).isReg()) {
488       const MachineOperand RegOp = DVInsn->getOperand(0);
489       // If the second operand is an immediate, this is an indirect value.
490       if (DVInsn->getOperand(1).isImm()) {
491         MachineLocation Location(RegOp.getReg(),
492                                  DVInsn->getOperand(1).getImm());
493         addVariableAddress(DV, *VariableDie, Location);
494       } else if (RegOp.getReg())
495         addVariableAddress(DV, *VariableDie, MachineLocation(RegOp.getReg()));
496     } else if (DVInsn->getOperand(0).isImm())
497       addConstantValue(*VariableDie, DVInsn->getOperand(0), DV.getType());
498     else if (DVInsn->getOperand(0).isFPImm())
499       addConstantFPValue(*VariableDie, DVInsn->getOperand(0));
500     else if (DVInsn->getOperand(0).isCImm())
501       addConstantValue(*VariableDie, DVInsn->getOperand(0).getCImm(),
502                        DV.getType());
503
504     return VariableDie;
505   }
506
507   // .. else use frame index.
508   int FI = DV.getFrameIndex();
509   if (FI != ~0) {
510     unsigned FrameReg = 0;
511     const TargetFrameLowering *TFI =
512         Asm->TM.getSubtargetImpl()->getFrameLowering();
513     int Offset = TFI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
514     MachineLocation Location(FrameReg, Offset);
515     addVariableAddress(DV, *VariableDie, Location);
516   }
517
518   return VariableDie;
519 }
520
521 std::unique_ptr<DIE> DwarfCompileUnit::constructVariableDIE(
522     DbgVariable &DV, const LexicalScope &Scope, DIE *&ObjectPointer) {
523   auto Var = constructVariableDIE(DV, Scope.isAbstractScope());
524   if (DV.isObjectPointer())
525     ObjectPointer = Var.get();
526   return Var;
527 }
528
529 DIE *DwarfCompileUnit::createScopeChildrenDIE(
530     LexicalScope *Scope, SmallVectorImpl<std::unique_ptr<DIE>> &Children,
531     unsigned *ChildScopeCount) {
532   DIE *ObjectPointer = nullptr;
533
534   for (DbgVariable *DV : DU->getScopeVariables().lookup(Scope))
535     Children.push_back(constructVariableDIE(*DV, *Scope, ObjectPointer));
536
537   unsigned ChildCountWithoutScopes = Children.size();
538
539   for (LexicalScope *LS : Scope->getChildren())
540     constructScopeDIE(LS, Children);
541
542   if (ChildScopeCount)
543     *ChildScopeCount = Children.size() - ChildCountWithoutScopes;
544
545   return ObjectPointer;
546 }
547
548 void DwarfCompileUnit::constructSubprogramScopeDIE(LexicalScope *Scope) {
549   assert(Scope && Scope->getScopeNode());
550   assert(!Scope->getInlinedAt());
551   assert(!Scope->isAbstractScope());
552   DISubprogram Sub(Scope->getScopeNode());
553
554   assert(Sub.isSubprogram());
555
556   DD->getProcessedSPNodes().insert(Sub);
557
558   DIE &ScopeDIE = updateSubprogramScopeDIE(Sub);
559
560   // If this is a variadic function, add an unspecified parameter.
561   DITypeArray FnArgs = Sub.getType().getTypeArray();
562
563   // Collect lexical scope children first.
564   // ObjectPointer might be a local (non-argument) local variable if it's a
565   // block's synthetic this pointer.
566   if (DIE *ObjectPointer = createAndAddScopeChildren(Scope, ScopeDIE))
567     addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer, *ObjectPointer);
568
569   // If we have a single element of null, it is a function that returns void.
570   // If we have more than one elements and the last one is null, it is a
571   // variadic function.
572   if (FnArgs.getNumElements() > 1 &&
573       !FnArgs.getElement(FnArgs.getNumElements() - 1))
574     ScopeDIE.addChild(make_unique<DIE>(dwarf::DW_TAG_unspecified_parameters));
575 }
576
577 DIE *DwarfCompileUnit::createAndAddScopeChildren(LexicalScope *Scope,
578                                                  DIE &ScopeDIE) {
579   // We create children when the scope DIE is not null.
580   SmallVector<std::unique_ptr<DIE>, 8> Children;
581   DIE *ObjectPointer = createScopeChildrenDIE(Scope, Children);
582
583   // Add children
584   for (auto &I : Children)
585     ScopeDIE.addChild(std::move(I));
586
587   return ObjectPointer;
588 }
589
590 void
591 DwarfCompileUnit::constructAbstractSubprogramScopeDIE(LexicalScope *Scope) {
592   DIE *&AbsDef = DU->getAbstractSPDies()[Scope->getScopeNode()];
593   if (AbsDef)
594     return;
595
596   DISubprogram SP(Scope->getScopeNode());
597
598   DIE *ContextDIE;
599
600   // Some of this is duplicated from DwarfUnit::getOrCreateSubprogramDIE, with
601   // the important distinction that the DIDescriptor is not associated with the
602   // DIE (since the DIDescriptor will be associated with the concrete DIE, if
603   // any). It could be refactored to some common utility function.
604   if (DISubprogram SPDecl = SP.getFunctionDeclaration()) {
605     ContextDIE = &getUnitDie();
606     getOrCreateSubprogramDIE(SPDecl);
607   } else
608     ContextDIE = getOrCreateContextDIE(resolve(SP.getContext()));
609
610   // Passing null as the associated DIDescriptor because the abstract definition
611   // shouldn't be found by lookup.
612   AbsDef =
613       &createAndAddDIE(dwarf::DW_TAG_subprogram, *ContextDIE, DIDescriptor());
614   applySubprogramAttributesToDefinition(SP, *AbsDef);
615
616   if (getCUNode().getEmissionKind() != DIBuilder::LineTablesOnly)
617     addUInt(*AbsDef, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
618   if (DIE *ObjectPointer = createAndAddScopeChildren(Scope, *AbsDef))
619     addDIEEntry(*AbsDef, dwarf::DW_AT_object_pointer, *ObjectPointer);
620 }
621
622 std::unique_ptr<DIE>
623 DwarfCompileUnit::constructImportedEntityDIE(const DIImportedEntity &Module) {
624   assert(Module.Verify() &&
625          "Use one of the MDNode * overloads to handle invalid metadata");
626   std::unique_ptr<DIE> IMDie = make_unique<DIE>((dwarf::Tag)Module.getTag());
627   insertDIE(Module, IMDie.get());
628   DIE *EntityDie;
629   DIDescriptor Entity = resolve(Module.getEntity());
630   if (Entity.isNameSpace())
631     EntityDie = getOrCreateNameSpace(DINameSpace(Entity));
632   else if (Entity.isSubprogram())
633     EntityDie = getOrCreateSubprogramDIE(DISubprogram(Entity));
634   else if (Entity.isType())
635     EntityDie = getOrCreateTypeDIE(DIType(Entity));
636   else
637     EntityDie = getDIE(Entity);
638   assert(EntityDie);
639   addSourceLine(*IMDie, Module.getLineNumber(),
640                 Module.getContext().getFilename(),
641                 Module.getContext().getDirectory());
642   addDIEEntry(*IMDie, dwarf::DW_AT_import, *EntityDie);
643   StringRef Name = Module.getName();
644   if (!Name.empty())
645     addString(*IMDie, dwarf::DW_AT_name, Name);
646
647   return IMDie;
648 }
649
650 void DwarfCompileUnit::finishSubprogramDefinition(DISubprogram SP) {
651   DIE *D = getDIE(SP);
652   if (DIE *AbsSPDIE = DU->getAbstractSPDies().lookup(SP)) {
653     if (D)
654       // If this subprogram has an abstract definition, reference that
655       addDIEEntry(*D, dwarf::DW_AT_abstract_origin, *AbsSPDIE);
656   } else {
657     if (!D && getCUNode().getEmissionKind() != DIBuilder::LineTablesOnly)
658       // Lazily construct the subprogram if we didn't see either concrete or
659       // inlined versions during codegen. (except in -gmlt ^ where we want
660       // to omit these entirely)
661       D = getOrCreateSubprogramDIE(SP);
662     if (D)
663       // And attach the attributes
664       applySubprogramAttributesToDefinition(SP, *D);
665   }
666 }
667 void DwarfCompileUnit::collectDeadVariables(DISubprogram SP) {
668   assert(SP.isSubprogram() && "CU's subprogram list contains a non-subprogram");
669   assert(SP.isDefinition() &&
670          "CU's subprogram list contains a subprogram declaration");
671   DIArray Variables = SP.getVariables();
672   if (Variables.getNumElements() == 0)
673     return;
674
675   DIE *SPDIE = DU->getAbstractSPDies().lookup(SP);
676   if (!SPDIE)
677     SPDIE = getDIE(SP);
678   assert(SPDIE);
679   for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
680     DIVariable DV(Variables.getElement(vi));
681     assert(DV.isVariable());
682     DbgVariable NewVar(DV, DIExpression(nullptr), DD);
683     auto VariableDie = constructVariableDIE(NewVar);
684     applyVariableAttributes(NewVar, *VariableDie);
685     SPDIE->addChild(std::move(VariableDie));
686   }
687 }
688
689 void DwarfCompileUnit::emitHeader(const MCSymbol *ASectionSym) const {
690   // Don't bother labeling the .dwo unit, as its offset isn't used.
691   if (!Skeleton)
692     Asm->OutStreamer.EmitLabel(LabelBegin);
693
694   DwarfUnit::emitHeader(ASectionSym);
695 }
696
697 /// addGlobalName - Add a new global name to the compile unit.
698 void DwarfCompileUnit::addGlobalName(StringRef Name, DIE &Die,
699                                      DIScope Context) {
700   if (getCUNode().getEmissionKind() == DIBuilder::LineTablesOnly)
701     return;
702   std::string FullName = getParentContextString(Context) + Name.str();
703   GlobalNames[FullName] = &Die;
704 }
705
706 /// Add a new global type to the unit.
707 void DwarfCompileUnit::addGlobalType(DIType Ty, const DIE &Die,
708                                      DIScope Context) {
709   if (getCUNode().getEmissionKind() == DIBuilder::LineTablesOnly)
710     return;
711   std::string FullName = getParentContextString(Context) + Ty.getName().str();
712   GlobalTypes[FullName] = &Die;
713 }
714
715 /// addVariableAddress - Add DW_AT_location attribute for a
716 /// DbgVariable based on provided MachineLocation.
717 void DwarfCompileUnit::addVariableAddress(const DbgVariable &DV, DIE &Die,
718                                           MachineLocation Location) {
719   if (DV.variableHasComplexAddress())
720     addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
721   else if (DV.isBlockByrefVariable())
722     addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
723   else
724     addAddress(Die, dwarf::DW_AT_location, Location,
725                DV.getVariable().isIndirect());
726 }
727 } // end llvm namespace