lib/IR/DIBuilder.cpp

   1 //===--- DIBuilder.cpp - Debug Information Builder ------------------------===//
   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 DIBuilder.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/IR/DIBuilder.h"
  15 #include "llvm/ADT/STLExtras.h"
  16 #include "llvm/IR/Constants.h"
  17 #include "llvm/IR/DebugInfo.h"
  18 #include "llvm/IR/IntrinsicInst.h"
  19 #include "llvm/IR/Module.h"
  20 #include "llvm/Support/Debug.h"
  21 #include "llvm/Support/Dwarf.h"
  22
  23 using namespace llvm;
  24 using namespace llvm::dwarf;
  25
  26 namespace {
  27 class HeaderBuilder {
  28   /// \brief Whether there are any fields yet.
  29   ///
  30   /// Note that this is not equivalent to \c Chars.empty(), since \a concat()
  31   /// may have been called already with an empty string.
  32   bool IsEmpty;
  33   SmallVector<char, 256> Chars;
  34
  35 public:
  36   HeaderBuilder() : IsEmpty(true) {}
  37   HeaderBuilder(const HeaderBuilder &X) : IsEmpty(X.IsEmpty), Chars(X.Chars) {}
  38   HeaderBuilder(HeaderBuilder &&X)
  39       : IsEmpty(X.IsEmpty), Chars(std::move(X.Chars)) {}
  40
  41   template <class Twineable> HeaderBuilder &concat(Twineable &&X) {
  42     if (IsEmpty)
  43       IsEmpty = false;
  44     else
  45       Chars.push_back(0);
  46     Twine(X).toVector(Chars);
  47     return *this;
  48   }
  49
  50   MDString *get(LLVMContext &Context) const {
  51     return MDString::get(Context, StringRef(Chars.begin(), Chars.size()));
  52   }
  53
  54   static HeaderBuilder get(unsigned Tag) {
  55     return HeaderBuilder().concat("0x" + Twine::utohexstr(Tag));
  56   }
  57 };
  58 }
  59
  60 DIBuilder::DIBuilder(Module &m, bool AllowUnresolvedNodes)
  61   : M(m), VMContext(M.getContext()), CUNode(nullptr),
  62       DeclareFn(nullptr), ValueFn(nullptr),
  63       AllowUnresolvedNodes(AllowUnresolvedNodes) {}
  64
  65 void DIBuilder::trackIfUnresolved(MDNode *N) {
  66   if (!N)
  67     return;
  68   if (N->isResolved())
  69     return;
  70
  71   assert(AllowUnresolvedNodes && "Cannot handle unresolved nodes");
  72   UnresolvedNodes.emplace_back(N);
  73 }
  74
  75 void DIBuilder::finalize() {
  76   if (!CUNode) {
  77     assert(!AllowUnresolvedNodes &&
  78            "creating type nodes without a CU is not supported");
  79     return;
  80   }
  81
  82   CUNode->replaceEnumTypes(MDTuple::get(VMContext, AllEnumTypes));
  83
  84   SmallVector<Metadata *, 16> RetainValues;
  85   // Declarations and definitions of the same type may be retained. Some
  86   // clients RAUW these pairs, leaving duplicates in the retained types
  87   // list. Use a set to remove the duplicates while we transform the
  88   // TrackingVHs back into Values.
  89   SmallPtrSet<Metadata *, 16> RetainSet;
  90   for (unsigned I = 0, E = AllRetainTypes.size(); I < E; I++)
  91     if (RetainSet.insert(AllRetainTypes[I]).second)
  92       RetainValues.push_back(AllRetainTypes[I]);
  93
  94   if (!RetainValues.empty())
  95     CUNode->replaceRetainedTypes(MDTuple::get(VMContext, RetainValues));
  96
  97   DISubprogramArray SPs = MDTuple::get(VMContext, AllSubprograms);
  98   if (!AllSubprograms.empty())
  99     CUNode->replaceSubprograms(SPs.get());
 100
 101   for (auto *SP : SPs) {
 102     if (MDTuple *Temp = SP->getVariables().get()) {
 103       const auto &PV = PreservedVariables.lookup(SP);
 104       SmallVector<Metadata *, 4> Variables(PV.begin(), PV.end());
 105       DINodeArray AV = getOrCreateArray(Variables);
 106       TempMDTuple(Temp)->replaceAllUsesWith(AV.get());
 107     }
 108   }
 109
 110   if (!AllGVs.empty())
 111     CUNode->replaceGlobalVariables(MDTuple::get(VMContext, AllGVs));
 112
 113   if (!AllImportedModules.empty())
 114     CUNode->replaceImportedEntities(MDTuple::get(
 115         VMContext, SmallVector<Metadata *, 16>(AllImportedModules.begin(),
 116                                                AllImportedModules.end())));
 117
 118   // Now that all temp nodes have been replaced or deleted, resolve remaining
 119   // cycles.
 120   for (const auto &N : UnresolvedNodes)
 121     if (N && !N->isResolved())
 122       N->resolveCycles();
 123   UnresolvedNodes.clear();
 124
 125   // Can't handle unresolved nodes anymore.
 126   AllowUnresolvedNodes = false;
 127 }
 128
 129 /// If N is compile unit return NULL otherwise return N.
 130 static DIScope *getNonCompileUnitScope(DIScope *N) {
 131   if (!N || isa<DICompileUnit>(N))
 132     return nullptr;
 133   return cast<DIScope>(N);
 134 }
 135
 136 DICompileUnit *DIBuilder::createCompileUnit(
 137     unsigned Lang, StringRef Filename, StringRef Directory, StringRef Producer,
 138     bool isOptimized, StringRef Flags, unsigned RunTimeVer, StringRef SplitName,
 139     DebugEmissionKind Kind, uint64_t DWOId, bool EmitDebugInfo) {
 140
 141   assert(((Lang <= dwarf::DW_LANG_Fortran08 && Lang >= dwarf::DW_LANG_C89) ||
 142           (Lang <= dwarf::DW_LANG_hi_user && Lang >= dwarf::DW_LANG_lo_user)) &&
 143          "Invalid Language tag");
 144   assert(!Filename.empty() &&
 145          "Unable to create compile unit without filename");
 146
 147   assert(!CUNode && "Can only make one compile unit per DIBuilder instance");
 148   CUNode = DICompileUnit::getDistinct(
 149       VMContext, Lang, DIFile::get(VMContext, Filename, Directory), Producer,
 150       isOptimized, Flags, RunTimeVer, SplitName, Kind, nullptr,
 151       nullptr, nullptr, nullptr, nullptr, DWOId);
 152
 153   // Create a named metadata so that it is easier to find cu in a module.
 154   // Note that we only generate this when the caller wants to actually
 155   // emit debug information. When we are only interested in tracking
 156   // source line locations throughout the backend, we prevent codegen from
 157   // emitting debug info in the final output by not generating llvm.dbg.cu.
 158   if (EmitDebugInfo) {
 159     NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.cu");
 160     NMD->addOperand(CUNode);
 161   }
 162
 163   trackIfUnresolved(CUNode);
 164   return CUNode;
 165 }
 166
 167 static DIImportedEntity *
 168 createImportedModule(LLVMContext &C, dwarf::Tag Tag, DIScope *Context,
 169                      Metadata *NS, unsigned Line, StringRef Name,
 170                      SmallVectorImpl<TrackingMDNodeRef> &AllImportedModules) {
 171   auto *M = DIImportedEntity::get(C, Tag, Context, DINodeRef(NS), Line, Name);
 172   AllImportedModules.emplace_back(M);
 173   return M;
 174 }
 175
 176 DIImportedEntity *DIBuilder::createImportedModule(DIScope *Context,
 177                                                   DINamespace *NS,
 178                                                   unsigned Line) {
 179   return ::createImportedModule(VMContext, dwarf::DW_TAG_imported_module,
 180                                 Context, NS, Line, StringRef(), AllImportedModules);
 181 }
 182
 183 DIImportedEntity *DIBuilder::createImportedModule(DIScope *Context,
 184                                                   DIImportedEntity *NS,
 185                                                   unsigned Line) {
 186   return ::createImportedModule(VMContext, dwarf::DW_TAG_imported_module,
 187                                 Context, NS, Line, StringRef(), AllImportedModules);
 188 }
 189
 190 DIImportedEntity *DIBuilder::createImportedModule(DIScope *Context, DIModule *M,
 191                                                   unsigned Line) {
 192   return ::createImportedModule(VMContext, dwarf::DW_TAG_imported_module,
 193                                 Context, M, Line, StringRef(), AllImportedModules);
 194 }
 195
 196 DIImportedEntity *DIBuilder::createImportedDeclaration(DIScope *Context,
 197                                                        DINode *Decl,
 198                                                        unsigned Line,
 199                                                        StringRef Name) {
 200   // Make sure to use the unique identifier based metadata reference for
 201   // types that have one.
 202   return ::createImportedModule(VMContext, dwarf::DW_TAG_imported_declaration,
 203                                 Context, DINodeRef::get(Decl), Line, Name,
 204                                 AllImportedModules);
 205 }
 206
 207 DIFile *DIBuilder::createFile(StringRef Filename, StringRef Directory) {
 208   return DIFile::get(VMContext, Filename, Directory);
 209 }
 210
 211 DIEnumerator *DIBuilder::createEnumerator(StringRef Name, int64_t Val) {
 212   assert(!Name.empty() && "Unable to create enumerator without name");
 213   return DIEnumerator::get(VMContext, Val, Name);
 214 }
 215
 216 DIBasicType *DIBuilder::createUnspecifiedType(StringRef Name) {
 217   assert(!Name.empty() && "Unable to create type without name");
 218   return DIBasicType::get(VMContext, dwarf::DW_TAG_unspecified_type, Name);
 219 }
 220
 221 DIBasicType *DIBuilder::createNullPtrType() {
 222   return createUnspecifiedType("decltype(nullptr)");
 223 }
 224
 225 DIBasicType *DIBuilder::createBasicType(StringRef Name, uint64_t SizeInBits,
 226                                         uint64_t AlignInBits,
 227                                         unsigned Encoding) {
 228   assert(!Name.empty() && "Unable to create type without name");
 229   return DIBasicType::get(VMContext, dwarf::DW_TAG_base_type, Name, SizeInBits,
 230                           AlignInBits, Encoding);
 231 }
 232
 233 DIDerivedType *DIBuilder::createQualifiedType(unsigned Tag, DIType *FromTy) {
 234   return DIDerivedType::get(VMContext, Tag, "", nullptr, 0, nullptr,
 235                             DITypeRef::get(FromTy), 0, 0, 0, 0);
 236 }
 237
 238 DIDerivedType *DIBuilder::createPointerType(DIType *PointeeTy,
 239                                             uint64_t SizeInBits,
 240                                             uint64_t AlignInBits,
 241                                             StringRef Name) {
 242   // FIXME: Why is there a name here?
 243   return DIDerivedType::get(VMContext, dwarf::DW_TAG_pointer_type, Name,
 244                             nullptr, 0, nullptr, DITypeRef::get(PointeeTy),
 245                             SizeInBits, AlignInBits, 0, 0);
 246 }
 247
 248 DIDerivedType *DIBuilder::createMemberPointerType(DIType *PointeeTy,
 249                                                   DIType *Base,
 250                                                   uint64_t SizeInBits,
 251                                                   uint64_t AlignInBits) {
 252   return DIDerivedType::get(VMContext, dwarf::DW_TAG_ptr_to_member_type, "",
 253                             nullptr, 0, nullptr, DITypeRef::get(PointeeTy),
 254                             SizeInBits, AlignInBits, 0, 0,
 255                             DITypeRef::get(Base));
 256 }
 257
 258 DIDerivedType *DIBuilder::createReferenceType(unsigned Tag, DIType *RTy) {
 259   assert(RTy && "Unable to create reference type");
 260   return DIDerivedType::get(VMContext, Tag, "", nullptr, 0, nullptr,
 261                             DITypeRef::get(RTy), 0, 0, 0, 0);
 262 }
 263
 264 DIDerivedType *DIBuilder::createTypedef(DIType *Ty, StringRef Name,
 265                                         DIFile *File, unsigned LineNo,
 266                                         DIScope *Context) {
 267   return DIDerivedType::get(VMContext, dwarf::DW_TAG_typedef, Name, File,
 268                             LineNo,
 269                             DIScopeRef::get(getNonCompileUnitScope(Context)),
 270                             DITypeRef::get(Ty), 0, 0, 0, 0);
 271 }
 272
 273 DIDerivedType *DIBuilder::createFriend(DIType *Ty, DIType *FriendTy) {
 274   assert(Ty && "Invalid type!");
 275   assert(FriendTy && "Invalid friend type!");
 276   return DIDerivedType::get(VMContext, dwarf::DW_TAG_friend, "", nullptr, 0,
 277                             DITypeRef::get(Ty), DITypeRef::get(FriendTy), 0, 0,
 278                             0, 0);
 279 }
 280
 281 DIDerivedType *DIBuilder::createInheritance(DIType *Ty, DIType *BaseTy,
 282                                             uint64_t BaseOffset,
 283                                             unsigned Flags) {
 284   assert(Ty && "Unable to create inheritance");
 285   return DIDerivedType::get(VMContext, dwarf::DW_TAG_inheritance, "", nullptr,
 286                             0, DITypeRef::get(Ty), DITypeRef::get(BaseTy), 0, 0,
 287                             BaseOffset, Flags);
 288 }
 289
 290 DIDerivedType *DIBuilder::createMemberType(DIScope *Scope, StringRef Name,
 291                                            DIFile *File, unsigned LineNumber,
 292                                            uint64_t SizeInBits,
 293                                            uint64_t AlignInBits,
 294                                            uint64_t OffsetInBits,
 295                                            unsigned Flags, DIType *Ty) {
 296   return DIDerivedType::get(
 297       VMContext, dwarf::DW_TAG_member, Name, File, LineNumber,
 298       DIScopeRef::get(getNonCompileUnitScope(Scope)), DITypeRef::get(Ty),
 299       SizeInBits, AlignInBits, OffsetInBits, Flags);
 300 }
 301
 302 static ConstantAsMetadata *getConstantOrNull(Constant *C) {
 303   if (C)
 304     return ConstantAsMetadata::get(C);
 305   return nullptr;
 306 }
 307
 308 DIDerivedType *DIBuilder::createStaticMemberType(DIScope *Scope, StringRef Name,
 309                                                  DIFile *File,
 310                                                  unsigned LineNumber,
 311                                                  DIType *Ty, unsigned Flags,
 312                                                  llvm::Constant *Val) {
 313   Flags |= DINode::FlagStaticMember;
 314   return DIDerivedType::get(
 315       VMContext, dwarf::DW_TAG_member, Name, File, LineNumber,
 316       DIScopeRef::get(getNonCompileUnitScope(Scope)), DITypeRef::get(Ty), 0, 0,
 317       0, Flags, getConstantOrNull(Val));
 318 }
 319
 320 DIDerivedType *DIBuilder::createObjCIVar(StringRef Name, DIFile *File,
 321                                          unsigned LineNumber,
 322                                          uint64_t SizeInBits,
 323                                          uint64_t AlignInBits,
 324                                          uint64_t OffsetInBits, unsigned Flags,
 325                                          DIType *Ty, MDNode *PropertyNode) {
 326   return DIDerivedType::get(
 327       VMContext, dwarf::DW_TAG_member, Name, File, LineNumber,
 328       DIScopeRef::get(getNonCompileUnitScope(File)), DITypeRef::get(Ty),
 329       SizeInBits, AlignInBits, OffsetInBits, Flags, PropertyNode);
 330 }
 331
 332 DIObjCProperty *
 333 DIBuilder::createObjCProperty(StringRef Name, DIFile *File, unsigned LineNumber,
 334                               StringRef GetterName, StringRef SetterName,
 335                               unsigned PropertyAttributes, DIType *Ty) {
 336   return DIObjCProperty::get(VMContext, Name, File, LineNumber, GetterName,
 337                              SetterName, PropertyAttributes,
 338                              DITypeRef::get(Ty));
 339 }
 340
 341 DITemplateTypeParameter *
 342 DIBuilder::createTemplateTypeParameter(DIScope *Context, StringRef Name,
 343                                        DIType *Ty) {
 344   assert((!Context || isa<DICompileUnit>(Context)) && "Expected compile unit");
 345   return DITemplateTypeParameter::get(VMContext, Name, DITypeRef::get(Ty));
 346 }
 347
 348 static DITemplateValueParameter *
 349 createTemplateValueParameterHelper(LLVMContext &VMContext, unsigned Tag,
 350                                    DIScope *Context, StringRef Name, DIType *Ty,
 351                                    Metadata *MD) {
 352   assert((!Context || isa<DICompileUnit>(Context)) && "Expected compile unit");
 353   return DITemplateValueParameter::get(VMContext, Tag, Name, DITypeRef::get(Ty),
 354                                        MD);
 355 }
 356
 357 DITemplateValueParameter *
 358 DIBuilder::createTemplateValueParameter(DIScope *Context, StringRef Name,
 359                                         DIType *Ty, Constant *Val) {
 360   return createTemplateValueParameterHelper(
 361       VMContext, dwarf::DW_TAG_template_value_parameter, Context, Name, Ty,
 362       getConstantOrNull(Val));
 363 }
 364
 365 DITemplateValueParameter *
 366 DIBuilder::createTemplateTemplateParameter(DIScope *Context, StringRef Name,
 367                                            DIType *Ty, StringRef Val) {
 368   return createTemplateValueParameterHelper(
 369       VMContext, dwarf::DW_TAG_GNU_template_template_param, Context, Name, Ty,
 370       MDString::get(VMContext, Val));
 371 }
 372
 373 DITemplateValueParameter *
 374 DIBuilder::createTemplateParameterPack(DIScope *Context, StringRef Name,
 375                                        DIType *Ty, DINodeArray Val) {
 376   return createTemplateValueParameterHelper(
 377       VMContext, dwarf::DW_TAG_GNU_template_parameter_pack, Context, Name, Ty,
 378       Val.get());
 379 }
 380
 381 DICompositeType *DIBuilder::createClassType(
 382     DIScope *Context, StringRef Name, DIFile *File, unsigned LineNumber,
 383     uint64_t SizeInBits, uint64_t AlignInBits, uint64_t OffsetInBits,
 384     unsigned Flags, DIType *DerivedFrom, DINodeArray Elements,
 385     DIType *VTableHolder, MDNode *TemplateParams, StringRef UniqueIdentifier) {
 386   assert((!Context || isa<DIScope>(Context)) &&
 387          "createClassType should be called with a valid Context");
 388
 389   auto *R = DICompositeType::get(
 390       VMContext, dwarf::DW_TAG_structure_type, Name, File, LineNumber,
 391       DIScopeRef::get(getNonCompileUnitScope(Context)),
 392       DITypeRef::get(DerivedFrom), SizeInBits, AlignInBits, OffsetInBits, Flags,
 393       Elements, 0, DITypeRef::get(VTableHolder),
 394       cast_or_null<MDTuple>(TemplateParams), UniqueIdentifier);
 395   if (!UniqueIdentifier.empty())
 396     retainType(R);
 397   trackIfUnresolved(R);
 398   return R;
 399 }
 400
 401 DICompositeType *DIBuilder::createStructType(
 402     DIScope *Context, StringRef Name, DIFile *File, unsigned LineNumber,
 403     uint64_t SizeInBits, uint64_t AlignInBits, unsigned Flags,
 404     DIType *DerivedFrom, DINodeArray Elements, unsigned RunTimeLang,
 405     DIType *VTableHolder, StringRef UniqueIdentifier) {
 406   auto *R = DICompositeType::get(
 407       VMContext, dwarf::DW_TAG_structure_type, Name, File, LineNumber,
 408       DIScopeRef::get(getNonCompileUnitScope(Context)),
 409       DITypeRef::get(DerivedFrom), SizeInBits, AlignInBits, 0, Flags, Elements,
 410       RunTimeLang, DITypeRef::get(VTableHolder), nullptr, UniqueIdentifier);
 411   if (!UniqueIdentifier.empty())
 412     retainType(R);
 413   trackIfUnresolved(R);
 414   return R;
 415 }
 416
 417 DICompositeType *DIBuilder::createUnionType(
 418     DIScope *Scope, StringRef Name, DIFile *File, unsigned LineNumber,
 419     uint64_t SizeInBits, uint64_t AlignInBits, unsigned Flags,
 420     DINodeArray Elements, unsigned RunTimeLang, StringRef UniqueIdentifier) {
 421   auto *R = DICompositeType::get(
 422       VMContext, dwarf::DW_TAG_union_type, Name, File, LineNumber,
 423       DIScopeRef::get(getNonCompileUnitScope(Scope)), nullptr, SizeInBits,
 424       AlignInBits, 0, Flags, Elements, RunTimeLang, nullptr, nullptr,
 425       UniqueIdentifier);
 426   if (!UniqueIdentifier.empty())
 427     retainType(R);
 428   trackIfUnresolved(R);
 429   return R;
 430 }
 431
 432 DISubroutineType *DIBuilder::createSubroutineType(DITypeRefArray ParameterTypes,
 433                                                   unsigned Flags) {
 434   return DISubroutineType::get(VMContext, Flags, ParameterTypes);
 435 }
 436
 437 DICompositeType *DIBuilder::createExternalTypeRef(unsigned Tag, DIFile *File,
 438                                                   StringRef UniqueIdentifier) {
 439   assert(!UniqueIdentifier.empty() && "external type ref without uid");
 440   auto *CTy =
 441       DICompositeType::get(VMContext, Tag, "", nullptr, 0, nullptr, nullptr, 0,
 442                            0, 0, DINode::FlagExternalTypeRef, nullptr, 0,
 443                            nullptr, nullptr, UniqueIdentifier);
 444   // Types with unique IDs need to be in the type map.
 445   retainType(CTy);
 446   return CTy;
 447 }
 448
 449 DICompositeType *DIBuilder::createEnumerationType(
 450     DIScope *Scope, StringRef Name, DIFile *File, unsigned LineNumber,
 451     uint64_t SizeInBits, uint64_t AlignInBits, DINodeArray Elements,
 452     DIType *UnderlyingType, StringRef UniqueIdentifier) {
 453   auto *CTy = DICompositeType::get(
 454       VMContext, dwarf::DW_TAG_enumeration_type, Name, File, LineNumber,
 455       DIScopeRef::get(getNonCompileUnitScope(Scope)),
 456       DITypeRef::get(UnderlyingType), SizeInBits, AlignInBits, 0, 0, Elements,
 457       0, nullptr, nullptr, UniqueIdentifier);
 458   AllEnumTypes.push_back(CTy);
 459   if (!UniqueIdentifier.empty())
 460     retainType(CTy);
 461   trackIfUnresolved(CTy);
 462   return CTy;
 463 }
 464
 465 DICompositeType *DIBuilder::createArrayType(uint64_t Size, uint64_t AlignInBits,
 466                                             DIType *Ty,
 467                                             DINodeArray Subscripts) {
 468   auto *R = DICompositeType::get(VMContext, dwarf::DW_TAG_array_type, "",
 469                                  nullptr, 0, nullptr, DITypeRef::get(Ty), Size,
 470                                  AlignInBits, 0, 0, Subscripts, 0, nullptr);
 471   trackIfUnresolved(R);
 472   return R;
 473 }
 474
 475 DICompositeType *DIBuilder::createVectorType(uint64_t Size,
 476                                              uint64_t AlignInBits, DIType *Ty,
 477                                              DINodeArray Subscripts) {
 478   auto *R =
 479       DICompositeType::get(VMContext, dwarf::DW_TAG_array_type, "", nullptr, 0,
 480                            nullptr, DITypeRef::get(Ty), Size, AlignInBits, 0,
 481                            DINode::FlagVector, Subscripts, 0, nullptr);
 482   trackIfUnresolved(R);
 483   return R;
 484 }
 485
 486 static DIType *createTypeWithFlags(LLVMContext &Context, DIType *Ty,
 487                                    unsigned FlagsToSet) {
 488   auto NewTy = Ty->clone();
 489   NewTy->setFlags(NewTy->getFlags() | FlagsToSet);
 490   return MDNode::replaceWithUniqued(std::move(NewTy));
 491 }
 492
 493 DIType *DIBuilder::createArtificialType(DIType *Ty) {
 494   // FIXME: Restrict this to the nodes where it's valid.
 495   if (Ty->isArtificial())
 496     return Ty;
 497   return createTypeWithFlags(VMContext, Ty, DINode::FlagArtificial);
 498 }
 499
 500 DIType *DIBuilder::createObjectPointerType(DIType *Ty) {
 501   // FIXME: Restrict this to the nodes where it's valid.
 502   if (Ty->isObjectPointer())
 503     return Ty;
 504   unsigned Flags = DINode::FlagObjectPointer | DINode::FlagArtificial;
 505   return createTypeWithFlags(VMContext, Ty, Flags);
 506 }
 507
 508 void DIBuilder::retainType(DIType *T) {
 509   assert(T && "Expected non-null type");
 510   AllRetainTypes.emplace_back(T);
 511 }
 512
 513 DIBasicType *DIBuilder::createUnspecifiedParameter() { return nullptr; }
 514
 515 DICompositeType *
 516 DIBuilder::createForwardDecl(unsigned Tag, StringRef Name, DIScope *Scope,
 517                              DIFile *F, unsigned Line, unsigned RuntimeLang,
 518                              uint64_t SizeInBits, uint64_t AlignInBits,
 519                              StringRef UniqueIdentifier) {
 520   // FIXME: Define in terms of createReplaceableForwardDecl() by calling
 521   // replaceWithUniqued().
 522   auto *RetTy = DICompositeType::get(
 523       VMContext, Tag, Name, F, Line,
 524       DIScopeRef::get(getNonCompileUnitScope(Scope)), nullptr, SizeInBits,
 525       AlignInBits, 0, DINode::FlagFwdDecl, nullptr, RuntimeLang, nullptr,
 526       nullptr, UniqueIdentifier);
 527   if (!UniqueIdentifier.empty())
 528     retainType(RetTy);
 529   trackIfUnresolved(RetTy);
 530   return RetTy;
 531 }
 532
 533 DICompositeType *DIBuilder::createReplaceableCompositeType(
 534     unsigned Tag, StringRef Name, DIScope *Scope, DIFile *F, unsigned Line,
 535     unsigned RuntimeLang, uint64_t SizeInBits, uint64_t AlignInBits,
 536     unsigned Flags, StringRef UniqueIdentifier) {
 537   auto *RetTy = DICompositeType::getTemporary(
 538                     VMContext, Tag, Name, F, Line,
 539                     DIScopeRef::get(getNonCompileUnitScope(Scope)), nullptr,
 540                     SizeInBits, AlignInBits, 0, Flags, nullptr, RuntimeLang,
 541                     nullptr, nullptr, UniqueIdentifier)
 542                     .release();
 543   if (!UniqueIdentifier.empty())
 544     retainType(RetTy);
 545   trackIfUnresolved(RetTy);
 546   return RetTy;
 547 }
 548
 549 DINodeArray DIBuilder::getOrCreateArray(ArrayRef<Metadata *> Elements) {
 550   return MDTuple::get(VMContext, Elements);
 551 }
 552
 553 DITypeRefArray DIBuilder::getOrCreateTypeArray(ArrayRef<Metadata *> Elements) {
 554   SmallVector<llvm::Metadata *, 16> Elts;
 555   for (unsigned i = 0, e = Elements.size(); i != e; ++i) {
 556     if (Elements[i] && isa<MDNode>(Elements[i]))
 557       Elts.push_back(DITypeRef::get(cast<DIType>(Elements[i])));
 558     else
 559       Elts.push_back(Elements[i]);
 560   }
 561   return DITypeRefArray(MDNode::get(VMContext, Elts));
 562 }
 563
 564 DISubrange *DIBuilder::getOrCreateSubrange(int64_t Lo, int64_t Count) {
 565   return DISubrange::get(VMContext, Count, Lo);
 566 }
 567
 568 static void checkGlobalVariableScope(DIScope *Context) {
 569 #ifndef NDEBUG
 570   if (auto *CT =
 571           dyn_cast_or_null<DICompositeType>(getNonCompileUnitScope(Context)))
 572     assert(CT->getIdentifier().empty() &&
 573            "Context of a global variable should not be a type with identifier");
 574 #endif
 575 }
 576
 577 DIGlobalVariable *DIBuilder::createGlobalVariable(
 578     DIScope *Context, StringRef Name, StringRef LinkageName, DIFile *F,
 579     unsigned LineNumber, DIType *Ty, bool isLocalToUnit, Constant *Val,
 580     MDNode *Decl) {
 581   checkGlobalVariableScope(Context);
 582
 583   auto *N = DIGlobalVariable::get(VMContext, cast_or_null<DIScope>(Context),
 584                                   Name, LinkageName, F, LineNumber,
 585                                   DITypeRef::get(Ty), isLocalToUnit, true, Val,
 586                                   cast_or_null<DIDerivedType>(Decl));
 587   AllGVs.push_back(N);
 588   return N;
 589 }
 590
 591 DIGlobalVariable *DIBuilder::createTempGlobalVariableFwdDecl(
 592     DIScope *Context, StringRef Name, StringRef LinkageName, DIFile *F,
 593     unsigned LineNumber, DIType *Ty, bool isLocalToUnit, Constant *Val,
 594     MDNode *Decl) {
 595   checkGlobalVariableScope(Context);
 596
 597   return DIGlobalVariable::getTemporary(
 598              VMContext, cast_or_null<DIScope>(Context), Name, LinkageName, F,
 599              LineNumber, DITypeRef::get(Ty), isLocalToUnit, false, Val,
 600              cast_or_null<DIDerivedType>(Decl))
 601       .release();
 602 }
 603
 604 static DILocalVariable *createLocalVariable(
 605     LLVMContext &VMContext,
 606     DenseMap<MDNode *, std::vector<TrackingMDNodeRef>> &PreservedVariables,
 607     DIScope *Scope, StringRef Name, unsigned ArgNo, DIFile *File,
 608     unsigned LineNo, DIType *Ty, bool AlwaysPreserve, unsigned Flags) {
 609   // FIXME: Why getNonCompileUnitScope()?
 610   // FIXME: Why is "!Context" okay here?
 611   // FIXME: Why doesn't this check for a subprogram or lexical block (AFAICT
 612   // the only valid scopes)?
 613   DIScope *Context = getNonCompileUnitScope(Scope);
 614
 615   auto *Node =
 616       DILocalVariable::get(VMContext, cast_or_null<DILocalScope>(Context), Name,
 617                            File, LineNo, DITypeRef::get(Ty), ArgNo, Flags);
 618   if (AlwaysPreserve) {
 619     // The optimizer may remove local variables. If there is an interest
 620     // to preserve variable info in such situation then stash it in a
 621     // named mdnode.
 622     DISubprogram *Fn = getDISubprogram(Scope);
 623     assert(Fn && "Missing subprogram for local variable");
 624     PreservedVariables[Fn].emplace_back(Node);
 625   }
 626   return Node;
 627 }
 628
 629 DILocalVariable *DIBuilder::createAutoVariable(DIScope *Scope, StringRef Name,
 630                                                DIFile *File, unsigned LineNo,
 631                                                DIType *Ty, bool AlwaysPreserve,
 632                                                unsigned Flags) {
 633   return createLocalVariable(VMContext, PreservedVariables, Scope, Name,
 634                              /* ArgNo */ 0, File, LineNo, Ty, AlwaysPreserve,
 635                              Flags);
 636 }
 637
 638 DILocalVariable *DIBuilder::createParameterVariable(
 639     DIScope *Scope, StringRef Name, unsigned ArgNo, DIFile *File,
 640     unsigned LineNo, DIType *Ty, bool AlwaysPreserve, unsigned Flags) {
 641   assert(ArgNo && "Expected non-zero argument number for parameter");
 642   return createLocalVariable(VMContext, PreservedVariables, Scope, Name, ArgNo,
 643                              File, LineNo, Ty, AlwaysPreserve, Flags);
 644 }
 645
 646 DIExpression *DIBuilder::createExpression(ArrayRef<uint64_t> Addr) {
 647   return DIExpression::get(VMContext, Addr);
 648 }
 649
 650 DIExpression *DIBuilder::createExpression(ArrayRef<int64_t> Signed) {
 651   // TODO: Remove the callers of this signed version and delete.
 652   SmallVector<uint64_t, 8> Addr(Signed.begin(), Signed.end());
 653   return createExpression(Addr);
 654 }
 655
 656 DIExpression *DIBuilder::createBitPieceExpression(unsigned OffsetInBytes,
 657                                                   unsigned SizeInBytes) {
 658   uint64_t Addr[] = {dwarf::DW_OP_bit_piece, OffsetInBytes, SizeInBytes};
 659   return DIExpression::get(VMContext, Addr);
 660 }
 661
 662 DISubprogram *DIBuilder::createFunction(DIScopeRef Context, StringRef Name,
 663                                         StringRef LinkageName, DIFile *File,
 664                                         unsigned LineNo, DISubroutineType *Ty,
 665                                         bool isLocalToUnit, bool isDefinition,
 666                                         unsigned ScopeLine, unsigned Flags,
 667                                         bool isOptimized, Function *Fn,
 668                                         MDNode *TParams, MDNode *Decl) {
 669   // dragonegg does not generate identifier for types, so using an empty map
 670   // to resolve the context should be fine.
 671   DITypeIdentifierMap EmptyMap;
 672   return createFunction(Context.resolve(EmptyMap), Name, LinkageName, File,
 673                         LineNo, Ty, isLocalToUnit, isDefinition, ScopeLine,
 674                         Flags, isOptimized, Fn, TParams, Decl);
 675 }
 676
 677 template <class... Ts>
 678 static DISubprogram *getSubprogram(bool IsDistinct, Ts &&... Args) {
 679   if (IsDistinct)
 680     return DISubprogram::getDistinct(std::forward<Ts>(Args)...);
 681   return DISubprogram::get(std::forward<Ts>(Args)...);
 682 }
 683
 684 DISubprogram *DIBuilder::createFunction(DIScope *Context, StringRef Name,
 685                                         StringRef LinkageName, DIFile *File,
 686                                         unsigned LineNo, DISubroutineType *Ty,
 687                                         bool isLocalToUnit, bool isDefinition,
 688                                         unsigned ScopeLine, unsigned Flags,
 689                                         bool isOptimized, Function *Fn,
 690                                         MDNode *TParams, MDNode *Decl) {
 691   auto *Node = getSubprogram(/* IsDistinct = */ isDefinition, VMContext,
 692                              DIScopeRef::get(getNonCompileUnitScope(Context)),
 693                              Name, LinkageName, File, LineNo, Ty, isLocalToUnit,
 694                              isDefinition, ScopeLine, nullptr, 0, 0, Flags,
 695                              isOptimized, Fn, cast_or_null<MDTuple>(TParams),
 696                              cast_or_null<DISubprogram>(Decl),
 697                              MDTuple::getTemporary(VMContext, None).release());
 698
 699   if (isDefinition)
 700     AllSubprograms.push_back(Node);
 701   trackIfUnresolved(Node);
 702   return Node;
 703 }
 704
 705 DISubprogram *DIBuilder::createTempFunctionFwdDecl(
 706     DIScope *Context, StringRef Name, StringRef LinkageName, DIFile *File,
 707     unsigned LineNo, DISubroutineType *Ty, bool isLocalToUnit,
 708     bool isDefinition, unsigned ScopeLine, unsigned Flags, bool isOptimized,
 709     Function *Fn, MDNode *TParams, MDNode *Decl) {
 710   return DISubprogram::getTemporary(
 711              VMContext, DIScopeRef::get(getNonCompileUnitScope(Context)), Name,
 712              LinkageName, File, LineNo, Ty, isLocalToUnit, isDefinition,
 713              ScopeLine, nullptr, 0, 0, Flags, isOptimized, Fn,
 714              cast_or_null<MDTuple>(TParams), cast_or_null<DISubprogram>(Decl),
 715              nullptr)
 716       .release();
 717 }
 718
 719 DISubprogram *
 720 DIBuilder::createMethod(DIScope *Context, StringRef Name, StringRef LinkageName,
 721                         DIFile *F, unsigned LineNo, DISubroutineType *Ty,
 722                         bool isLocalToUnit, bool isDefinition, unsigned VK,
 723                         unsigned VIndex, DIType *VTableHolder, unsigned Flags,
 724                         bool isOptimized, Function *Fn, MDNode *TParam) {
 725   assert(getNonCompileUnitScope(Context) &&
 726          "Methods should have both a Context and a context that isn't "
 727          "the compile unit.");
 728   // FIXME: Do we want to use different scope/lines?
 729   auto *SP = getSubprogram(/* IsDistinct = */ isDefinition, VMContext,
 730                            DIScopeRef::get(cast<DIScope>(Context)), Name,
 731                            LinkageName, F, LineNo, Ty, isLocalToUnit,
 732                            isDefinition, LineNo, DITypeRef::get(VTableHolder),
 733                            VK, VIndex, Flags, isOptimized, Fn,
 734                            cast_or_null<MDTuple>(TParam), nullptr, nullptr);
 735
 736   if (isDefinition)
 737     AllSubprograms.push_back(SP);
 738   trackIfUnresolved(SP);
 739   return SP;
 740 }
 741
 742 DINamespace *DIBuilder::createNameSpace(DIScope *Scope, StringRef Name,
 743                                         DIFile *File, unsigned LineNo) {
 744   return DINamespace::get(VMContext, getNonCompileUnitScope(Scope), File, Name,
 745                           LineNo);
 746 }
 747
 748 DIModule *DIBuilder::createModule(DIScope *Scope, StringRef Name,
 749                                   StringRef ConfigurationMacros,
 750                                   StringRef IncludePath,
 751                                   StringRef ISysRoot) {
 752  return DIModule::get(VMContext, getNonCompileUnitScope(Scope), Name,
 753                       ConfigurationMacros, IncludePath, ISysRoot);
 754 }
 755
 756 DILexicalBlockFile *DIBuilder::createLexicalBlockFile(DIScope *Scope,
 757                                                       DIFile *File,
 758                                                       unsigned Discriminator) {
 759   return DILexicalBlockFile::get(VMContext, Scope, File, Discriminator);
 760 }
 761
 762 DILexicalBlock *DIBuilder::createLexicalBlock(DIScope *Scope, DIFile *File,
 763                                               unsigned Line, unsigned Col) {
 764   // Make these distinct, to avoid merging two lexical blocks on the same
 765   // file/line/column.
 766   return DILexicalBlock::getDistinct(VMContext, getNonCompileUnitScope(Scope),
 767                                      File, Line, Col);
 768 }
 769
 770 static Value *getDbgIntrinsicValueImpl(LLVMContext &VMContext, Value *V) {
 771   assert(V && "no value passed to dbg intrinsic");
 772   return MetadataAsValue::get(VMContext, ValueAsMetadata::get(V));
 773 }
 774
 775 static Instruction *withDebugLoc(Instruction *I, const DILocation *DL) {
 776   I->setDebugLoc(const_cast<DILocation *>(DL));
 777   return I;
 778 }
 779
 780 Instruction *DIBuilder::insertDeclare(Value *Storage, DILocalVariable *VarInfo,
 781                                       DIExpression *Expr, const DILocation *DL,
 782                                       Instruction *InsertBefore) {
 783   assert(VarInfo && "empty or invalid DILocalVariable* passed to dbg.declare");
 784   assert(DL && "Expected debug loc");
 785   assert(DL->getScope()->getSubprogram() ==
 786              VarInfo->getScope()->getSubprogram() &&
 787          "Expected matching subprograms");
 788   if (!DeclareFn)
 789     DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
 790
 791   trackIfUnresolved(VarInfo);
 792   trackIfUnresolved(Expr);
 793   Value *Args[] = {getDbgIntrinsicValueImpl(VMContext, Storage),
 794                    MetadataAsValue::get(VMContext, VarInfo),
 795                    MetadataAsValue::get(VMContext, Expr)};
 796   return withDebugLoc(CallInst::Create(DeclareFn, Args, "", InsertBefore), DL);
 797 }
 798
 799 Instruction *DIBuilder::insertDeclare(Value *Storage, DILocalVariable *VarInfo,
 800                                       DIExpression *Expr, const DILocation *DL,
 801                                       BasicBlock *InsertAtEnd) {
 802   assert(VarInfo && "empty or invalid DILocalVariable* passed to dbg.declare");
 803   assert(DL && "Expected debug loc");
 804   assert(DL->getScope()->getSubprogram() ==
 805              VarInfo->getScope()->getSubprogram() &&
 806          "Expected matching subprograms");
 807   if (!DeclareFn)
 808     DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
 809
 810   trackIfUnresolved(VarInfo);
 811   trackIfUnresolved(Expr);
 812   Value *Args[] = {getDbgIntrinsicValueImpl(VMContext, Storage),
 813                    MetadataAsValue::get(VMContext, VarInfo),
 814                    MetadataAsValue::get(VMContext, Expr)};
 815
 816   // If this block already has a terminator then insert this intrinsic
 817   // before the terminator.
 818   if (TerminatorInst *T = InsertAtEnd->getTerminator())
 819     return withDebugLoc(CallInst::Create(DeclareFn, Args, "", T), DL);
 820   return withDebugLoc(CallInst::Create(DeclareFn, Args, "", InsertAtEnd), DL);
 821 }
 822
 823 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
 824                                                 DILocalVariable *VarInfo,
 825                                                 DIExpression *Expr,
 826                                                 const DILocation *DL,
 827                                                 Instruction *InsertBefore) {
 828   assert(V && "no value passed to dbg.value");
 829   assert(VarInfo && "empty or invalid DILocalVariable* passed to dbg.value");
 830   assert(DL && "Expected debug loc");
 831   assert(DL->getScope()->getSubprogram() ==
 832              VarInfo->getScope()->getSubprogram() &&
 833          "Expected matching subprograms");
 834   if (!ValueFn)
 835     ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
 836
 837   trackIfUnresolved(VarInfo);
 838   trackIfUnresolved(Expr);
 839   Value *Args[] = {getDbgIntrinsicValueImpl(VMContext, V),
 840                    ConstantInt::get(Type::getInt64Ty(VMContext), Offset),
 841                    MetadataAsValue::get(VMContext, VarInfo),
 842                    MetadataAsValue::get(VMContext, Expr)};
 843   return withDebugLoc(CallInst::Create(ValueFn, Args, "", InsertBefore), DL);
 844 }
 845
 846 Instruction *DIBuilder::insertDbgValueIntrinsic(Value *V, uint64_t Offset,
 847                                                 DILocalVariable *VarInfo,
 848                                                 DIExpression *Expr,
 849                                                 const DILocation *DL,
 850                                                 BasicBlock *InsertAtEnd) {
 851   assert(V && "no value passed to dbg.value");
 852   assert(VarInfo && "empty or invalid DILocalVariable* passed to dbg.value");
 853   assert(DL && "Expected debug loc");
 854   assert(DL->getScope()->getSubprogram() ==
 855              VarInfo->getScope()->getSubprogram() &&
 856          "Expected matching subprograms");
 857   if (!ValueFn)
 858     ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
 859
 860   trackIfUnresolved(VarInfo);
 861   trackIfUnresolved(Expr);
 862   Value *Args[] = {getDbgIntrinsicValueImpl(VMContext, V),
 863                    ConstantInt::get(Type::getInt64Ty(VMContext), Offset),
 864                    MetadataAsValue::get(VMContext, VarInfo),
 865                    MetadataAsValue::get(VMContext, Expr)};
 866
 867   return withDebugLoc(CallInst::Create(ValueFn, Args, "", InsertAtEnd), DL);
 868 }
 869
 870 void DIBuilder::replaceVTableHolder(DICompositeType *&T,
 871                                     DICompositeType *VTableHolder) {
 872   {
 873     TypedTrackingMDRef<DICompositeType> N(T);
 874     N->replaceVTableHolder(DITypeRef::get(VTableHolder));
 875     T = N.get();
 876   }
 877
 878   // If this didn't create a self-reference, just return.
 879   if (T != VTableHolder)
 880     return;
 881
 882   // Look for unresolved operands.  T will drop RAUW support, orphaning any
 883   // cycles underneath it.
 884   if (T->isResolved())
 885     for (const MDOperand &O : T->operands())
 886       if (auto *N = dyn_cast_or_null<MDNode>(O))
 887         trackIfUnresolved(N);
 888 }
 889
 890 void DIBuilder::replaceArrays(DICompositeType *&T, DINodeArray Elements,
 891                               DINodeArray TParams) {
 892   {
 893     TypedTrackingMDRef<DICompositeType> N(T);
 894     if (Elements)
 895       N->replaceElements(Elements);
 896     if (TParams)
 897       N->replaceTemplateParams(DITemplateParameterArray(TParams));
 898     T = N.get();
 899   }
 900
 901   // If T isn't resolved, there's no problem.
 902   if (!T->isResolved())
 903     return;
 904
 905   // If T is resolved, it may be due to a self-reference cycle.  Track the
 906   // arrays explicitly if they're unresolved, or else the cycles will be
 907   // orphaned.
 908   if (Elements)
 909     trackIfUnresolved(Elements.get());
 910   if (TParams)
 911     trackIfUnresolved(TParams.get());
 912 }