lib/IR/DebugInfo.cpp

   1 //===--- DebugInfo.cpp - Debug Information Helper Classes -----------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the helper classes used to build and interpret debug
  11 // information in LLVM IR form.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/IR/DebugInfo.h"
  16 #include "LLVMContextImpl.h"
  17 #include "llvm/ADT/STLExtras.h"
  18 #include "llvm/ADT/SmallPtrSet.h"
  19 #include "llvm/ADT/SmallString.h"
  20 #include "llvm/ADT/StringSwitch.h"
  21 #include "llvm/Analysis/ValueTracking.h"
  22 #include "llvm/IR/Constants.h"
  23 #include "llvm/IR/DIBuilder.h"
  24 #include "llvm/IR/DerivedTypes.h"
  25 #include "llvm/IR/Instructions.h"
  26 #include "llvm/IR/IntrinsicInst.h"
  27 #include "llvm/IR/Intrinsics.h"
  28 #include "llvm/IR/GVMaterializer.h"
  29 #include "llvm/IR/Module.h"
  30 #include "llvm/IR/ValueHandle.h"
  31 #include "llvm/Support/Debug.h"
  32 #include "llvm/Support/Dwarf.h"
  33 #include "llvm/Support/raw_ostream.h"
  34 using namespace llvm;
  35 using namespace llvm::dwarf;
  36
  37 //===----------------------------------------------------------------------===//
  38 // DIDescriptor
  39 //===----------------------------------------------------------------------===//
  40
  41 unsigned DIDescriptor::getFlag(StringRef Flag) {
  42   return StringSwitch<unsigned>(Flag)
  43 #define HANDLE_DI_FLAG(ID, NAME) .Case("DIFlag" #NAME, Flag##NAME)
  44 #include "llvm/IR/DebugInfoFlags.def"
  45       .Default(0);
  46 }
  47
  48 const char *DIDescriptor::getFlagString(unsigned Flag) {
  49   switch (Flag) {
  50   default:
  51     return "";
  52 #define HANDLE_DI_FLAG(ID, NAME)                                               \
  53   case Flag##NAME:                                                             \
  54     return "DIFlag" #NAME;
  55 #include "llvm/IR/DebugInfoFlags.def"
  56   }
  57 }
  58
  59 unsigned DIDescriptor::splitFlags(unsigned Flags,
  60                                   SmallVectorImpl<unsigned> &SplitFlags) {
  61   // Accessibility flags need to be specially handled, since they're packed
  62   // together.
  63   if (unsigned A = Flags & FlagAccessibility) {
  64     if (A == FlagPrivate)
  65       SplitFlags.push_back(FlagPrivate);
  66     else if (A == FlagProtected)
  67       SplitFlags.push_back(FlagProtected);
  68     else
  69       SplitFlags.push_back(FlagPublic);
  70     Flags &= ~A;
  71   }
  72
  73 #define HANDLE_DI_FLAG(ID, NAME)                                               \
  74   if (unsigned Bit = Flags & ID) {                                             \
  75     SplitFlags.push_back(Bit);                                                 \
  76     Flags &= ~Bit;                                                             \
  77   }
  78 #include "llvm/IR/DebugInfoFlags.def"
  79
  80   return Flags;
  81 }
  82
  83 static Metadata *getField(const MDNode *DbgNode, unsigned Elt) {
  84   if (!DbgNode || Elt >= DbgNode->getNumOperands())
  85     return nullptr;
  86   return DbgNode->getOperand(Elt);
  87 }
  88
  89 static MDNode *getNodeField(const MDNode *DbgNode, unsigned Elt) {
  90   return dyn_cast_or_null<MDNode>(getField(DbgNode, Elt));
  91 }
  92
  93 DIDescriptor DIDescriptor::getDescriptorField(unsigned Elt) const {
  94   MDNode *Field = getNodeField(DbgNode, Elt);
  95   return DIDescriptor(Field);
  96 }
  97
  98 /// \brief Return the size reported by the variable's type.
  99 unsigned DIVariable::getSizeInBits(const DITypeIdentifierMap &Map) {
 100   DIType Ty = getType().resolve(Map);
 101   // Follow derived types until we reach a type that
 102   // reports back a size.
 103   while (isa<MDDerivedType>(Ty) && !Ty.getSizeInBits()) {
 104     DIDerivedType DT = cast<MDDerivedType>(Ty);
 105     Ty = DT.getTypeDerivedFrom().resolve(Map);
 106   }
 107   assert(Ty.getSizeInBits() && "type with size 0");
 108   return Ty.getSizeInBits();
 109 }
 110
 111 bool DIExpression::isBitPiece() const {
 112   unsigned N = getNumElements();
 113   return N >=3 && getElement(N-3) == dwarf::DW_OP_bit_piece;
 114 }
 115
 116 uint64_t DIExpression::getBitPieceOffset() const {
 117   assert(isBitPiece() && "not a piece");
 118   return getElement(getNumElements()-2);
 119 }
 120
 121 uint64_t DIExpression::getBitPieceSize() const {
 122   assert(isBitPiece() && "not a piece");
 123   return getElement(getNumElements()-1);
 124 }
 125
 126 DIExpression::iterator DIExpression::Operand::getNext() const {
 127   iterator it(I);
 128   return ++it;
 129 }
 130
 131 //===----------------------------------------------------------------------===//
 132 // Simple Descriptor Constructors and other Methods
 133 //===----------------------------------------------------------------------===//
 134
 135 void DIDescriptor::replaceAllUsesWith(LLVMContext &, DIDescriptor D) {
 136   assert(DbgNode && "Trying to replace an unverified type!");
 137   assert(DbgNode->isTemporary() && "Expected temporary node");
 138   TempMDNode Temp(get());
 139
 140   // Since we use a TrackingVH for the node, its easy for clients to manufacture
 141   // legitimate situations where they want to replaceAllUsesWith() on something
 142   // which, due to uniquing, has merged with the source. We shield clients from
 143   // this detail by allowing a value to be replaced with replaceAllUsesWith()
 144   // itself.
 145   if (Temp.get() == D.get()) {
 146     DbgNode = MDNode::replaceWithUniqued(std::move(Temp));
 147     return;
 148   }
 149
 150   Temp->replaceAllUsesWith(D.get());
 151   DbgNode = D.get();
 152 }
 153
 154 void DIDescriptor::replaceAllUsesWith(MDNode *D) {
 155   assert(DbgNode && "Trying to replace an unverified type!");
 156   assert(DbgNode != D && "This replacement should always happen");
 157   assert(DbgNode->isTemporary() && "Expected temporary node");
 158   TempMDNode Node(get());
 159   Node->replaceAllUsesWith(D);
 160 }
 161
 162 #ifndef NDEBUG
 163 /// \brief Check if a value can be a reference to a type.
 164 static bool isTypeRef(const Metadata *MD) {
 165   if (!MD)
 166     return true;
 167   if (auto *S = dyn_cast<MDString>(MD))
 168     return !S->getString().empty();
 169   return isa<MDType>(MD);
 170 }
 171
 172 /// \brief Check if a value can be a ScopeRef.
 173 static bool isScopeRef(const Metadata *MD) {
 174   if (!MD)
 175     return true;
 176   if (auto *S = dyn_cast<MDString>(MD))
 177     return !S->getString().empty();
 178   return isa<MDScope>(MD);
 179 }
 180
 181 /// \brief Check if a value can be a DescriptorRef.
 182 static bool isDescriptorRef(const Metadata *MD) {
 183   if (!MD)
 184     return true;
 185   if (auto *S = dyn_cast<MDString>(MD))
 186     return !S->getString().empty();
 187   return isa<MDNode>(MD);
 188 }
 189 #endif
 190
 191 void DICompositeType::setArraysHelper(MDNode *Elements, MDNode *TParams) {
 192   TypedTrackingMDRef<MDCompositeTypeBase> N(get());
 193   if (Elements)
 194     N->replaceElements(cast<MDTuple>(Elements));
 195   if (TParams)
 196     N->replaceTemplateParams(cast<MDTuple>(TParams));
 197   DbgNode = N;
 198 }
 199
 200 DIScopeRef DIScope::getRef() const { return MDScopeRef::get(get()); }
 201
 202 void DICompositeType::setContainingType(DICompositeType ContainingType) {
 203   TypedTrackingMDRef<MDCompositeTypeBase> N(get());
 204   N->replaceVTableHolder(MDTypeRef::get(ContainingType));
 205   DbgNode = N;
 206 }
 207
 208 bool DIVariable::isInlinedFnArgument(const Function *CurFn) {
 209   assert(CurFn && "Invalid function");
 210   DISubprogram SP = dyn_cast<MDSubprogram>(getContext());
 211   if (!SP)
 212     return false;
 213   // This variable is not inlined function argument if its scope
 214   // does not describe current function.
 215   return !SP.describes(CurFn);
 216 }
 217
 218 Function *DISubprogram::getFunction() const {
 219   if (auto *N = get())
 220     if (auto *C = dyn_cast_or_null<ConstantAsMetadata>(N->getFunction()))
 221       return dyn_cast<Function>(C->getValue());
 222   return nullptr;
 223 }
 224
 225 bool DISubprogram::describes(const Function *F) {
 226   assert(F && "Invalid function");
 227   if (F == getFunction())
 228     return true;
 229   StringRef Name = getLinkageName();
 230   if (Name.empty())
 231     Name = getName();
 232   if (F->getName() == Name)
 233     return true;
 234   return false;
 235 }
 236
 237 GlobalVariable *DIGlobalVariable::getGlobal() const {
 238   return dyn_cast_or_null<GlobalVariable>(getConstant());
 239 }
 240
 241 DIScopeRef DIScope::getContext() const {
 242   if (DIType T = dyn_cast<MDType>(*this))
 243     return T.getContext();
 244
 245   if (DISubprogram SP = dyn_cast<MDSubprogram>(*this))
 246     return DIScopeRef(SP.getContext());
 247
 248   if (DILexicalBlock LB = dyn_cast<MDLexicalBlockBase>(*this))
 249     return DIScopeRef(LB.getContext());
 250
 251   if (DINameSpace NS = dyn_cast<MDNamespace>(*this))
 252     return DIScopeRef(NS.getContext());
 253
 254   assert((isa<MDFile>(*this) || isa<MDCompileUnit>(*this)) &&
 255          "Unhandled type of scope.");
 256   return DIScopeRef(nullptr);
 257 }
 258
 259 StringRef DIScope::getName() const {
 260   if (DIType T = dyn_cast<MDType>(*this))
 261     return T.getName();
 262   if (DISubprogram SP = dyn_cast<MDSubprogram>(*this))
 263     return SP.getName();
 264   if (DINameSpace NS = dyn_cast<MDNamespace>(*this))
 265     return NS.getName();
 266   assert((isa<MDLexicalBlockBase>(*this) || isa<MDFile>(*this) ||
 267           isa<MDCompileUnit>(*this)) &&
 268          "Unhandled type of scope.");
 269   return StringRef();
 270 }
 271
 272 StringRef DIScope::getFilename() const {
 273   if (auto *N = get())
 274     if (auto *F = N->getFile())
 275       return F->getFilename();
 276   return "";
 277 }
 278
 279 StringRef DIScope::getDirectory() const {
 280   if (auto *N = get())
 281     if (auto *F = N->getFile())
 282       return F->getDirectory();
 283   return "";
 284 }
 285
 286 void DICompileUnit::replaceSubprograms(DIArray Subprograms) {
 287   get()->replaceSubprograms(cast_or_null<MDTuple>(Subprograms.get()));
 288 }
 289
 290 void DICompileUnit::replaceGlobalVariables(DIArray GlobalVariables) {
 291   get()->replaceGlobalVariables(cast_or_null<MDTuple>(GlobalVariables.get()));
 292 }
 293
 294 DILocation DILocation::copyWithNewScope(LLVMContext &Ctx,
 295                                         DILexicalBlockFile NewScope) {
 296   assert(NewScope && "Expected valid scope");
 297
 298   const auto *Old = cast<MDLocation>(DbgNode);
 299   return DILocation(MDLocation::get(Ctx, Old->getLine(), Old->getColumn(),
 300                                     NewScope, Old->getInlinedAt()));
 301 }
 302
 303 unsigned DILocation::computeNewDiscriminator(LLVMContext &Ctx) {
 304   std::pair<const char *, unsigned> Key(getFilename().data(), getLineNumber());
 305   return ++Ctx.pImpl->DiscriminatorTable[Key];
 306 }
 307
 308 DIVariable llvm::createInlinedVariable(MDNode *DV, MDNode *InlinedScope,
 309                                        LLVMContext &VMContext) {
 310   return cast<MDLocalVariable>(DV)
 311       ->withInline(cast_or_null<MDLocation>(InlinedScope));
 312 }
 313
 314 DIVariable llvm::cleanseInlinedVariable(MDNode *DV, LLVMContext &VMContext) {
 315   return cast<MDLocalVariable>(DV)->withoutInline();
 316 }
 317
 318 DISubprogram llvm::getDISubprogram(const MDNode *Scope) {
 319   if (auto *LocalScope = dyn_cast_or_null<MDLocalScope>(Scope))
 320     return LocalScope->getSubprogram();
 321   return nullptr;
 322 }
 323
 324 DISubprogram llvm::getDISubprogram(const Function *F) {
 325   // We look for the first instr that has a debug annotation leading back to F.
 326   for (auto &BB : *F) {
 327     auto Inst = std::find_if(BB.begin(), BB.end(), [](const Instruction &Inst) {
 328       return Inst.getDebugLoc();
 329     });
 330     if (Inst == BB.end())
 331       continue;
 332     DebugLoc DLoc = Inst->getDebugLoc();
 333     const MDNode *Scope = DLoc.getInlinedAtScope();
 334     DISubprogram Subprogram = getDISubprogram(Scope);
 335     return Subprogram.describes(F) ? Subprogram : DISubprogram();
 336   }
 337
 338   return DISubprogram();
 339 }
 340
 341 DICompositeType llvm::getDICompositeType(DIType T) {
 342   if (auto *C = dyn_cast_or_null<MDCompositeTypeBase>(T))
 343     return C;
 344
 345   if (auto *D = dyn_cast_or_null<MDDerivedTypeBase>(T)) {
 346     // This function is currently used by dragonegg and dragonegg does
 347     // not generate identifier for types, so using an empty map to resolve
 348     // DerivedFrom should be fine.
 349     DITypeIdentifierMap EmptyMap;
 350     return getDICompositeType(
 351         DIDerivedType(D).getTypeDerivedFrom().resolve(EmptyMap));
 352   }
 353
 354   return nullptr;
 355 }
 356
 357 DITypeIdentifierMap
 358 llvm::generateDITypeIdentifierMap(const NamedMDNode *CU_Nodes) {
 359   DITypeIdentifierMap Map;
 360   for (unsigned CUi = 0, CUe = CU_Nodes->getNumOperands(); CUi != CUe; ++CUi) {
 361     DICompileUnit CU = cast<MDCompileUnit>(CU_Nodes->getOperand(CUi));
 362     DIArray Retain = CU.getRetainedTypes();
 363     for (unsigned Ti = 0, Te = Retain.getNumElements(); Ti != Te; ++Ti) {
 364       if (!isa<MDCompositeType>(Retain.getElement(Ti)))
 365         continue;
 366       DICompositeType Ty = cast<MDCompositeType>(Retain.getElement(Ti));
 367       if (MDString *TypeId = Ty.getIdentifier()) {
 368         // Definition has priority over declaration.
 369         // Try to insert (TypeId, Ty) to Map.
 370         std::pair<DITypeIdentifierMap::iterator, bool> P =
 371             Map.insert(std::make_pair(TypeId, Ty));
 372         // If TypeId already exists in Map and this is a definition, replace
 373         // whatever we had (declaration or definition) with the definition.
 374         if (!P.second && !Ty.isForwardDecl())
 375           P.first->second = Ty;
 376       }
 377     }
 378   }
 379   return Map;
 380 }
 381
 382 //===----------------------------------------------------------------------===//
 383 // DebugInfoFinder implementations.
 384 //===----------------------------------------------------------------------===//
 385
 386 void DebugInfoFinder::reset() {
 387   CUs.clear();
 388   SPs.clear();
 389   GVs.clear();
 390   TYs.clear();
 391   Scopes.clear();
 392   NodesSeen.clear();
 393   TypeIdentifierMap.clear();
 394   TypeMapInitialized = false;
 395 }
 396
 397 void DebugInfoFinder::InitializeTypeMap(const Module &M) {
 398   if (!TypeMapInitialized)
 399     if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
 400       TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
 401       TypeMapInitialized = true;
 402     }
 403 }
 404
 405 void DebugInfoFinder::processModule(const Module &M) {
 406   InitializeTypeMap(M);
 407   if (NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu")) {
 408     for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
 409       DICompileUnit CU = cast<MDCompileUnit>(CU_Nodes->getOperand(i));
 410       addCompileUnit(CU);
 411       DIArray GVs = CU.getGlobalVariables();
 412       for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i) {
 413         DIGlobalVariable DIG = cast<MDGlobalVariable>(GVs.getElement(i));
 414         if (addGlobalVariable(DIG)) {
 415           processScope(DIG.getContext());
 416           processType(DIG.getType().resolve(TypeIdentifierMap));
 417         }
 418       }
 419       DIArray SPs = CU.getSubprograms();
 420       for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
 421         processSubprogram(cast<MDSubprogram>(SPs.getElement(i)));
 422       DIArray EnumTypes = CU.getEnumTypes();
 423       for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
 424         processType(cast<MDType>(EnumTypes.getElement(i)));
 425       DIArray RetainedTypes = CU.getRetainedTypes();
 426       for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
 427         processType(cast<MDType>(RetainedTypes.getElement(i)));
 428       DIArray Imports = CU.getImportedEntities();
 429       for (unsigned i = 0, e = Imports.getNumElements(); i != e; ++i) {
 430         DIImportedEntity Import = cast<MDImportedEntity>(Imports.getElement(i));
 431         DIDescriptor Entity = Import.getEntity().resolve(TypeIdentifierMap);
 432         if (auto *T = dyn_cast<MDType>(Entity))
 433           processType(T);
 434         else if (auto *SP = dyn_cast<MDSubprogram>(Entity))
 435           processSubprogram(SP);
 436         else if (auto *NS = dyn_cast<MDNamespace>(Entity))
 437           processScope(NS->getScope());
 438       }
 439     }
 440   }
 441 }
 442
 443 void DebugInfoFinder::processLocation(const Module &M, DILocation Loc) {
 444   if (!Loc)
 445     return;
 446   InitializeTypeMap(M);
 447   processScope(Loc.getScope());
 448   processLocation(M, Loc.getOrigLocation());
 449 }
 450
 451 void DebugInfoFinder::processType(DIType DT) {
 452   if (!addType(DT))
 453     return;
 454   processScope(DT.getContext().resolve(TypeIdentifierMap));
 455   if (DICompositeType DCT = dyn_cast<MDCompositeTypeBase>(DT)) {
 456     processType(DCT.getTypeDerivedFrom().resolve(TypeIdentifierMap));
 457     if (DISubroutineType ST = dyn_cast<MDSubroutineType>(DCT)) {
 458       DITypeArray DTA = ST.getTypeArray();
 459       for (unsigned i = 0, e = DTA.getNumElements(); i != e; ++i)
 460         processType(DTA.getElement(i).resolve(TypeIdentifierMap));
 461       return;
 462     }
 463     DIArray DA = DCT.getElements();
 464     for (unsigned i = 0, e = DA.getNumElements(); i != e; ++i) {
 465       DIDescriptor D = DA.getElement(i);
 466       if (DIType T = dyn_cast<MDType>(D))
 467         processType(T);
 468       else if (DISubprogram SP = dyn_cast<MDSubprogram>(D))
 469         processSubprogram(SP);
 470     }
 471   } else if (DIDerivedType DDT = dyn_cast<MDDerivedTypeBase>(DT)) {
 472     processType(DDT.getTypeDerivedFrom().resolve(TypeIdentifierMap));
 473   }
 474 }
 475
 476 void DebugInfoFinder::processScope(DIScope Scope) {
 477   if (!Scope)
 478     return;
 479   if (DIType Ty = dyn_cast<MDType>(Scope)) {
 480     processType(Ty);
 481     return;
 482   }
 483   if (DICompileUnit CU = dyn_cast<MDCompileUnit>(Scope)) {
 484     addCompileUnit(CU);
 485     return;
 486   }
 487   if (DISubprogram SP = dyn_cast<MDSubprogram>(Scope)) {
 488     processSubprogram(SP);
 489     return;
 490   }
 491   if (!addScope(Scope))
 492     return;
 493   if (DILexicalBlock LB = dyn_cast<MDLexicalBlockBase>(Scope)) {
 494     processScope(LB.getContext());
 495   } else if (DINameSpace NS = dyn_cast<MDNamespace>(Scope)) {
 496     processScope(NS.getContext());
 497   }
 498 }
 499
 500 void DebugInfoFinder::processSubprogram(DISubprogram SP) {
 501   if (!addSubprogram(SP))
 502     return;
 503   processScope(SP.getContext().resolve(TypeIdentifierMap));
 504   processType(SP.getType());
 505   DIArray TParams = SP.getTemplateParams();
 506   for (unsigned I = 0, E = TParams.getNumElements(); I != E; ++I) {
 507     DIDescriptor Element = TParams.getElement(I);
 508     if (DITemplateTypeParameter TType =
 509             dyn_cast<MDTemplateTypeParameter>(Element)) {
 510       processType(TType.getType().resolve(TypeIdentifierMap));
 511     } else if (DITemplateValueParameter TVal =
 512                    dyn_cast<MDTemplateValueParameter>(Element)) {
 513       processType(TVal.getType().resolve(TypeIdentifierMap));
 514     }
 515   }
 516 }
 517
 518 void DebugInfoFinder::processDeclare(const Module &M,
 519                                      const DbgDeclareInst *DDI) {
 520   MDNode *N = dyn_cast<MDNode>(DDI->getVariable());
 521   if (!N)
 522     return;
 523   InitializeTypeMap(M);
 524
 525   DIVariable DV = dyn_cast<MDLocalVariable>(N);
 526   if (!DV)
 527     return;
 528
 529   if (!NodesSeen.insert(DV).second)
 530     return;
 531   processScope(DV.getContext());
 532   processType(DV.getType().resolve(TypeIdentifierMap));
 533 }
 534
 535 void DebugInfoFinder::processValue(const Module &M, const DbgValueInst *DVI) {
 536   MDNode *N = dyn_cast<MDNode>(DVI->getVariable());
 537   if (!N)
 538     return;
 539   InitializeTypeMap(M);
 540
 541   DIVariable DV = dyn_cast<MDLocalVariable>(N);
 542   if (!DV)
 543     return;
 544
 545   if (!NodesSeen.insert(DV).second)
 546     return;
 547   processScope(DV.getContext());
 548   processType(DV.getType().resolve(TypeIdentifierMap));
 549 }
 550
 551 bool DebugInfoFinder::addType(DIType DT) {
 552   if (!DT)
 553     return false;
 554
 555   if (!NodesSeen.insert(DT).second)
 556     return false;
 557
 558   TYs.push_back(DT);
 559   return true;
 560 }
 561
 562 bool DebugInfoFinder::addCompileUnit(DICompileUnit CU) {
 563   if (!CU)
 564     return false;
 565   if (!NodesSeen.insert(CU).second)
 566     return false;
 567
 568   CUs.push_back(CU);
 569   return true;
 570 }
 571
 572 bool DebugInfoFinder::addGlobalVariable(DIGlobalVariable DIG) {
 573   if (!DIG)
 574     return false;
 575
 576   if (!NodesSeen.insert(DIG).second)
 577     return false;
 578
 579   GVs.push_back(DIG);
 580   return true;
 581 }
 582
 583 bool DebugInfoFinder::addSubprogram(DISubprogram SP) {
 584   if (!SP)
 585     return false;
 586
 587   if (!NodesSeen.insert(SP).second)
 588     return false;
 589
 590   SPs.push_back(SP);
 591   return true;
 592 }
 593
 594 bool DebugInfoFinder::addScope(DIScope Scope) {
 595   if (!Scope)
 596     return false;
 597   // FIXME: Ocaml binding generates a scope with no content, we treat it
 598   // as null for now.
 599   if (Scope->getNumOperands() == 0)
 600     return false;
 601   if (!NodesSeen.insert(Scope).second)
 602     return false;
 603   Scopes.push_back(Scope);
 604   return true;
 605 }
 606
 607 //===----------------------------------------------------------------------===//
 608 // DIDescriptor: dump routines for all descriptors.
 609 //===----------------------------------------------------------------------===//
 610
 611 void DIDescriptor::dump() const {
 612   print(dbgs());
 613   dbgs() << '\n';
 614 }
 615
 616 void DIDescriptor::print(raw_ostream &OS) const {
 617   if (!get())
 618     return;
 619   get()->print(OS);
 620 }
 621
 622 static void printDebugLoc(DebugLoc DL, raw_ostream &CommentOS,
 623                           const LLVMContext &Ctx) {
 624   if (!DL)
 625     return;
 626
 627   DIScope Scope = cast<MDScope>(DL.getScope());
 628   // Omit the directory, because it's likely to be long and uninteresting.
 629   CommentOS << Scope.getFilename();
 630   CommentOS << ':' << DL.getLine();
 631   if (DL.getCol() != 0)
 632     CommentOS << ':' << DL.getCol();
 633
 634   DebugLoc InlinedAtDL = DL.getInlinedAt();
 635   if (!InlinedAtDL)
 636     return;
 637
 638   CommentOS << " @[ ";
 639   printDebugLoc(InlinedAtDL, CommentOS, Ctx);
 640   CommentOS << " ]";
 641 }
 642
 643 void DIVariable::printExtendedName(raw_ostream &OS) const {
 644   const LLVMContext &Ctx = DbgNode->getContext();
 645   StringRef Res = getName();
 646   if (!Res.empty())
 647     OS << Res << "," << getLineNumber();
 648   if (auto *InlinedAt = get()->getInlinedAt()) {
 649     if (DebugLoc InlinedAtDL = InlinedAt) {
 650       OS << " @[";
 651       printDebugLoc(InlinedAtDL, OS, Ctx);
 652       OS << "]";
 653     }
 654   }
 655 }
 656
 657 template <> DIRef<DIDescriptor>::DIRef(const Metadata *V) : Val(V) {
 658   assert(isDescriptorRef(V) &&
 659          "DIDescriptorRef should be a MDString or MDNode");
 660 }
 661 template <> DIRef<DIScope>::DIRef(const Metadata *V) : Val(V) {
 662   assert(isScopeRef(V) && "DIScopeRef should be a MDString or MDNode");
 663 }
 664 template <> DIRef<DIType>::DIRef(const Metadata *V) : Val(V) {
 665   assert(isTypeRef(V) && "DITypeRef should be a MDString or MDNode");
 666 }
 667
 668 template <>
 669 DIDescriptorRef DIDescriptor::getFieldAs<DIDescriptorRef>(unsigned Elt) const {
 670   return DIDescriptorRef(cast_or_null<Metadata>(getField(DbgNode, Elt)));
 671 }
 672 template <>
 673 DIScopeRef DIDescriptor::getFieldAs<DIScopeRef>(unsigned Elt) const {
 674   return DIScopeRef(cast_or_null<Metadata>(getField(DbgNode, Elt)));
 675 }
 676 template <> DITypeRef DIDescriptor::getFieldAs<DITypeRef>(unsigned Elt) const {
 677   return DITypeRef(cast_or_null<Metadata>(getField(DbgNode, Elt)));
 678 }
 679
 680 template <>
 681 DIDescriptor
 682 DIRef<DIDescriptor>::resolve(const DITypeIdentifierMap &Map) const {
 683   return DIDescriptor(DebugNodeRef(Val).resolve(Map));
 684 }
 685 template <>
 686 DIScope DIRef<DIScope>::resolve(const DITypeIdentifierMap &Map) const {
 687   return MDScopeRef(Val).resolve(Map);
 688 }
 689 template <>
 690 DIType DIRef<DIType>::resolve(const DITypeIdentifierMap &Map) const {
 691   return MDTypeRef(Val).resolve(Map);
 692 }
 693
 694 bool llvm::stripDebugInfo(Function &F) {
 695   bool Changed = false;
 696   for (BasicBlock &BB : F) {
 697     for (Instruction &I : BB) {
 698       if (I.getDebugLoc()) {
 699         Changed = true;
 700         I.setDebugLoc(DebugLoc());
 701       }
 702     }
 703   }
 704   return Changed;
 705 }
 706
 707 bool llvm::StripDebugInfo(Module &M) {
 708   bool Changed = false;
 709
 710   // Remove all of the calls to the debugger intrinsics, and remove them from
 711   // the module.
 712   if (Function *Declare = M.getFunction("llvm.dbg.declare")) {
 713     while (!Declare->use_empty()) {
 714       CallInst *CI = cast<CallInst>(Declare->user_back());
 715       CI->eraseFromParent();
 716     }
 717     Declare->eraseFromParent();
 718     Changed = true;
 719   }
 720
 721   if (Function *DbgVal = M.getFunction("llvm.dbg.value")) {
 722     while (!DbgVal->use_empty()) {
 723       CallInst *CI = cast<CallInst>(DbgVal->user_back());
 724       CI->eraseFromParent();
 725     }
 726     DbgVal->eraseFromParent();
 727     Changed = true;
 728   }
 729
 730   for (Module::named_metadata_iterator NMI = M.named_metadata_begin(),
 731          NME = M.named_metadata_end(); NMI != NME;) {
 732     NamedMDNode *NMD = NMI;
 733     ++NMI;
 734     if (NMD->getName().startswith("llvm.dbg.")) {
 735       NMD->eraseFromParent();
 736       Changed = true;
 737     }
 738   }
 739
 740   for (Function &F : M)
 741     Changed |= stripDebugInfo(F);
 742
 743   if (GVMaterializer *Materializer = M.getMaterializer())
 744     Materializer->setStripDebugInfo();
 745
 746   return Changed;
 747 }
 748
 749 unsigned llvm::getDebugMetadataVersionFromModule(const Module &M) {
 750   if (auto *Val = mdconst::dyn_extract_or_null<ConstantInt>(
 751           M.getModuleFlag("Debug Info Version")))
 752     return Val->getZExtValue();
 753   return 0;
 754 }
 755
 756 llvm::DenseMap<const llvm::Function *, llvm::DISubprogram>
 757 llvm::makeSubprogramMap(const Module &M) {
 758   DenseMap<const Function *, DISubprogram> R;
 759
 760   NamedMDNode *CU_Nodes = M.getNamedMetadata("llvm.dbg.cu");
 761   if (!CU_Nodes)
 762     return R;
 763
 764   for (MDNode *N : CU_Nodes->operands()) {
 765     DICompileUnit CUNode = cast<MDCompileUnit>(N);
 766     DIArray SPs = CUNode.getSubprograms();
 767     for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i) {
 768       DISubprogram SP = cast<MDSubprogram>(SPs.getElement(i));
 769       if (Function *F = SP.getFunction())
 770         R.insert(std::make_pair(F, SP));
 771     }
 772   }
 773   return R;
 774 }