lib/CodeGen/AsmPrinter/DwarfCompileUnit.cpp

   1 #include "DwarfCompileUnit.h"
   2 #include "DwarfExpression.h"
   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/TargetRegisterInfo.h"
  14 #include "llvm/Target/TargetSubtargetInfo.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), BaseAddress(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 an OP to make the debugger do a TLS lookup.
 168       addUInt(*Loc, dwarf::DW_FORM_data1,
 169               DD->useGNUTLSOpcode() ? dwarf::DW_OP_GNU_push_tls_address
 170                                     : dwarf::DW_OP_form_tls_address);
 171     } else {
 172       DD->addArangeLabel(SymbolCU(this, Sym));
 173       addOpAddress(*Loc, Sym);
 174     }
 175
 176     addBlock(*VariableDIE, dwarf::DW_AT_location, Loc);
 177     addLinkageName(*VariableDIE, GV.getLinkageName());
 178   } else if (const ConstantInt *CI =
 179                  dyn_cast_or_null<ConstantInt>(GV.getConstant())) {
 180     addConstantValue(*VariableDIE, CI, GTy);
 181   } else if (const ConstantExpr *CE = getMergedGlobalExpr(GV.getConstant())) {
 182     addToAccelTable = true;
 183     // GV is a merged global.
 184     DIELoc *Loc = new (DIEValueAllocator) DIELoc();
 185     Value *Ptr = CE->getOperand(0);
 186     MCSymbol *Sym = Asm->getSymbol(cast<GlobalValue>(Ptr));
 187     DD->addArangeLabel(SymbolCU(this, Sym));
 188     addOpAddress(*Loc, Sym);
 189     addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
 190     SmallVector<Value *, 3> Idx(CE->op_begin() + 1, CE->op_end());
 191     addUInt(*Loc, dwarf::DW_FORM_udata,
 192             Asm->getDataLayout().getIndexedOffset(Ptr->getType(), Idx));
 193     addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
 194     addBlock(*VariableDIE, dwarf::DW_AT_location, Loc);
 195   }
 196
 197   if (addToAccelTable) {
 198     DD->addAccelName(GV.getName(), *VariableDIE);
 199
 200     // If the linkage name is different than the name, go ahead and output
 201     // that as well into the name table.
 202     if (GV.getLinkageName() != "" && GV.getName() != GV.getLinkageName())
 203       DD->addAccelName(GV.getLinkageName(), *VariableDIE);
 204   }
 205
 206   addGlobalName(GV.getName(), *VariableDIE, DeclContext);
 207   return VariableDIE;
 208 }
 209
 210 void DwarfCompileUnit::addRange(RangeSpan Range) {
 211   bool SameAsPrevCU = this == DD->getPrevCU();
 212   DD->setPrevCU(this);
 213   // If we have no current ranges just add the range and return, otherwise,
 214   // check the current section and CU against the previous section and CU we
 215   // emitted into and the subprogram was contained within. If these are the
 216   // same then extend our current range, otherwise add this as a new range.
 217   if (CURanges.empty() || !SameAsPrevCU ||
 218       (&CURanges.back().getEnd()->getSection() !=
 219        &Range.getEnd()->getSection())) {
 220     CURanges.push_back(Range);
 221     return;
 222   }
 223
 224   CURanges.back().setEnd(Range.getEnd());
 225 }
 226
 227 void DwarfCompileUnit::addSectionLabel(DIE &Die, dwarf::Attribute Attribute,
 228                                        const MCSymbol *Label,
 229                                        const MCSymbol *Sec) {
 230   if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
 231     addLabel(Die, Attribute,
 232              DD->getDwarfVersion() >= 4 ? dwarf::DW_FORM_sec_offset
 233                                         : dwarf::DW_FORM_data4,
 234              Label);
 235   else
 236     addSectionDelta(Die, Attribute, Label, Sec);
 237 }
 238
 239 void DwarfCompileUnit::initStmtList() {
 240   // Define start line table label for each Compile Unit.
 241   MCSymbol *LineTableStartSym =
 242       Asm->OutStreamer.getDwarfLineTableSymbol(getUniqueID());
 243
 244   stmtListIndex = UnitDie.getValues().size();
 245
 246   // DW_AT_stmt_list is a offset of line number information for this
 247   // compile unit in debug_line section. For split dwarf this is
 248   // left in the skeleton CU and so not included.
 249   // The line table entries are not always emitted in assembly, so it
 250   // is not okay to use line_table_start here.
 251   const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
 252   addSectionLabel(UnitDie, dwarf::DW_AT_stmt_list, LineTableStartSym,
 253                   TLOF.getDwarfLineSection()->getBeginSymbol());
 254 }
 255
 256 void DwarfCompileUnit::applyStmtList(DIE &D) {
 257   D.addValue(dwarf::DW_AT_stmt_list,
 258              UnitDie.getAbbrev().getData()[stmtListIndex].getForm(),
 259              UnitDie.getValues()[stmtListIndex]);
 260 }
 261
 262 void DwarfCompileUnit::attachLowHighPC(DIE &D, const MCSymbol *Begin,
 263                                        const MCSymbol *End) {
 264   assert(Begin && "Begin label should not be null!");
 265   assert(End && "End label should not be null!");
 266   assert(Begin->isDefined() && "Invalid starting label");
 267   assert(End->isDefined() && "Invalid end label");
 268
 269   addLabelAddress(D, dwarf::DW_AT_low_pc, Begin);
 270   if (DD->getDwarfVersion() < 4)
 271     addLabelAddress(D, dwarf::DW_AT_high_pc, End);
 272   else
 273     addLabelDelta(D, dwarf::DW_AT_high_pc, End, Begin);
 274 }
 275
 276 // Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
 277 // and DW_AT_high_pc attributes. If there are global variables in this
 278 // scope then create and insert DIEs for these variables.
 279 DIE &DwarfCompileUnit::updateSubprogramScopeDIE(DISubprogram SP) {
 280   DIE *SPDie = getOrCreateSubprogramDIE(SP, includeMinimalInlineScopes());
 281
 282   attachLowHighPC(*SPDie, Asm->getFunctionBegin(), Asm->getFunctionEnd());
 283   if (!DD->getCurrentFunction()->getTarget().Options.DisableFramePointerElim(
 284           *DD->getCurrentFunction()))
 285     addFlag(*SPDie, dwarf::DW_AT_APPLE_omit_frame_ptr);
 286
 287   // Only include DW_AT_frame_base in full debug info
 288   if (!includeMinimalInlineScopes()) {
 289     const TargetRegisterInfo *RI = Asm->MF->getSubtarget().getRegisterInfo();
 290     MachineLocation Location(RI->getFrameRegister(*Asm->MF));
 291     if (RI->isPhysicalRegister(Location.getReg()))
 292       addAddress(*SPDie, dwarf::DW_AT_frame_base, Location);
 293   }
 294
 295   // Add name to the name table, we do this here because we're guaranteed
 296   // to have concrete versions of our DW_TAG_subprogram nodes.
 297   DD->addSubprogramNames(SP, *SPDie);
 298
 299   return *SPDie;
 300 }
 301
 302 // Construct a DIE for this scope.
 303 void DwarfCompileUnit::constructScopeDIE(
 304     LexicalScope *Scope, SmallVectorImpl<std::unique_ptr<DIE>> &FinalChildren) {
 305   if (!Scope || !Scope->getScopeNode())
 306     return;
 307
 308   DIScope DS(Scope->getScopeNode());
 309
 310   assert((Scope->getInlinedAt() || !DS.isSubprogram()) &&
 311          "Only handle inlined subprograms here, use "
 312          "constructSubprogramScopeDIE for non-inlined "
 313          "subprograms");
 314
 315   SmallVector<std::unique_ptr<DIE>, 8> Children;
 316
 317   // We try to create the scope DIE first, then the children DIEs. This will
 318   // avoid creating un-used children then removing them later when we find out
 319   // the scope DIE is null.
 320   std::unique_ptr<DIE> ScopeDIE;
 321   if (Scope->getParent() && DS.isSubprogram()) {
 322     ScopeDIE = constructInlinedScopeDIE(Scope);
 323     if (!ScopeDIE)
 324       return;
 325     // We create children when the scope DIE is not null.
 326     createScopeChildrenDIE(Scope, Children);
 327   } else {
 328     // Early exit when we know the scope DIE is going to be null.
 329     if (DD->isLexicalScopeDIENull(Scope))
 330       return;
 331
 332     unsigned ChildScopeCount;
 333
 334     // We create children here when we know the scope DIE is not going to be
 335     // null and the children will be added to the scope DIE.
 336     createScopeChildrenDIE(Scope, Children, &ChildScopeCount);
 337
 338     // Skip imported directives in gmlt-like data.
 339     if (!includeMinimalInlineScopes()) {
 340       // There is no need to emit empty lexical block DIE.
 341       for (const auto &E : DD->findImportedEntitiesForScope(DS))
 342         Children.push_back(
 343             constructImportedEntityDIE(DIImportedEntity(E.second)));
 344     }
 345
 346     // If there are only other scopes as children, put them directly in the
 347     // parent instead, as this scope would serve no purpose.
 348     if (Children.size() == ChildScopeCount) {
 349       FinalChildren.insert(FinalChildren.end(),
 350                            std::make_move_iterator(Children.begin()),
 351                            std::make_move_iterator(Children.end()));
 352       return;
 353     }
 354     ScopeDIE = constructLexicalScopeDIE(Scope);
 355     assert(ScopeDIE && "Scope DIE should not be null.");
 356   }
 357
 358   // Add children
 359   for (auto &I : Children)
 360     ScopeDIE->addChild(std::move(I));
 361
 362   FinalChildren.push_back(std::move(ScopeDIE));
 363 }
 364
 365 void DwarfCompileUnit::addSectionDelta(DIE &Die, dwarf::Attribute Attribute,
 366                                        const MCSymbol *Hi, const MCSymbol *Lo) {
 367   DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
 368   Die.addValue(Attribute, DD->getDwarfVersion() >= 4 ? dwarf::DW_FORM_sec_offset
 369                                                      : dwarf::DW_FORM_data4,
 370                Value);
 371 }
 372
 373 void DwarfCompileUnit::addScopeRangeList(DIE &ScopeDIE,
 374                                          SmallVector<RangeSpan, 2> Range) {
 375   const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
 376
 377   // Emit offset in .debug_range as a relocatable label. emitDIE will handle
 378   // emitting it appropriately.
 379   const MCSymbol *RangeSectionSym =
 380       TLOF.getDwarfRangesSection()->getBeginSymbol();
 381
 382   RangeSpanList List(Asm->createTempSymbol("debug_ranges"), std::move(Range));
 383
 384   // Under fission, ranges are specified by constant offsets relative to the
 385   // CU's DW_AT_GNU_ranges_base.
 386   if (isDwoUnit())
 387     addSectionDelta(ScopeDIE, dwarf::DW_AT_ranges, List.getSym(),
 388                     RangeSectionSym);
 389   else
 390     addSectionLabel(ScopeDIE, dwarf::DW_AT_ranges, List.getSym(),
 391                     RangeSectionSym);
 392
 393   // Add the range list to the set of ranges to be emitted.
 394   (Skeleton ? Skeleton : this)->CURangeLists.push_back(std::move(List));
 395 }
 396
 397 void DwarfCompileUnit::attachRangesOrLowHighPC(
 398     DIE &Die, SmallVector<RangeSpan, 2> Ranges) {
 399   if (Ranges.size() == 1) {
 400     const auto &single = Ranges.front();
 401     attachLowHighPC(Die, single.getStart(), single.getEnd());
 402   } else
 403     addScopeRangeList(Die, std::move(Ranges));
 404 }
 405
 406 void DwarfCompileUnit::attachRangesOrLowHighPC(
 407     DIE &Die, const SmallVectorImpl<InsnRange> &Ranges) {
 408   SmallVector<RangeSpan, 2> List;
 409   List.reserve(Ranges.size());
 410   for (const InsnRange &R : Ranges)
 411     List.push_back(RangeSpan(DD->getLabelBeforeInsn(R.first),
 412                              DD->getLabelAfterInsn(R.second)));
 413   attachRangesOrLowHighPC(Die, std::move(List));
 414 }
 415
 416 // This scope represents inlined body of a function. Construct DIE to
 417 // represent this concrete inlined copy of the function.
 418 std::unique_ptr<DIE>
 419 DwarfCompileUnit::constructInlinedScopeDIE(LexicalScope *Scope) {
 420   assert(Scope->getScopeNode());
 421   DIScope DS(Scope->getScopeNode());
 422   DISubprogram InlinedSP = getDISubprogram(DS);
 423   // Find the subprogram's DwarfCompileUnit in the SPMap in case the subprogram
 424   // was inlined from another compile unit.
 425   DIE *OriginDIE = DU->getAbstractSPDies()[InlinedSP];
 426   assert(OriginDIE && "Unable to find original DIE for an inlined subprogram.");
 427
 428   auto ScopeDIE = make_unique<DIE>(dwarf::DW_TAG_inlined_subroutine);
 429   addDIEEntry(*ScopeDIE, dwarf::DW_AT_abstract_origin, *OriginDIE);
 430
 431   attachRangesOrLowHighPC(*ScopeDIE, Scope->getRanges());
 432
 433   // Add the call site information to the DIE.
 434   DILocation DL(Scope->getInlinedAt());
 435   addUInt(*ScopeDIE, dwarf::DW_AT_call_file, None,
 436           getOrCreateSourceID(DL.getFilename(), DL.getDirectory()));
 437   addUInt(*ScopeDIE, dwarf::DW_AT_call_line, None, DL.getLineNumber());
 438
 439   // Add name to the name table, we do this here because we're guaranteed
 440   // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
 441   DD->addSubprogramNames(InlinedSP, *ScopeDIE);
 442
 443   return ScopeDIE;
 444 }
 445
 446 // Construct new DW_TAG_lexical_block for this scope and attach
 447 // DW_AT_low_pc/DW_AT_high_pc labels.
 448 std::unique_ptr<DIE>
 449 DwarfCompileUnit::constructLexicalScopeDIE(LexicalScope *Scope) {
 450   if (DD->isLexicalScopeDIENull(Scope))
 451     return nullptr;
 452
 453   auto ScopeDIE = make_unique<DIE>(dwarf::DW_TAG_lexical_block);
 454   if (Scope->isAbstractScope())
 455     return ScopeDIE;
 456
 457   attachRangesOrLowHighPC(*ScopeDIE, Scope->getRanges());
 458
 459   return ScopeDIE;
 460 }
 461
 462 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
 463 std::unique_ptr<DIE> DwarfCompileUnit::constructVariableDIE(DbgVariable &DV,
 464                                                             bool Abstract) {
 465   auto D = constructVariableDIEImpl(DV, Abstract);
 466   DV.setDIE(*D);
 467   return D;
 468 }
 469
 470 std::unique_ptr<DIE>
 471 DwarfCompileUnit::constructVariableDIEImpl(const DbgVariable &DV,
 472                                            bool Abstract) {
 473   // Define variable debug information entry.
 474   auto VariableDie = make_unique<DIE>(DV.getTag());
 475
 476   if (Abstract) {
 477     applyVariableAttributes(DV, *VariableDie);
 478     return VariableDie;
 479   }
 480
 481   // Add variable address.
 482
 483   unsigned Offset = DV.getDotDebugLocOffset();
 484   if (Offset != ~0U) {
 485     addLocationList(*VariableDie, dwarf::DW_AT_location, Offset);
 486     return VariableDie;
 487   }
 488
 489   // Check if variable is described by a DBG_VALUE instruction.
 490   if (const MachineInstr *DVInsn = DV.getMInsn()) {
 491     assert(DVInsn->getNumOperands() == 4);
 492     if (DVInsn->getOperand(0).isReg()) {
 493       const MachineOperand RegOp = DVInsn->getOperand(0);
 494       // If the second operand is an immediate, this is an indirect value.
 495       if (DVInsn->getOperand(1).isImm()) {
 496         MachineLocation Location(RegOp.getReg(),
 497                                  DVInsn->getOperand(1).getImm());
 498         addVariableAddress(DV, *VariableDie, Location);
 499       } else if (RegOp.getReg())
 500         addVariableAddress(DV, *VariableDie, MachineLocation(RegOp.getReg()));
 501     } else if (DVInsn->getOperand(0).isImm())
 502       addConstantValue(*VariableDie, DVInsn->getOperand(0), DV.getType());
 503     else if (DVInsn->getOperand(0).isFPImm())
 504       addConstantFPValue(*VariableDie, DVInsn->getOperand(0));
 505     else if (DVInsn->getOperand(0).isCImm())
 506       addConstantValue(*VariableDie, DVInsn->getOperand(0).getCImm(),
 507                        DV.getType());
 508
 509     return VariableDie;
 510   }
 511
 512   // .. else use frame index.
 513   if (DV.getFrameIndex().back() == ~0)
 514     return VariableDie;
 515
 516   auto Expr = DV.getExpression().begin();
 517   DIELoc *Loc = new (DIEValueAllocator) DIELoc();
 518   DIEDwarfExpression DwarfExpr(*Asm, *this, *Loc);
 519   for (auto FI : DV.getFrameIndex()) {
 520     unsigned FrameReg = 0;
 521     const TargetFrameLowering *TFI = Asm->MF->getSubtarget().getFrameLowering();
 522     int Offset = TFI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
 523     assert(Expr != DV.getExpression().end() &&
 524            "Wrong number of expressions");
 525     DwarfExpr.AddMachineRegIndirect(FrameReg, Offset);
 526     DwarfExpr.AddExpression(Expr->begin(), Expr->end());
 527     ++Expr;
 528   }
 529   addBlock(*VariableDie, dwarf::DW_AT_location, Loc);
 530
 531   return VariableDie;
 532 }
 533
 534 std::unique_ptr<DIE> DwarfCompileUnit::constructVariableDIE(
 535     DbgVariable &DV, const LexicalScope &Scope, DIE *&ObjectPointer) {
 536   auto Var = constructVariableDIE(DV, Scope.isAbstractScope());
 537   if (DV.isObjectPointer())
 538     ObjectPointer = Var.get();
 539   return Var;
 540 }
 541
 542 DIE *DwarfCompileUnit::createScopeChildrenDIE(
 543     LexicalScope *Scope, SmallVectorImpl<std::unique_ptr<DIE>> &Children,
 544     unsigned *ChildScopeCount) {
 545   DIE *ObjectPointer = nullptr;
 546
 547   for (DbgVariable *DV : DU->getScopeVariables().lookup(Scope))
 548     Children.push_back(constructVariableDIE(*DV, *Scope, ObjectPointer));
 549
 550   unsigned ChildCountWithoutScopes = Children.size();
 551
 552   for (LexicalScope *LS : Scope->getChildren())
 553     constructScopeDIE(LS, Children);
 554
 555   if (ChildScopeCount)
 556     *ChildScopeCount = Children.size() - ChildCountWithoutScopes;
 557
 558   return ObjectPointer;
 559 }
 560
 561 void DwarfCompileUnit::constructSubprogramScopeDIE(LexicalScope *Scope) {
 562   assert(Scope && Scope->getScopeNode());
 563   assert(!Scope->getInlinedAt());
 564   assert(!Scope->isAbstractScope());
 565   DISubprogram Sub(Scope->getScopeNode());
 566
 567   assert(Sub.isSubprogram());
 568
 569   DD->getProcessedSPNodes().insert(Sub);
 570
 571   DIE &ScopeDIE = updateSubprogramScopeDIE(Sub);
 572
 573   // If this is a variadic function, add an unspecified parameter.
 574   DITypeArray FnArgs = Sub.getType().getTypeArray();
 575
 576   // Collect lexical scope children first.
 577   // ObjectPointer might be a local (non-argument) local variable if it's a
 578   // block's synthetic this pointer.
 579   if (DIE *ObjectPointer = createAndAddScopeChildren(Scope, ScopeDIE))
 580     addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer, *ObjectPointer);
 581
 582   // If we have a single element of null, it is a function that returns void.
 583   // If we have more than one elements and the last one is null, it is a
 584   // variadic function.
 585   if (FnArgs.getNumElements() > 1 &&
 586       !FnArgs.getElement(FnArgs.getNumElements() - 1) &&
 587       !includeMinimalInlineScopes())
 588     ScopeDIE.addChild(make_unique<DIE>(dwarf::DW_TAG_unspecified_parameters));
 589 }
 590
 591 DIE *DwarfCompileUnit::createAndAddScopeChildren(LexicalScope *Scope,
 592                                                  DIE &ScopeDIE) {
 593   // We create children when the scope DIE is not null.
 594   SmallVector<std::unique_ptr<DIE>, 8> Children;
 595   DIE *ObjectPointer = createScopeChildrenDIE(Scope, Children);
 596
 597   // Add children
 598   for (auto &I : Children)
 599     ScopeDIE.addChild(std::move(I));
 600
 601   return ObjectPointer;
 602 }
 603
 604 void
 605 DwarfCompileUnit::constructAbstractSubprogramScopeDIE(LexicalScope *Scope) {
 606   DIE *&AbsDef = DU->getAbstractSPDies()[Scope->getScopeNode()];
 607   if (AbsDef)
 608     return;
 609
 610   DISubprogram SP(Scope->getScopeNode());
 611
 612   DIE *ContextDIE;
 613
 614   if (includeMinimalInlineScopes())
 615     ContextDIE = &getUnitDie();
 616   // Some of this is duplicated from DwarfUnit::getOrCreateSubprogramDIE, with
 617   // the important distinction that the DIDescriptor is not associated with the
 618   // DIE (since the DIDescriptor will be associated with the concrete DIE, if
 619   // any). It could be refactored to some common utility function.
 620   else if (DISubprogram SPDecl = SP.getFunctionDeclaration()) {
 621     ContextDIE = &getUnitDie();
 622     getOrCreateSubprogramDIE(SPDecl);
 623   } else
 624     ContextDIE = getOrCreateContextDIE(resolve(SP.getContext()));
 625
 626   // Passing null as the associated DIDescriptor because the abstract definition
 627   // shouldn't be found by lookup.
 628   AbsDef =
 629       &createAndAddDIE(dwarf::DW_TAG_subprogram, *ContextDIE, DIDescriptor());
 630   applySubprogramAttributesToDefinition(SP, *AbsDef);
 631
 632   if (!includeMinimalInlineScopes())
 633     addUInt(*AbsDef, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
 634   if (DIE *ObjectPointer = createAndAddScopeChildren(Scope, *AbsDef))
 635     addDIEEntry(*AbsDef, dwarf::DW_AT_object_pointer, *ObjectPointer);
 636 }
 637
 638 std::unique_ptr<DIE>
 639 DwarfCompileUnit::constructImportedEntityDIE(const DIImportedEntity &Module) {
 640   assert(Module.Verify() &&
 641          "Use one of the MDNode * overloads to handle invalid metadata");
 642   std::unique_ptr<DIE> IMDie = make_unique<DIE>((dwarf::Tag)Module.getTag());
 643   insertDIE(Module, IMDie.get());
 644   DIE *EntityDie;
 645   DIDescriptor Entity = resolve(Module.getEntity());
 646   if (Entity.isNameSpace())
 647     EntityDie = getOrCreateNameSpace(DINameSpace(Entity));
 648   else if (Entity.isSubprogram())
 649     EntityDie = getOrCreateSubprogramDIE(DISubprogram(Entity));
 650   else if (Entity.isType())
 651     EntityDie = getOrCreateTypeDIE(DIType(Entity));
 652   else if (Entity.isGlobalVariable())
 653     EntityDie = getOrCreateGlobalVariableDIE(DIGlobalVariable(Entity));
 654   else
 655     EntityDie = getDIE(Entity);
 656   assert(EntityDie);
 657   addSourceLine(*IMDie, Module.getLineNumber(),
 658                 Module.getContext().getFilename(),
 659                 Module.getContext().getDirectory());
 660   addDIEEntry(*IMDie, dwarf::DW_AT_import, *EntityDie);
 661   StringRef Name = Module.getName();
 662   if (!Name.empty())
 663     addString(*IMDie, dwarf::DW_AT_name, Name);
 664
 665   return IMDie;
 666 }
 667
 668 void DwarfCompileUnit::finishSubprogramDefinition(DISubprogram SP) {
 669   DIE *D = getDIE(SP);
 670   if (DIE *AbsSPDIE = DU->getAbstractSPDies().lookup(SP)) {
 671     if (D)
 672       // If this subprogram has an abstract definition, reference that
 673       addDIEEntry(*D, dwarf::DW_AT_abstract_origin, *AbsSPDIE);
 674   } else {
 675     if (!D && !includeMinimalInlineScopes())
 676       // Lazily construct the subprogram if we didn't see either concrete or
 677       // inlined versions during codegen. (except in -gmlt ^ where we want
 678       // to omit these entirely)
 679       D = getOrCreateSubprogramDIE(SP);
 680     if (D)
 681       // And attach the attributes
 682       applySubprogramAttributesToDefinition(SP, *D);
 683   }
 684 }
 685 void DwarfCompileUnit::collectDeadVariables(DISubprogram SP) {
 686   assert(SP.isSubprogram() && "CU's subprogram list contains a non-subprogram");
 687   assert(SP.isDefinition() &&
 688          "CU's subprogram list contains a subprogram declaration");
 689   DIArray Variables = SP.getVariables();
 690   if (Variables.getNumElements() == 0)
 691     return;
 692
 693   DIE *SPDIE = DU->getAbstractSPDies().lookup(SP);
 694   if (!SPDIE)
 695     SPDIE = getDIE(SP);
 696   assert(SPDIE);
 697   for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
 698     DIVariable DV(Variables.getElement(vi));
 699     assert(DV.isVariable());
 700     DbgVariable NewVar(DV, DIExpression(), DD);
 701     auto VariableDie = constructVariableDIE(NewVar);
 702     applyVariableAttributes(NewVar, *VariableDie);
 703     SPDIE->addChild(std::move(VariableDie));
 704   }
 705 }
 706
 707 void DwarfCompileUnit::emitHeader(bool UseOffsets) {
 708   // Don't bother labeling the .dwo unit, as its offset isn't used.
 709   if (!Skeleton) {
 710     LabelBegin = Asm->createTempSymbol("cu_begin");
 711     Asm->OutStreamer.EmitLabel(LabelBegin);
 712   }
 713
 714   DwarfUnit::emitHeader(UseOffsets);
 715 }
 716
 717 /// addGlobalName - Add a new global name to the compile unit.
 718 void DwarfCompileUnit::addGlobalName(StringRef Name, DIE &Die,
 719                                      DIScope Context) {
 720   if (includeMinimalInlineScopes())
 721     return;
 722   std::string FullName = getParentContextString(Context) + Name.str();
 723   GlobalNames[FullName] = &Die;
 724 }
 725
 726 /// Add a new global type to the unit.
 727 void DwarfCompileUnit::addGlobalType(DIType Ty, const DIE &Die,
 728                                      DIScope Context) {
 729   if (includeMinimalInlineScopes())
 730     return;
 731   std::string FullName = getParentContextString(Context) + Ty.getName().str();
 732   GlobalTypes[FullName] = &Die;
 733 }
 734
 735 /// addVariableAddress - Add DW_AT_location attribute for a
 736 /// DbgVariable based on provided MachineLocation.
 737 void DwarfCompileUnit::addVariableAddress(const DbgVariable &DV, DIE &Die,
 738                                           MachineLocation Location) {
 739   if (DV.variableHasComplexAddress())
 740     addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
 741   else if (DV.isBlockByrefVariable())
 742     addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
 743   else
 744     addAddress(Die, dwarf::DW_AT_location, Location);
 745 }
 746
 747 /// Add an address attribute to a die based on the location provided.
 748 void DwarfCompileUnit::addAddress(DIE &Die, dwarf::Attribute Attribute,
 749                                   const MachineLocation &Location) {
 750   DIELoc *Loc = new (DIEValueAllocator) DIELoc();
 751
 752   bool validReg;
 753   if (Location.isReg())
 754     validReg = addRegisterOpPiece(*Loc, Location.getReg());
 755   else
 756     validReg = addRegisterOffset(*Loc, Location.getReg(), Location.getOffset());
 757
 758   if (!validReg)
 759     return;
 760
 761   // Now attach the location information to the DIE.
 762   addBlock(Die, Attribute, Loc);
 763 }
 764
 765 /// Start with the address based on the location provided, and generate the
 766 /// DWARF information necessary to find the actual variable given the extra
 767 /// address information encoded in the DbgVariable, starting from the starting
 768 /// location.  Add the DWARF information to the die.
 769 void DwarfCompileUnit::addComplexAddress(const DbgVariable &DV, DIE &Die,
 770                                          dwarf::Attribute Attribute,
 771                                          const MachineLocation &Location) {
 772   DIELoc *Loc = new (DIEValueAllocator) DIELoc();
 773   DIEDwarfExpression DwarfExpr(*Asm, *this, *Loc);
 774   assert(DV.getExpression().size() == 1);
 775   DIExpression Expr = DV.getExpression().back();
 776   bool ValidReg;
 777   if (Location.getOffset()) {
 778     ValidReg = DwarfExpr.AddMachineRegIndirect(Location.getReg(),
 779                                                Location.getOffset());
 780     if (ValidReg)
 781       DwarfExpr.AddExpression(Expr.begin(), Expr.end());
 782   } else
 783     ValidReg = DwarfExpr.AddMachineRegExpression(Expr, Location.getReg());
 784
 785   // Now attach the location information to the DIE.
 786   if (ValidReg)
 787     addBlock(Die, Attribute, Loc);
 788 }
 789
 790 /// Add a Dwarf loclistptr attribute data and value.
 791 void DwarfCompileUnit::addLocationList(DIE &Die, dwarf::Attribute Attribute,
 792                                        unsigned Index) {
 793   DIEValue *Value = new (DIEValueAllocator) DIELocList(Index);
 794   dwarf::Form Form = DD->getDwarfVersion() >= 4 ? dwarf::DW_FORM_sec_offset
 795                                                 : dwarf::DW_FORM_data4;
 796   Die.addValue(Attribute, Form, Value);
 797 }
 798
 799 void DwarfCompileUnit::applyVariableAttributes(const DbgVariable &Var,
 800                                                DIE &VariableDie) {
 801   StringRef Name = Var.getName();
 802   if (!Name.empty())
 803     addString(VariableDie, dwarf::DW_AT_name, Name);
 804   addSourceLine(VariableDie, Var.getVariable());
 805   addType(VariableDie, Var.getType());
 806   if (Var.isArtificial())
 807     addFlag(VariableDie, dwarf::DW_AT_artificial);
 808 }
 809
 810 /// Add a Dwarf expression attribute data and value.
 811 void DwarfCompileUnit::addExpr(DIELoc &Die, dwarf::Form Form,
 812                                const MCExpr *Expr) {
 813   DIEValue *Value = new (DIEValueAllocator) DIEExpr(Expr);
 814   Die.addValue((dwarf::Attribute)0, Form, Value);
 815 }
 816
 817 void DwarfCompileUnit::applySubprogramAttributesToDefinition(DISubprogram SP,
 818                                                              DIE &SPDie) {
 819   DISubprogram SPDecl = SP.getFunctionDeclaration();
 820   DIScope Context = resolve(SPDecl ? SPDecl.getContext() : SP.getContext());
 821   applySubprogramAttributes(SP, SPDie, includeMinimalInlineScopes());
 822   addGlobalName(SP.getName(), SPDie, Context);
 823 }
 824
 825 bool DwarfCompileUnit::isDwoUnit() const {
 826   return DD->useSplitDwarf() && Skeleton;
 827 }
 828
 829 bool DwarfCompileUnit::includeMinimalInlineScopes() const {
 830   return getCUNode().getEmissionKind() == DIBuilder::LineTablesOnly ||
 831          (DD->useSplitDwarf() && !Skeleton);
 832 }
 833 } // end llvm namespace