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 MDCompileUnit *Node,
  20                                    AsmPrinter *A, DwarfDebug *DW,
  21                                    DwarfFile *DWU)
  22     : DwarfUnit(UID, dwarf::DW_TAG_compile_unit, Node, A, DW, DWU),
  23       Skeleton(nullptr), BaseAddress(nullptr) {
  24   insertDIE(Node, &getUnitDie());
  25 }
  26
  27 /// addLabelAddress - Add a dwarf label attribute data and value using
  28 /// DW_FORM_addr or DW_FORM_GNU_addr_index.
  29 ///
  30 void DwarfCompileUnit::addLabelAddress(DIE &Die, dwarf::Attribute Attribute,
  31                                        const MCSymbol *Label) {
  32
  33   // Don't use the address pool in non-fission or in the skeleton unit itself.
  34   // FIXME: Once GDB supports this, it's probably worthwhile using the address
  35   // pool from the skeleton - maybe even in non-fission (possibly fewer
  36   // relocations by sharing them in the pool, but we have other ideas about how
  37   // to reduce the number of relocations as well/instead).
  38   if (!DD->useSplitDwarf() || !Skeleton)
  39     return addLocalLabelAddress(Die, Attribute, Label);
  40
  41   if (Label)
  42     DD->addArangeLabel(SymbolCU(this, Label));
  43
  44   unsigned idx = DD->getAddressPool().getIndex(Label);
  45   DIEValue *Value = new (DIEValueAllocator) DIEInteger(idx);
  46   Die.addValue(Attribute, dwarf::DW_FORM_GNU_addr_index, Value);
  47 }
  48
  49 void DwarfCompileUnit::addLocalLabelAddress(DIE &Die,
  50                                             dwarf::Attribute Attribute,
  51                                             const MCSymbol *Label) {
  52   if (Label)
  53     DD->addArangeLabel(SymbolCU(this, Label));
  54
  55   Die.addValue(Attribute, dwarf::DW_FORM_addr,
  56                Label ? (DIEValue *)new (DIEValueAllocator) DIELabel(Label)
  57                      : new (DIEValueAllocator) DIEInteger(0));
  58 }
  59
  60 unsigned DwarfCompileUnit::getOrCreateSourceID(StringRef FileName,
  61                                                StringRef DirName) {
  62   // If we print assembly, we can't separate .file entries according to
  63   // compile units. Thus all files will belong to the default compile unit.
  64
  65   // FIXME: add a better feature test than hasRawTextSupport. Even better,
  66   // extend .file to support this.
  67   return Asm->OutStreamer.EmitDwarfFileDirective(
  68       0, DirName, FileName,
  69       Asm->OutStreamer.hasRawTextSupport() ? 0 : getUniqueID());
  70 }
  71
  72 // Return const expression if value is a GEP to access merged global
  73 // constant. e.g.
  74 // i8* getelementptr ({ i8, i8, i8, i8 }* @_MergedGlobals, i32 0, i32 0)
  75 static const ConstantExpr *getMergedGlobalExpr(const Value *V) {
  76   const ConstantExpr *CE = dyn_cast_or_null<ConstantExpr>(V);
  77   if (!CE || CE->getNumOperands() != 3 ||
  78       CE->getOpcode() != Instruction::GetElementPtr)
  79     return nullptr;
  80
  81   // First operand points to a global struct.
  82   Value *Ptr = CE->getOperand(0);
  83   if (!isa<GlobalValue>(Ptr) ||
  84       !isa<StructType>(cast<PointerType>(Ptr->getType())->getElementType()))
  85     return nullptr;
  86
  87   // Second operand is zero.
  88   const ConstantInt *CI = dyn_cast_or_null<ConstantInt>(CE->getOperand(1));
  89   if (!CI || !CI->isZero())
  90     return nullptr;
  91
  92   // Third operand is offset.
  93   if (!isa<ConstantInt>(CE->getOperand(2)))
  94     return nullptr;
  95
  96   return CE;
  97 }
  98
  99 /// getOrCreateGlobalVariableDIE - get or create global variable DIE.
 100 DIE *DwarfCompileUnit::getOrCreateGlobalVariableDIE(DIGlobalVariable GV) {
 101   // Check for pre-existence.
 102   if (DIE *Die = getDIE(GV))
 103     return Die;
 104
 105   assert(GV);
 106
 107   auto *GVContext = GV->getScope();
 108   auto *GTy = DD->resolve(GV->getType());
 109
 110   // Construct the context before querying for the existence of the DIE in
 111   // case such construction creates the DIE.
 112   DIE *ContextDIE = getOrCreateContextDIE(GVContext);
 113
 114   // Add to map.
 115   DIE *VariableDIE = &createAndAddDIE(GV->getTag(), *ContextDIE, GV);
 116   MDScope *DeclContext;
 117   if (auto *SDMDecl = GV->getStaticDataMemberDeclaration()) {
 118     DeclContext = resolve(SDMDecl->getScope());
 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->getScope();
 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   else
 141     addGlobalName(GV->getName(), *VariableDIE, DeclContext);
 142
 143   // Add location.
 144   bool addToAccelTable = false;
 145   if (auto *Global = dyn_cast_or_null<GlobalVariable>(GV->getVariable())) {
 146     addToAccelTable = true;
 147     DIELoc *Loc = new (DIEValueAllocator) DIELoc();
 148     const MCSymbol *Sym = Asm->getSymbol(Global);
 149     if (Global->isThreadLocal()) {
 150       // FIXME: Make this work with -gsplit-dwarf.
 151       unsigned PointerSize = Asm->getDataLayout().getPointerSize();
 152       assert((PointerSize == 4 || PointerSize == 8) &&
 153              "Add support for other sizes if necessary");
 154       // Based on GCC's support for TLS:
 155       if (!DD->useSplitDwarf()) {
 156         // 1) Start with a constNu of the appropriate pointer size
 157         addUInt(*Loc, dwarf::DW_FORM_data1,
 158                 PointerSize == 4 ? dwarf::DW_OP_const4u : dwarf::DW_OP_const8u);
 159         // 2) containing the (relocated) offset of the TLS variable
 160         //    within the module's TLS block.
 161         addExpr(*Loc, dwarf::DW_FORM_udata,
 162                 Asm->getObjFileLowering().getDebugThreadLocalSymbol(Sym));
 163       } else {
 164         addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_const_index);
 165         addUInt(*Loc, dwarf::DW_FORM_udata,
 166                 DD->getAddressPool().getIndex(Sym, /* TLS */ true));
 167       }
 168       // 3) followed by an OP to make the debugger do a TLS lookup.
 169       addUInt(*Loc, dwarf::DW_FORM_data1,
 170               DD->useGNUTLSOpcode() ? dwarf::DW_OP_GNU_push_tls_address
 171                                     : dwarf::DW_OP_form_tls_address);
 172     } else {
 173       DD->addArangeLabel(SymbolCU(this, Sym));
 174       addOpAddress(*Loc, Sym);
 175     }
 176
 177     addBlock(*VariableDIE, dwarf::DW_AT_location, Loc);
 178     addLinkageName(*VariableDIE, GV->getLinkageName());
 179   } else if (const ConstantInt *CI =
 180                  dyn_cast_or_null<ConstantInt>(GV->getVariable())) {
 181     addConstantValue(*VariableDIE, CI, GTy);
 182   } else if (const ConstantExpr *CE = getMergedGlobalExpr(GV->getVariable())) {
 183     addToAccelTable = true;
 184     // GV is a merged global.
 185     DIELoc *Loc = new (DIEValueAllocator) DIELoc();
 186     Value *Ptr = CE->getOperand(0);
 187     MCSymbol *Sym = Asm->getSymbol(cast<GlobalValue>(Ptr));
 188     DD->addArangeLabel(SymbolCU(this, Sym));
 189     addOpAddress(*Loc, Sym);
 190     addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
 191     SmallVector<Value *, 3> Idx(CE->op_begin() + 1, CE->op_end());
 192     addUInt(*Loc, dwarf::DW_FORM_udata,
 193             Asm->getDataLayout().getIndexedOffset(Ptr->getType(), Idx));
 194     addUInt(*Loc, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
 195     addBlock(*VariableDIE, dwarf::DW_AT_location, Loc);
 196   }
 197
 198   if (addToAccelTable) {
 199     DD->addAccelName(GV->getName(), *VariableDIE);
 200
 201     // If the linkage name is different than the name, go ahead and output
 202     // that as well into the name table.
 203     if (GV->getLinkageName() != "" && GV->getName() != GV->getLinkageName())
 204       DD->addAccelName(GV->getLinkageName(), *VariableDIE);
 205   }
 206
 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(const MDSubprogram *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   auto *DS = Scope->getScopeNode();
 309
 310   assert((Scope->getInlinedAt() || !isa<MDSubprogram>(DS)) &&
 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() && isa<MDSubprogram>(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 &E : DD->findImportedEntitiesForScope(DS))
 342         Children.push_back(
 343             constructImportedEntityDIE(cast<MDImportedEntity>(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   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 = 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   const MDLocation *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
 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.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       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)->expr_op_begin(), (*Expr)->expr_op_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   auto *Sub = cast<MDSubprogram>(Scope->getScopeNode());
 566
 567   DD->getProcessedSPNodes().insert(Sub);
 568
 569   DIE &ScopeDIE = updateSubprogramScopeDIE(Sub);
 570
 571   // If this is a variadic function, add an unspecified parameter.
 572   DITypeArray FnArgs = Sub->getType()->getTypeArray();
 573
 574   // Collect lexical scope children first.
 575   // ObjectPointer might be a local (non-argument) local variable if it's a
 576   // block's synthetic this pointer.
 577   if (DIE *ObjectPointer = createAndAddScopeChildren(Scope, ScopeDIE))
 578     addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer, *ObjectPointer);
 579
 580   // If we have a single element of null, it is a function that returns void.
 581   // If we have more than one elements and the last one is null, it is a
 582   // variadic function.
 583   if (FnArgs.size() > 1 && !FnArgs[FnArgs.size() - 1] &&
 584       !includeMinimalInlineScopes())
 585     ScopeDIE.addChild(make_unique<DIE>(dwarf::DW_TAG_unspecified_parameters));
 586 }
 587
 588 DIE *DwarfCompileUnit::createAndAddScopeChildren(LexicalScope *Scope,
 589                                                  DIE &ScopeDIE) {
 590   // We create children when the scope DIE is not null.
 591   SmallVector<std::unique_ptr<DIE>, 8> Children;
 592   DIE *ObjectPointer = createScopeChildrenDIE(Scope, Children);
 593
 594   // Add children
 595   for (auto &I : Children)
 596     ScopeDIE.addChild(std::move(I));
 597
 598   return ObjectPointer;
 599 }
 600
 601 void
 602 DwarfCompileUnit::constructAbstractSubprogramScopeDIE(LexicalScope *Scope) {
 603   DIE *&AbsDef = DU->getAbstractSPDies()[Scope->getScopeNode()];
 604   if (AbsDef)
 605     return;
 606
 607   auto *SP = cast<MDSubprogram>(Scope->getScopeNode());
 608
 609   DIE *ContextDIE;
 610
 611   if (includeMinimalInlineScopes())
 612     ContextDIE = &getUnitDie();
 613   // Some of this is duplicated from DwarfUnit::getOrCreateSubprogramDIE, with
 614   // the important distinction that the debug node is not associated with the
 615   // DIE (since the debug node will be associated with the concrete DIE, if
 616   // any). It could be refactored to some common utility function.
 617   else if (auto *SPDecl = SP->getDeclaration()) {
 618     ContextDIE = &getUnitDie();
 619     getOrCreateSubprogramDIE(SPDecl);
 620   } else
 621     ContextDIE = getOrCreateContextDIE(resolve(SP->getScope()));
 622
 623   // Passing null as the associated node because the abstract definition
 624   // shouldn't be found by lookup.
 625   AbsDef = &createAndAddDIE(dwarf::DW_TAG_subprogram, *ContextDIE, nullptr);
 626   applySubprogramAttributesToDefinition(SP, *AbsDef);
 627
 628   if (!includeMinimalInlineScopes())
 629     addUInt(*AbsDef, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
 630   if (DIE *ObjectPointer = createAndAddScopeChildren(Scope, *AbsDef))
 631     addDIEEntry(*AbsDef, dwarf::DW_AT_object_pointer, *ObjectPointer);
 632 }
 633
 634 std::unique_ptr<DIE>
 635 DwarfCompileUnit::constructImportedEntityDIE(const DIImportedEntity &Module) {
 636   std::unique_ptr<DIE> IMDie = make_unique<DIE>((dwarf::Tag)Module->getTag());
 637   insertDIE(Module, IMDie.get());
 638   DIE *EntityDie;
 639   auto *Entity = resolve(Module->getEntity());
 640   if (auto *NS = dyn_cast<MDNamespace>(Entity))
 641     EntityDie = getOrCreateNameSpace(NS);
 642   else if (auto *SP = dyn_cast<MDSubprogram>(Entity))
 643     EntityDie = getOrCreateSubprogramDIE(SP);
 644   else if (auto *T = dyn_cast<MDType>(Entity))
 645     EntityDie = getOrCreateTypeDIE(T);
 646   else if (auto *GV = dyn_cast<MDGlobalVariable>(Entity))
 647     EntityDie = getOrCreateGlobalVariableDIE(GV);
 648   else
 649     EntityDie = getDIE(Entity);
 650   assert(EntityDie);
 651   addSourceLine(*IMDie, Module->getLine(), Module->getScope()->getFilename(),
 652                 Module->getScope()->getDirectory());
 653   addDIEEntry(*IMDie, dwarf::DW_AT_import, *EntityDie);
 654   StringRef Name = Module->getName();
 655   if (!Name.empty())
 656     addString(*IMDie, dwarf::DW_AT_name, Name);
 657
 658   return IMDie;
 659 }
 660
 661 void DwarfCompileUnit::finishSubprogramDefinition(const MDSubprogram *SP) {
 662   DIE *D = getDIE(SP);
 663   if (DIE *AbsSPDIE = DU->getAbstractSPDies().lookup(SP)) {
 664     if (D)
 665       // If this subprogram has an abstract definition, reference that
 666       addDIEEntry(*D, dwarf::DW_AT_abstract_origin, *AbsSPDIE);
 667   } else {
 668     if (!D && !includeMinimalInlineScopes())
 669       // Lazily construct the subprogram if we didn't see either concrete or
 670       // inlined versions during codegen. (except in -gmlt ^ where we want
 671       // to omit these entirely)
 672       D = getOrCreateSubprogramDIE(SP);
 673     if (D)
 674       // And attach the attributes
 675       applySubprogramAttributesToDefinition(SP, *D);
 676   }
 677 }
 678 void DwarfCompileUnit::collectDeadVariables(const MDSubprogram *SP) {
 679   assert(SP && "CU's subprogram list contains a non-subprogram");
 680   assert(SP->isDefinition() &&
 681          "CU's subprogram list contains a subprogram declaration");
 682   auto Variables = SP->getVariables();
 683   if (Variables.size() == 0)
 684     return;
 685
 686   DIE *SPDIE = DU->getAbstractSPDies().lookup(SP);
 687   if (!SPDIE)
 688     SPDIE = getDIE(SP);
 689   assert(SPDIE);
 690   for (DIVariable DV : Variables) {
 691     DbgVariable NewVar(DV, nullptr, DIExpression(), DD);
 692     auto VariableDie = constructVariableDIE(NewVar);
 693     applyVariableAttributes(NewVar, *VariableDie);
 694     SPDIE->addChild(std::move(VariableDie));
 695   }
 696 }
 697
 698 void DwarfCompileUnit::emitHeader(bool UseOffsets) {
 699   // Don't bother labeling the .dwo unit, as its offset isn't used.
 700   if (!Skeleton) {
 701     LabelBegin = Asm->createTempSymbol("cu_begin");
 702     Asm->OutStreamer.EmitLabel(LabelBegin);
 703   }
 704
 705   DwarfUnit::emitHeader(UseOffsets);
 706 }
 707
 708 /// addGlobalName - Add a new global name to the compile unit.
 709 void DwarfCompileUnit::addGlobalName(StringRef Name, DIE &Die,
 710                                      const MDScope *Context) {
 711   if (includeMinimalInlineScopes())
 712     return;
 713   std::string FullName = getParentContextString(Context) + Name.str();
 714   GlobalNames[FullName] = &Die;
 715 }
 716
 717 /// Add a new global type to the unit.
 718 void DwarfCompileUnit::addGlobalType(const MDType *Ty, const DIE &Die,
 719                                      const MDScope *Context) {
 720   if (includeMinimalInlineScopes())
 721     return;
 722   std::string FullName = getParentContextString(Context) + Ty->getName().str();
 723   GlobalTypes[FullName] = &Die;
 724 }
 725
 726 /// addVariableAddress - Add DW_AT_location attribute for a
 727 /// DbgVariable based on provided MachineLocation.
 728 void DwarfCompileUnit::addVariableAddress(const DbgVariable &DV, DIE &Die,
 729                                           MachineLocation Location) {
 730   if (DV.variableHasComplexAddress())
 731     addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
 732   else if (DV.isBlockByrefVariable())
 733     addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
 734   else
 735     addAddress(Die, dwarf::DW_AT_location, Location);
 736 }
 737
 738 /// Add an address attribute to a die based on the location provided.
 739 void DwarfCompileUnit::addAddress(DIE &Die, dwarf::Attribute Attribute,
 740                                   const MachineLocation &Location) {
 741   DIELoc *Loc = new (DIEValueAllocator) DIELoc();
 742
 743   bool validReg;
 744   if (Location.isReg())
 745     validReg = addRegisterOpPiece(*Loc, Location.getReg());
 746   else
 747     validReg = addRegisterOffset(*Loc, Location.getReg(), Location.getOffset());
 748
 749   if (!validReg)
 750     return;
 751
 752   // Now attach the location information to the DIE.
 753   addBlock(Die, Attribute, Loc);
 754 }
 755
 756 /// Start with the address based on the location provided, and generate the
 757 /// DWARF information necessary to find the actual variable given the extra
 758 /// address information encoded in the DbgVariable, starting from the starting
 759 /// location.  Add the DWARF information to the die.
 760 void DwarfCompileUnit::addComplexAddress(const DbgVariable &DV, DIE &Die,
 761                                          dwarf::Attribute Attribute,
 762                                          const MachineLocation &Location) {
 763   DIELoc *Loc = new (DIEValueAllocator) DIELoc();
 764   DIEDwarfExpression DwarfExpr(*Asm, *this, *Loc);
 765   assert(DV.getExpression().size() == 1);
 766   DIExpression Expr = DV.getExpression().back();
 767   bool ValidReg;
 768   if (Location.getOffset()) {
 769     ValidReg = DwarfExpr.AddMachineRegIndirect(Location.getReg(),
 770                                                Location.getOffset());
 771     if (ValidReg)
 772       DwarfExpr.AddExpression(Expr->expr_op_begin(), Expr->expr_op_end());
 773   } else
 774     ValidReg = DwarfExpr.AddMachineRegExpression(Expr, Location.getReg());
 775
 776   // Now attach the location information to the DIE.
 777   if (ValidReg)
 778     addBlock(Die, Attribute, Loc);
 779 }
 780
 781 /// Add a Dwarf loclistptr attribute data and value.
 782 void DwarfCompileUnit::addLocationList(DIE &Die, dwarf::Attribute Attribute,
 783                                        unsigned Index) {
 784   DIEValue *Value = new (DIEValueAllocator) DIELocList(Index);
 785   dwarf::Form Form = DD->getDwarfVersion() >= 4 ? dwarf::DW_FORM_sec_offset
 786                                                 : dwarf::DW_FORM_data4;
 787   Die.addValue(Attribute, Form, Value);
 788 }
 789
 790 void DwarfCompileUnit::applyVariableAttributes(const DbgVariable &Var,
 791                                                DIE &VariableDie) {
 792   StringRef Name = Var.getName();
 793   if (!Name.empty())
 794     addString(VariableDie, dwarf::DW_AT_name, Name);
 795   addSourceLine(VariableDie, Var.getVariable());
 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   DIEValue *Value = new (DIEValueAllocator) DIEExpr(Expr);
 805   Die.addValue((dwarf::Attribute)0, Form, Value);
 806 }
 807
 808 void DwarfCompileUnit::applySubprogramAttributesToDefinition(
 809     const MDSubprogram *SP, DIE &SPDie) {
 810   auto *SPDecl = SP->getDeclaration();
 811   auto *Context = resolve(SPDecl ? SPDecl->getScope() : SP->getScope());
 812   applySubprogramAttributes(SP, SPDie, includeMinimalInlineScopes());
 813   addGlobalName(SP->getName(), SPDie, Context);
 814 }
 815
 816 bool DwarfCompileUnit::isDwoUnit() const {
 817   return DD->useSplitDwarf() && Skeleton;
 818 }
 819
 820 bool DwarfCompileUnit::includeMinimalInlineScopes() const {
 821   return getCUNode()->getEmissionKind() == DIBuilder::LineTablesOnly ||
 822          (DD->useSplitDwarf() && !Skeleton);
 823 }
 824 } // end llvm namespace