contrib/llvm/lib/CodeGen/AsmPrinter/DwarfCompileUnit.cpp

   1 #include "DwarfCompileUnit.h"
   2 #include "DwarfExpression.h"
   3 #include "llvm/CodeGen/MachineFunction.h"
   4 #include "llvm/IR/Constants.h"
   5 #include "llvm/IR/DataLayout.h"
   6 #include "llvm/IR/GlobalValue.h"
   7 #include "llvm/IR/GlobalVariable.h"
   8 #include "llvm/IR/Instruction.h"
   9 #include "llvm/MC/MCAsmInfo.h"
  10 #include "llvm/MC/MCStreamer.h"
  11 #include "llvm/Target/TargetFrameLowering.h"
  12 #include "llvm/Target/TargetLoweringObjectFile.h"
  13 #include "llvm/Target/TargetMachine.h"
  14 #include "llvm/Target/TargetRegisterInfo.h"
  15 #include "llvm/Target/TargetSubtargetInfo.h"
  16
  17 namespace llvm {
  18
  19 DwarfCompileUnit::DwarfCompileUnit(unsigned UID, const DICompileUnit *Node,
  20                                    AsmPrinter *A, DwarfDebug *DW,
  21                                    DwarfFile *DWU)
  22     : DwarfUnit(dwarf::DW_TAG_compile_unit, Node, A, DW, DWU), UniqueID(UID),
  23       Skeleton(nullptr), BaseAddress(nullptr) {
  24   insertDIE(Node, &getUnitDie());
  25   MacroLabelBegin = Asm->createTempSymbol("cu_macro_begin");
  26 }
  27
  28 /// addLabelAddress - Add a dwarf label attribute data and value using
  29 /// DW_FORM_addr or DW_FORM_GNU_addr_index.
  30 ///
  31 void DwarfCompileUnit::addLabelAddress(DIE &Die, dwarf::Attribute Attribute,
  32                                        const MCSymbol *Label) {
  33
  34   // Don't use the address pool in non-fission or in the skeleton unit itself.
  35   // FIXME: Once GDB supports this, it's probably worthwhile using the address
  36   // pool from the skeleton - maybe even in non-fission (possibly fewer
  37   // relocations by sharing them in the pool, but we have other ideas about how
  38   // to reduce the number of relocations as well/instead).
  39   if (!DD->useSplitDwarf() || !Skeleton)
  40     return addLocalLabelAddress(Die, Attribute, Label);
  41
  42   if (Label)
  43     DD->addArangeLabel(SymbolCU(this, Label));
  44
  45   unsigned idx = DD->getAddressPool().getIndex(Label);
  46   Die.addValue(DIEValueAllocator, Attribute, dwarf::DW_FORM_GNU_addr_index,
  47                DIEInteger(idx));
  48 }
  49
  50 void DwarfCompileUnit::addLocalLabelAddress(DIE &Die,
  51                                             dwarf::Attribute Attribute,
  52                                             const MCSymbol *Label) {
  53   if (Label)
  54     DD->addArangeLabel(SymbolCU(this, Label));
  55
  56   if (Label)
  57     Die.addValue(DIEValueAllocator, Attribute, dwarf::DW_FORM_addr,
  58                  DIELabel(Label));
  59   else
  60     Die.addValue(DIEValueAllocator, Attribute, dwarf::DW_FORM_addr,
  61                  DIEInteger(0));
  62 }
  63
  64 unsigned DwarfCompileUnit::getOrCreateSourceID(StringRef FileName,
  65                                                StringRef DirName) {
  66   // If we print assembly, we can't separate .file entries according to
  67   // compile units. Thus all files will belong to the default compile unit.
  68
  69   // FIXME: add a better feature test than hasRawTextSupport. Even better,
  70   // extend .file to support this.
  71   return Asm->OutStreamer->EmitDwarfFileDirective(
  72       0, DirName, FileName,
  73       Asm->OutStreamer->hasRawTextSupport() ? 0 : getUniqueID());
  74 }
  75
  76 DIE *DwarfCompileUnit::getOrCreateGlobalVariableDIE(
  77     const DIGlobalVariable *GV, ArrayRef<GlobalExpr> GlobalExprs) {
  78   // Check for pre-existence.
  79   if (DIE *Die = getDIE(GV))
  80     return Die;
  81
  82   assert(GV);
  83
  84   auto *GVContext = GV->getScope();
  85   auto *GTy = DD->resolve(GV->getType());
  86
  87   // Construct the context before querying for the existence of the DIE in
  88   // case such construction creates the DIE.
  89   DIE *ContextDIE = getOrCreateContextDIE(GVContext);
  90
  91   // Add to map.
  92   DIE *VariableDIE = &createAndAddDIE(GV->getTag(), *ContextDIE, GV);
  93   DIScope *DeclContext;
  94   if (auto *SDMDecl = GV->getStaticDataMemberDeclaration()) {
  95     DeclContext = resolve(SDMDecl->getScope());
  96     assert(SDMDecl->isStaticMember() && "Expected static member decl");
  97     assert(GV->isDefinition());
  98     // We need the declaration DIE that is in the static member's class.
  99     DIE *VariableSpecDIE = getOrCreateStaticMemberDIE(SDMDecl);
 100     addDIEEntry(*VariableDIE, dwarf::DW_AT_specification, *VariableSpecDIE);
 101     // If the global variable's type is different from the one in the class
 102     // member type, assume that it's more specific and also emit it.
 103     if (GTy != DD->resolve(SDMDecl->getBaseType()))
 104       addType(*VariableDIE, GTy);
 105   } else {
 106     DeclContext = GV->getScope();
 107     // Add name and type.
 108     addString(*VariableDIE, dwarf::DW_AT_name, GV->getDisplayName());
 109     addType(*VariableDIE, GTy);
 110
 111     // Add scoping info.
 112     if (!GV->isLocalToUnit())
 113       addFlag(*VariableDIE, dwarf::DW_AT_external);
 114
 115     // Add line number info.
 116     addSourceLine(*VariableDIE, GV);
 117   }
 118
 119   if (!GV->isDefinition())
 120     addFlag(*VariableDIE, dwarf::DW_AT_declaration);
 121   else
 122     addGlobalName(GV->getName(), *VariableDIE, DeclContext);
 123
 124   if (uint32_t AlignInBytes = GV->getAlignInBytes())
 125     addUInt(*VariableDIE, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
 126             AlignInBytes);
 127
 128   // Add location.
 129   bool addToAccelTable = false;
 130   DIELoc *Loc = nullptr;
 131   std::unique_ptr<DIEDwarfExpression> DwarfExpr;
 132   bool AllConstant = std::all_of(
 133       GlobalExprs.begin(), GlobalExprs.end(),
 134       [&](const GlobalExpr GE) {
 135         return GE.Expr && GE.Expr->isConstant();
 136       });
 137
 138   for (const auto &GE : GlobalExprs) {
 139     const GlobalVariable *Global = GE.Var;
 140     const DIExpression *Expr = GE.Expr;
 141     // For compatibility with DWARF 3 and earlier,
 142     // DW_AT_location(DW_OP_constu, X, DW_OP_stack_value) becomes
 143     // DW_AT_const_value(X).
 144     if (GlobalExprs.size() == 1 && Expr && Expr->isConstant()) {
 145       addConstantValue(*VariableDIE, /*Unsigned=*/true, Expr->getElement(1));
 146       // We cannot describe the location of dllimport'd variables: the
 147       // computation of their address requires loads from the IAT.
 148     } else if ((Global && !Global->hasDLLImportStorageClass()) || AllConstant) {
 149       if (!Loc) {
 150         Loc = new (DIEValueAllocator) DIELoc;
 151         DwarfExpr = llvm::make_unique<DIEDwarfExpression>(*Asm, *this, *Loc);
 152       }
 153       addToAccelTable = true;
 154       if (Global) {
 155         const MCSymbol *Sym = Asm->getSymbol(Global);
 156         if (Global->isThreadLocal()) {
 157           if (Asm->TM.Options.EmulatedTLS) {
 158             // TODO: add debug info for emulated thread local mode.
 159           } else {
 160             // FIXME: Make this work with -gsplit-dwarf.
 161             unsigned PointerSize = Asm->getDataLayout().getPointerSize();
 162             assert((PointerSize == 4 || PointerSize == 8) &&
 163                    "Add support for other sizes if necessary");
 164             // Based on GCC's support for TLS:
 165             if (!DD->useSplitDwarf()) {
 166               // 1) Start with a constNu of the appropriate pointer size
 167               addUInt(*Loc, dwarf::DW_FORM_data1,
 168                       PointerSize == 4 ? dwarf::DW_OP_const4u
 169                                        : dwarf::DW_OP_const8u);
 170               // 2) containing the (relocated) offset of the TLS variable
 171               //    within the module's TLS block.
 172               addExpr(*Loc, dwarf::DW_FORM_udata,
 173                       Asm->getObjFileLowering().getDebugThreadLocalSymbol(Sym));
 174             } else {
 175               addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_const_index);
 176               addUInt(*Loc, dwarf::DW_FORM_udata,
 177                       DD->getAddressPool().getIndex(Sym, /* TLS */ true));
 178             }
 179             // 3) followed by an OP to make the debugger do a TLS lookup.
 180             addUInt(*Loc, dwarf::DW_FORM_data1,
 181                     DD->useGNUTLSOpcode() ? dwarf::DW_OP_GNU_push_tls_address
 182                                           : dwarf::DW_OP_form_tls_address);
 183           }
 184         } else {
 185           DD->addArangeLabel(SymbolCU(this, Sym));
 186           addOpAddress(*Loc, Sym);
 187         }
 188       }
 189       if (Expr) {
 190         DwarfExpr->addFragmentOffset(Expr);
 191         DwarfExpr->AddExpression(Expr);
 192       }
 193     }
 194   }
 195   if (Loc)
 196     addBlock(*VariableDIE, dwarf::DW_AT_location, DwarfExpr->finalize());
 197
 198   if (DD->useAllLinkageNames())
 199     addLinkageName(*VariableDIE, GV->getLinkageName());
 200
 201   if (addToAccelTable) {
 202     DD->addAccelName(GV->getName(), *VariableDIE);
 203
 204     // If the linkage name is different than the name, go ahead and output
 205     // that as well into the name table.
 206     if (GV->getLinkageName() != "" && GV->getName() != GV->getLinkageName())
 207       DD->addAccelName(GV->getLinkageName(), *VariableDIE);
 208   }
 209
 210   return VariableDIE;
 211 }
 212
 213 void DwarfCompileUnit::addRange(RangeSpan Range) {
 214   bool SameAsPrevCU = this == DD->getPrevCU();
 215   DD->setPrevCU(this);
 216   // If we have no current ranges just add the range and return, otherwise,
 217   // check the current section and CU against the previous section and CU we
 218   // emitted into and the subprogram was contained within. If these are the
 219   // same then extend our current range, otherwise add this as a new range.
 220   if (CURanges.empty() || !SameAsPrevCU ||
 221       (&CURanges.back().getEnd()->getSection() !=
 222        &Range.getEnd()->getSection())) {
 223     CURanges.push_back(Range);
 224     return;
 225   }
 226
 227   CURanges.back().setEnd(Range.getEnd());
 228 }
 229
 230 DIE::value_iterator
 231 DwarfCompileUnit::addSectionLabel(DIE &Die, dwarf::Attribute Attribute,
 232                                   const MCSymbol *Label, const MCSymbol *Sec) {
 233   if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
 234     return addLabel(Die, Attribute,
 235                     DD->getDwarfVersion() >= 4 ? dwarf::DW_FORM_sec_offset
 236                                                : dwarf::DW_FORM_data4,
 237                     Label);
 238   return addSectionDelta(Die, Attribute, Label, Sec);
 239 }
 240
 241 void DwarfCompileUnit::initStmtList() {
 242   // Define start line table label for each Compile Unit.
 243   MCSymbol *LineTableStartSym =
 244       Asm->OutStreamer->getDwarfLineTableSymbol(getUniqueID());
 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   StmtListValue =
 253       addSectionLabel(getUnitDie(), dwarf::DW_AT_stmt_list, LineTableStartSym,
 254                       TLOF.getDwarfLineSection()->getBeginSymbol());
 255 }
 256
 257 void DwarfCompileUnit::applyStmtList(DIE &D) {
 258   D.addValue(DIEValueAllocator, *StmtListValue);
 259 }
 260
 261 void DwarfCompileUnit::attachLowHighPC(DIE &D, const MCSymbol *Begin,
 262                                        const MCSymbol *End) {
 263   assert(Begin && "Begin label should not be null!");
 264   assert(End && "End label should not be null!");
 265   assert(Begin->isDefined() && "Invalid starting label");
 266   assert(End->isDefined() && "Invalid end label");
 267
 268   addLabelAddress(D, dwarf::DW_AT_low_pc, Begin);
 269   if (DD->getDwarfVersion() < 4)
 270     addLabelAddress(D, dwarf::DW_AT_high_pc, End);
 271   else
 272     addLabelDelta(D, dwarf::DW_AT_high_pc, End, Begin);
 273 }
 274
 275 // Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
 276 // and DW_AT_high_pc attributes. If there are global variables in this
 277 // scope then create and insert DIEs for these variables.
 278 DIE &DwarfCompileUnit::updateSubprogramScopeDIE(const DISubprogram *SP) {
 279   DIE *SPDie = getOrCreateSubprogramDIE(SP, includeMinimalInlineScopes());
 280
 281   attachLowHighPC(*SPDie, Asm->getFunctionBegin(), Asm->getFunctionEnd());
 282   if (DD->useAppleExtensionAttributes() &&
 283       !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<DIE *> &FinalChildren) {
 305   if (!Scope || !Scope->getScopeNode())
 306     return;
 307
 308   auto *DS = Scope->getScopeNode();
 309
 310   assert((Scope->getInlinedAt() || !isa<DISubprogram>(DS)) &&
 311          "Only handle inlined subprograms here, use "
 312          "constructSubprogramScopeDIE for non-inlined "
 313          "subprograms");
 314
 315   SmallVector<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   DIE *ScopeDIE;
 321   if (Scope->getParent() && isa<DISubprogram>(DS)) {
 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 *IE : ImportedEntities[DS])
 342         Children.push_back(
 343             constructImportedEntityDIE(cast<DIImportedEntity>(IE)));
 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 DIE::value_iterator
 366 DwarfCompileUnit::addSectionDelta(DIE &Die, dwarf::Attribute Attribute,
 367                                   const MCSymbol *Hi, const MCSymbol *Lo) {
 368   return Die.addValue(DIEValueAllocator, Attribute,
 369                       DD->getDwarfVersion() >= 4 ? dwarf::DW_FORM_sec_offset
 370                                                  : dwarf::DW_FORM_data4,
 371                       new (DIEValueAllocator) DIEDelta(Hi, Lo));
 372 }
 373
 374 void DwarfCompileUnit::addScopeRangeList(DIE &ScopeDIE,
 375                                          SmallVector<RangeSpan, 2> Range) {
 376   const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
 377
 378   // Emit offset in .debug_range as a relocatable label. emitDIE will handle
 379   // emitting it appropriately.
 380   const MCSymbol *RangeSectionSym =
 381       TLOF.getDwarfRangesSection()->getBeginSymbol();
 382
 383   RangeSpanList List(Asm->createTempSymbol("debug_ranges"), std::move(Range));
 384
 385   // Under fission, ranges are specified by constant offsets relative to the
 386   // CU's DW_AT_GNU_ranges_base.
 387   if (isDwoUnit())
 388     addSectionDelta(ScopeDIE, dwarf::DW_AT_ranges, List.getSym(),
 389                     RangeSectionSym);
 390   else
 391     addSectionLabel(ScopeDIE, dwarf::DW_AT_ranges, List.getSym(),
 392                     RangeSectionSym);
 393
 394   // Add the range list to the set of ranges to be emitted.
 395   (Skeleton ? Skeleton : this)->CURangeLists.push_back(std::move(List));
 396 }
 397
 398 void DwarfCompileUnit::attachRangesOrLowHighPC(
 399     DIE &Die, SmallVector<RangeSpan, 2> Ranges) {
 400   if (Ranges.size() == 1) {
 401     const auto &single = Ranges.front();
 402     attachLowHighPC(Die, single.getStart(), single.getEnd());
 403   } else
 404     addScopeRangeList(Die, std::move(Ranges));
 405 }
 406
 407 void DwarfCompileUnit::attachRangesOrLowHighPC(
 408     DIE &Die, const SmallVectorImpl<InsnRange> &Ranges) {
 409   SmallVector<RangeSpan, 2> List;
 410   List.reserve(Ranges.size());
 411   for (const InsnRange &R : Ranges)
 412     List.push_back(RangeSpan(DD->getLabelBeforeInsn(R.first),
 413                              DD->getLabelAfterInsn(R.second)));
 414   attachRangesOrLowHighPC(Die, std::move(List));
 415 }
 416
 417 // This scope represents inlined body of a function. Construct DIE to
 418 // represent this concrete inlined copy of the function.
 419 DIE *DwarfCompileUnit::constructInlinedScopeDIE(LexicalScope *Scope) {
 420   assert(Scope->getScopeNode());
 421   auto *DS = Scope->getScopeNode();
 422   auto *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 = DIE::get(DIEValueAllocator, 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   const DILocation *IA = Scope->getInlinedAt();
 435   addUInt(*ScopeDIE, dwarf::DW_AT_call_file, None,
 436           getOrCreateSourceID(IA->getFilename(), IA->getDirectory()));
 437   addUInt(*ScopeDIE, dwarf::DW_AT_call_line, None, IA->getLine());
 438   if (IA->getDiscriminator() && DD->getDwarfVersion() >= 4)
 439     addUInt(*ScopeDIE, dwarf::DW_AT_GNU_discriminator, None,
 440             IA->getDiscriminator());
 441
 442   // Add name to the name table, we do this here because we're guaranteed
 443   // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
 444   DD->addSubprogramNames(InlinedSP, *ScopeDIE);
 445
 446   return ScopeDIE;
 447 }
 448
 449 // Construct new DW_TAG_lexical_block for this scope and attach
 450 // DW_AT_low_pc/DW_AT_high_pc labels.
 451 DIE *DwarfCompileUnit::constructLexicalScopeDIE(LexicalScope *Scope) {
 452   if (DD->isLexicalScopeDIENull(Scope))
 453     return nullptr;
 454
 455   auto ScopeDIE = DIE::get(DIEValueAllocator, dwarf::DW_TAG_lexical_block);
 456   if (Scope->isAbstractScope())
 457     return ScopeDIE;
 458
 459   attachRangesOrLowHighPC(*ScopeDIE, Scope->getRanges());
 460
 461   return ScopeDIE;
 462 }
 463
 464 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
 465 DIE *DwarfCompileUnit::constructVariableDIE(DbgVariable &DV, bool Abstract) {
 466   auto D = constructVariableDIEImpl(DV, Abstract);
 467   DV.setDIE(*D);
 468   return D;
 469 }
 470
 471 DIE *DwarfCompileUnit::constructVariableDIEImpl(const DbgVariable &DV,
 472                                                 bool Abstract) {
 473   // Define variable debug information entry.
 474   auto VariableDie = DIE::get(DIEValueAllocator, DV.getTag());
 475
 476   if (Abstract) {
 477     applyVariableAttributes(DV, *VariableDie);
 478     return VariableDie;
 479   }
 480
 481   // Add variable address.
 482
 483   unsigned Offset = DV.getDebugLocListIndex();
 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       // This variable is described by a single constant.
 503       // Check whether it has a DIExpression.
 504       auto *Expr = DV.getSingleExpression();
 505       if (Expr && Expr->getNumElements()) {
 506         DIELoc *Loc = new (DIEValueAllocator) DIELoc;
 507         DIEDwarfExpression DwarfExpr(*Asm, *this, *Loc);
 508         // If there is an expression, emit raw unsigned bytes.
 509         DwarfExpr.addFragmentOffset(Expr);
 510         DwarfExpr.AddUnsignedConstant(DVInsn->getOperand(0).getImm());
 511         DwarfExpr.AddExpression(Expr);
 512         addBlock(*VariableDie, dwarf::DW_AT_location, DwarfExpr.finalize());
 513       } else
 514         addConstantValue(*VariableDie, DVInsn->getOperand(0), DV.getType());
 515     } else if (DVInsn->getOperand(0).isFPImm())
 516       addConstantFPValue(*VariableDie, DVInsn->getOperand(0));
 517     else if (DVInsn->getOperand(0).isCImm())
 518       addConstantValue(*VariableDie, DVInsn->getOperand(0).getCImm(),
 519                        DV.getType());
 520
 521     return VariableDie;
 522   }
 523
 524   // .. else use frame index.
 525   if (!DV.hasFrameIndexExprs())
 526     return VariableDie;
 527
 528   DIELoc *Loc = new (DIEValueAllocator) DIELoc;
 529   DIEDwarfExpression DwarfExpr(*Asm, *this, *Loc);
 530   for (auto &Fragment : DV.getFrameIndexExprs()) {
 531     unsigned FrameReg = 0;
 532     const TargetFrameLowering *TFI = Asm->MF->getSubtarget().getFrameLowering();
 533     int Offset = TFI->getFrameIndexReference(*Asm->MF, Fragment.FI, FrameReg);
 534     DwarfExpr.addFragmentOffset(Fragment.Expr);
 535     DwarfExpr.AddMachineRegIndirect(*Asm->MF->getSubtarget().getRegisterInfo(),
 536                                     FrameReg, Offset);
 537     DwarfExpr.AddExpression(Fragment.Expr);
 538   }
 539   addBlock(*VariableDie, dwarf::DW_AT_location, DwarfExpr.finalize());
 540
 541   return VariableDie;
 542 }
 543
 544 DIE *DwarfCompileUnit::constructVariableDIE(DbgVariable &DV,
 545                                             const LexicalScope &Scope,
 546                                             DIE *&ObjectPointer) {
 547   auto Var = constructVariableDIE(DV, Scope.isAbstractScope());
 548   if (DV.isObjectPointer())
 549     ObjectPointer = Var;
 550   return Var;
 551 }
 552
 553 DIE *DwarfCompileUnit::createScopeChildrenDIE(LexicalScope *Scope,
 554                                               SmallVectorImpl<DIE *> &Children,
 555                                               unsigned *ChildScopeCount) {
 556   DIE *ObjectPointer = nullptr;
 557
 558   for (DbgVariable *DV : DU->getScopeVariables().lookup(Scope))
 559     Children.push_back(constructVariableDIE(*DV, *Scope, ObjectPointer));
 560
 561   unsigned ChildCountWithoutScopes = Children.size();
 562
 563   for (LexicalScope *LS : Scope->getChildren())
 564     constructScopeDIE(LS, Children);
 565
 566   if (ChildScopeCount)
 567     *ChildScopeCount = Children.size() - ChildCountWithoutScopes;
 568
 569   return ObjectPointer;
 570 }
 571
 572 void DwarfCompileUnit::constructSubprogramScopeDIE(const DISubprogram *Sub, LexicalScope *Scope) {
 573   DIE &ScopeDIE = updateSubprogramScopeDIE(Sub);
 574
 575   if (Scope) {
 576     assert(!Scope->getInlinedAt());
 577     assert(!Scope->isAbstractScope());
 578     // Collect lexical scope children first.
 579     // ObjectPointer might be a local (non-argument) local variable if it's a
 580     // block's synthetic this pointer.
 581     if (DIE *ObjectPointer = createAndAddScopeChildren(Scope, ScopeDIE))
 582       addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer, *ObjectPointer);
 583   }
 584
 585   // If this is a variadic function, add an unspecified parameter.
 586   DITypeRefArray FnArgs = Sub->getType()->getTypeArray();
 587
 588   // If we have a single element of null, it is a function that returns void.
 589   // If we have more than one elements and the last one is null, it is a
 590   // variadic function.
 591   if (FnArgs.size() > 1 && !FnArgs[FnArgs.size() - 1] &&
 592       !includeMinimalInlineScopes())
 593     ScopeDIE.addChild(
 594         DIE::get(DIEValueAllocator, dwarf::DW_TAG_unspecified_parameters));
 595 }
 596
 597 DIE *DwarfCompileUnit::createAndAddScopeChildren(LexicalScope *Scope,
 598                                                  DIE &ScopeDIE) {
 599   // We create children when the scope DIE is not null.
 600   SmallVector<DIE *, 8> Children;
 601   DIE *ObjectPointer = createScopeChildrenDIE(Scope, Children);
 602
 603   // Add children
 604   for (auto &I : Children)
 605     ScopeDIE.addChild(std::move(I));
 606
 607   return ObjectPointer;
 608 }
 609
 610 void DwarfCompileUnit::constructAbstractSubprogramScopeDIE(
 611     LexicalScope *Scope) {
 612   DIE *&AbsDef = DU->getAbstractSPDies()[Scope->getScopeNode()];
 613   if (AbsDef)
 614     return;
 615
 616   auto *SP = cast<DISubprogram>(Scope->getScopeNode());
 617
 618   DIE *ContextDIE;
 619
 620   if (includeMinimalInlineScopes())
 621     ContextDIE = &getUnitDie();
 622   // Some of this is duplicated from DwarfUnit::getOrCreateSubprogramDIE, with
 623   // the important distinction that the debug node is not associated with the
 624   // DIE (since the debug node will be associated with the concrete DIE, if
 625   // any). It could be refactored to some common utility function.
 626   else if (auto *SPDecl = SP->getDeclaration()) {
 627     ContextDIE = &getUnitDie();
 628     getOrCreateSubprogramDIE(SPDecl);
 629   } else
 630     ContextDIE = getOrCreateContextDIE(resolve(SP->getScope()));
 631
 632   // Passing null as the associated node because the abstract definition
 633   // shouldn't be found by lookup.
 634   AbsDef = &createAndAddDIE(dwarf::DW_TAG_subprogram, *ContextDIE, nullptr);
 635   applySubprogramAttributesToDefinition(SP, *AbsDef);
 636
 637   if (!includeMinimalInlineScopes())
 638     addUInt(*AbsDef, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
 639   if (DIE *ObjectPointer = createAndAddScopeChildren(Scope, *AbsDef))
 640     addDIEEntry(*AbsDef, dwarf::DW_AT_object_pointer, *ObjectPointer);
 641 }
 642
 643 DIE *DwarfCompileUnit::constructImportedEntityDIE(
 644     const DIImportedEntity *Module) {
 645   DIE *IMDie = DIE::get(DIEValueAllocator, (dwarf::Tag)Module->getTag());
 646   insertDIE(Module, IMDie);
 647   DIE *EntityDie;
 648   auto *Entity = resolve(Module->getEntity());
 649   if (auto *NS = dyn_cast<DINamespace>(Entity))
 650     EntityDie = getOrCreateNameSpace(NS);
 651   else if (auto *M = dyn_cast<DIModule>(Entity))
 652     EntityDie = getOrCreateModule(M);
 653   else if (auto *SP = dyn_cast<DISubprogram>(Entity))
 654     EntityDie = getOrCreateSubprogramDIE(SP);
 655   else if (auto *T = dyn_cast<DIType>(Entity))
 656     EntityDie = getOrCreateTypeDIE(T);
 657   else if (auto *GV = dyn_cast<DIGlobalVariable>(Entity))
 658     EntityDie = getOrCreateGlobalVariableDIE(GV, {});
 659   else
 660     EntityDie = getDIE(Entity);
 661   assert(EntityDie);
 662   addSourceLine(*IMDie, Module->getLine(), Module->getScope()->getFilename(),
 663                 Module->getScope()->getDirectory());
 664   addDIEEntry(*IMDie, dwarf::DW_AT_import, *EntityDie);
 665   StringRef Name = Module->getName();
 666   if (!Name.empty())
 667     addString(*IMDie, dwarf::DW_AT_name, Name);
 668
 669   return IMDie;
 670 }
 671
 672 void DwarfCompileUnit::finishSubprogramDefinition(const DISubprogram *SP) {
 673   DIE *D = getDIE(SP);
 674   if (DIE *AbsSPDIE = DU->getAbstractSPDies().lookup(SP)) {
 675     if (D)
 676       // If this subprogram has an abstract definition, reference that
 677       addDIEEntry(*D, dwarf::DW_AT_abstract_origin, *AbsSPDIE);
 678   } else {
 679     assert(D || includeMinimalInlineScopes());
 680     if (D)
 681       // And attach the attributes
 682       applySubprogramAttributesToDefinition(SP, *D);
 683   }
 684 }
 685
 686 void DwarfCompileUnit::emitHeader(bool UseOffsets) {
 687   // Don't bother labeling the .dwo unit, as its offset isn't used.
 688   if (!Skeleton) {
 689     LabelBegin = Asm->createTempSymbol("cu_begin");
 690     Asm->OutStreamer->EmitLabel(LabelBegin);
 691   }
 692
 693   DwarfUnit::emitHeader(UseOffsets);
 694 }
 695
 696 /// addGlobalName - Add a new global name to the compile unit.
 697 void DwarfCompileUnit::addGlobalName(StringRef Name, DIE &Die,
 698                                      const DIScope *Context) {
 699   if (includeMinimalInlineScopes())
 700     return;
 701   std::string FullName = getParentContextString(Context) + Name.str();
 702   GlobalNames[FullName] = &Die;
 703 }
 704
 705 /// Add a new global type to the unit.
 706 void DwarfCompileUnit::addGlobalType(const DIType *Ty, const DIE &Die,
 707                                      const DIScope *Context) {
 708   if (includeMinimalInlineScopes())
 709     return;
 710   std::string FullName = getParentContextString(Context) + Ty->getName().str();
 711   GlobalTypes[FullName] = &Die;
 712 }
 713
 714 /// addVariableAddress - Add DW_AT_location attribute for a
 715 /// DbgVariable based on provided MachineLocation.
 716 void DwarfCompileUnit::addVariableAddress(const DbgVariable &DV, DIE &Die,
 717                                           MachineLocation Location) {
 718   if (DV.hasComplexAddress())
 719     addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
 720   else if (DV.isBlockByrefVariable())
 721     addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
 722   else
 723     addAddress(Die, dwarf::DW_AT_location, Location);
 724 }
 725
 726 /// Add an address attribute to a die based on the location provided.
 727 void DwarfCompileUnit::addAddress(DIE &Die, dwarf::Attribute Attribute,
 728                                   const MachineLocation &Location) {
 729   DIELoc *Loc = new (DIEValueAllocator) DIELoc;
 730   DIEDwarfExpression Expr(*Asm, *this, *Loc);
 731
 732   bool validReg;
 733   if (Location.isReg())
 734     validReg = Expr.AddMachineReg(*Asm->MF->getSubtarget().getRegisterInfo(),
 735                                   Location.getReg());
 736   else
 737     validReg =
 738         Expr.AddMachineRegIndirect(*Asm->MF->getSubtarget().getRegisterInfo(),
 739                                    Location.getReg(), Location.getOffset());
 740
 741   if (!validReg)
 742     return;
 743
 744   // Now attach the location information to the DIE.
 745   addBlock(Die, Attribute, Expr.finalize());
 746 }
 747
 748 /// Start with the address based on the location provided, and generate the
 749 /// DWARF information necessary to find the actual variable given the extra
 750 /// address information encoded in the DbgVariable, starting from the starting
 751 /// location.  Add the DWARF information to the die.
 752 void DwarfCompileUnit::addComplexAddress(const DbgVariable &DV, DIE &Die,
 753                                          dwarf::Attribute Attribute,
 754                                          const MachineLocation &Location) {
 755   DIELoc *Loc = new (DIEValueAllocator) DIELoc;
 756   DIEDwarfExpression DwarfExpr(*Asm, *this, *Loc);
 757   const DIExpression *Expr = DV.getSingleExpression();
 758   DIExpressionCursor ExprCursor(Expr);
 759   const TargetRegisterInfo &TRI = *Asm->MF->getSubtarget().getRegisterInfo();
 760   auto Reg = Location.getReg();
 761   DwarfExpr.addFragmentOffset(Expr);
 762   bool ValidReg =
 763       Location.getOffset()
 764           ? DwarfExpr.AddMachineRegIndirect(TRI, Reg, Location.getOffset())
 765           : DwarfExpr.AddMachineRegExpression(TRI, ExprCursor, Reg);
 766
 767   if (!ValidReg)
 768     return;
 769
 770   DwarfExpr.AddExpression(std::move(ExprCursor));
 771
 772   // Now attach the location information to the DIE.
 773   addBlock(Die, Attribute, Loc);
 774 }
 775
 776 /// Add a Dwarf loclistptr attribute data and value.
 777 void DwarfCompileUnit::addLocationList(DIE &Die, dwarf::Attribute Attribute,
 778                                        unsigned Index) {
 779   dwarf::Form Form = DD->getDwarfVersion() >= 4 ? dwarf::DW_FORM_sec_offset
 780                                                 : dwarf::DW_FORM_data4;
 781   Die.addValue(DIEValueAllocator, Attribute, Form, DIELocList(Index));
 782 }
 783
 784 void DwarfCompileUnit::applyVariableAttributes(const DbgVariable &Var,
 785                                                DIE &VariableDie) {
 786   StringRef Name = Var.getName();
 787   if (!Name.empty())
 788     addString(VariableDie, dwarf::DW_AT_name, Name);
 789   const auto *DIVar = Var.getVariable();
 790   if (DIVar)
 791     if (uint32_t AlignInBytes = DIVar->getAlignInBytes())
 792       addUInt(VariableDie, dwarf::DW_AT_alignment, dwarf::DW_FORM_udata,
 793               AlignInBytes);
 794
 795   addSourceLine(VariableDie, DIVar);
 796   addType(VariableDie, Var.getType());
 797   if (Var.isArtificial())
 798     addFlag(VariableDie, dwarf::DW_AT_artificial);
 799 }
 800
 801 /// Add a Dwarf expression attribute data and value.
 802 void DwarfCompileUnit::addExpr(DIELoc &Die, dwarf::Form Form,
 803                                const MCExpr *Expr) {
 804   Die.addValue(DIEValueAllocator, (dwarf::Attribute)0, Form, DIEExpr(Expr));
 805 }
 806
 807 void DwarfCompileUnit::applySubprogramAttributesToDefinition(
 808     const DISubprogram *SP, DIE &SPDie) {
 809   auto *SPDecl = SP->getDeclaration();
 810   auto *Context = resolve(SPDecl ? SPDecl->getScope() : SP->getScope());
 811   applySubprogramAttributes(SP, SPDie, includeMinimalInlineScopes());
 812   addGlobalName(SP->getName(), SPDie, Context);
 813 }
 814
 815 bool DwarfCompileUnit::isDwoUnit() const {
 816   return DD->useSplitDwarf() && Skeleton;
 817 }
 818
 819 bool DwarfCompileUnit::includeMinimalInlineScopes() const {
 820   return getCUNode()->getEmissionKind() == DICompileUnit::LineTablesOnly ||
 821          (DD->useSplitDwarf() && !Skeleton);
 822 }
 823 } // end llvm namespace