include/llvm/IR/Metadata.h

   1 //===-- llvm/Metadata.h - Metadata definitions ------------------*- C++ -*-===//
   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 /// @file
  11 /// This file contains the declarations for metadata subclasses.
  12 /// They represent the different flavors of metadata that live in LLVM.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_IR_METADATA_H
  17 #define LLVM_IR_METADATA_H
  18
  19 #include "llvm/ADT/ArrayRef.h"
  20 #include "llvm/ADT/DenseMap.h"
  21 #include "llvm/ADT/ilist_node.h"
  22 #include "llvm/ADT/iterator_range.h"
  23 #include "llvm/IR/Constant.h"
  24 #include "llvm/IR/MetadataTracking.h"
  25 #include "llvm/IR/Value.h"
  26 #include "llvm/Support/ErrorHandling.h"
  27 #include <type_traits>
  28
  29 namespace llvm {
  30 class LLVMContext;
  31 class Module;
  32 template<typename ValueSubClass, typename ItemParentClass>
  33   class SymbolTableListTraits;
  34
  35
  36 enum LLVMConstants : uint32_t {
  37   DEBUG_METADATA_VERSION = 2  // Current debug info version number.
  38 };
  39
  40 /// \brief Root of the metadata hierarchy.
  41 ///
  42 /// This is a root class for typeless data in the IR.
  43 class Metadata {
  44   friend class ReplaceableMetadataImpl;
  45
  46   /// \brief RTTI.
  47   const unsigned char SubclassID;
  48
  49 protected:
  50   /// \brief Active type of storage.
  51   enum StorageType { Uniqued, Distinct, Temporary };
  52
  53   /// \brief Storage flag for non-uniqued, otherwise unowned, metadata.
  54   StorageType Storage : 2;
  55   // TODO: expose remaining bits to subclasses.
  56
  57   unsigned short SubclassData16;
  58   unsigned SubclassData32;
  59
  60 public:
  61   enum MetadataKind {
  62     MDTupleKind,
  63     MDLocationKind,
  64     ConstantAsMetadataKind,
  65     LocalAsMetadataKind,
  66     MDStringKind
  67   };
  68
  69 protected:
  70   Metadata(unsigned ID, StorageType Storage)
  71       : SubclassID(ID), Storage(Storage), SubclassData16(0), SubclassData32(0) {
  72   }
  73   ~Metadata() {}
  74
  75   /// \brief Default handling of a changed operand, which asserts.
  76   ///
  77   /// If subclasses pass themselves in as owners to a tracking node reference,
  78   /// they must provide an implementation of this method.
  79   void handleChangedOperand(void *, Metadata *) {
  80     llvm_unreachable("Unimplemented in Metadata subclass");
  81   }
  82
  83 public:
  84   unsigned getMetadataID() const { return SubclassID; }
  85
  86   /// \brief User-friendly dump.
  87   void dump() const;
  88   void print(raw_ostream &OS) const;
  89   void printAsOperand(raw_ostream &OS, bool PrintType = true,
  90                       const Module *M = nullptr) const;
  91 };
  92
  93 #define HANDLE_METADATA(CLASS) class CLASS;
  94 #include "llvm/IR/Metadata.def"
  95
  96 inline raw_ostream &operator<<(raw_ostream &OS, const Metadata &MD) {
  97   MD.print(OS);
  98   return OS;
  99 }
 100
 101 /// \brief Metadata wrapper in the Value hierarchy.
 102 ///
 103 /// A member of the \a Value hierarchy to represent a reference to metadata.
 104 /// This allows, e.g., instrinsics to have metadata as operands.
 105 ///
 106 /// Notably, this is the only thing in either hierarchy that is allowed to
 107 /// reference \a LocalAsMetadata.
 108 class MetadataAsValue : public Value {
 109   friend class ReplaceableMetadataImpl;
 110   friend class LLVMContextImpl;
 111
 112   Metadata *MD;
 113
 114   MetadataAsValue(Type *Ty, Metadata *MD);
 115   ~MetadataAsValue();
 116
 117   /// \brief Drop use of metadata (during teardown).
 118   void dropUse() { MD = nullptr; }
 119
 120 public:
 121   static MetadataAsValue *get(LLVMContext &Context, Metadata *MD);
 122   static MetadataAsValue *getIfExists(LLVMContext &Context, Metadata *MD);
 123   Metadata *getMetadata() const { return MD; }
 124
 125   static bool classof(const Value *V) {
 126     return V->getValueID() == MetadataAsValueVal;
 127   }
 128
 129 private:
 130   void handleChangedMetadata(Metadata *MD);
 131   void track();
 132   void untrack();
 133 };
 134
 135 /// \brief Shared implementation of use-lists for replaceable metadata.
 136 ///
 137 /// Most metadata cannot be RAUW'ed.  This is a shared implementation of
 138 /// use-lists and associated API for the two that support it (\a ValueAsMetadata
 139 /// and \a TempMDNode).
 140 class ReplaceableMetadataImpl {
 141   friend class MetadataTracking;
 142
 143 public:
 144   typedef MetadataTracking::OwnerTy OwnerTy;
 145
 146 private:
 147   LLVMContext &Context;
 148   uint64_t NextIndex;
 149   SmallDenseMap<void *, std::pair<OwnerTy, uint64_t>, 4> UseMap;
 150
 151 public:
 152   ReplaceableMetadataImpl(LLVMContext &Context)
 153       : Context(Context), NextIndex(0) {}
 154   ~ReplaceableMetadataImpl() {
 155     assert(UseMap.empty() && "Cannot destroy in-use replaceable metadata");
 156   }
 157
 158   LLVMContext &getContext() const { return Context; }
 159
 160   /// \brief Replace all uses of this with MD.
 161   ///
 162   /// Replace all uses of this with \c MD, which is allowed to be null.
 163   void replaceAllUsesWith(Metadata *MD);
 164
 165   /// \brief Resolve all uses of this.
 166   ///
 167   /// Resolve all uses of this, turning off RAUW permanently.  If \c
 168   /// ResolveUsers, call \a UniquableMDNode::resolve() on any users whose last
 169   /// operand is resolved.
 170   void resolveAllUses(bool ResolveUsers = true);
 171
 172 private:
 173   void addRef(void *Ref, OwnerTy Owner);
 174   void dropRef(void *Ref);
 175   void moveRef(void *Ref, void *New, const Metadata &MD);
 176
 177   static ReplaceableMetadataImpl *get(Metadata &MD);
 178 };
 179
 180 /// \brief Value wrapper in the Metadata hierarchy.
 181 ///
 182 /// This is a custom value handle that allows other metadata to refer to
 183 /// classes in the Value hierarchy.
 184 ///
 185 /// Because of full uniquing support, each value is only wrapped by a single \a
 186 /// ValueAsMetadata object, so the lookup maps are far more efficient than
 187 /// those using ValueHandleBase.
 188 class ValueAsMetadata : public Metadata, ReplaceableMetadataImpl {
 189   friend class ReplaceableMetadataImpl;
 190   friend class LLVMContextImpl;
 191
 192   Value *V;
 193
 194   /// \brief Drop users without RAUW (during teardown).
 195   void dropUsers() {
 196     ReplaceableMetadataImpl::resolveAllUses(/* ResolveUsers */ false);
 197   }
 198
 199 protected:
 200   ValueAsMetadata(unsigned ID, Value *V)
 201       : Metadata(ID, Uniqued), ReplaceableMetadataImpl(V->getContext()), V(V) {
 202     assert(V && "Expected valid value");
 203   }
 204   ~ValueAsMetadata() {}
 205
 206 public:
 207   static ValueAsMetadata *get(Value *V);
 208   static ConstantAsMetadata *getConstant(Value *C) {
 209     return cast<ConstantAsMetadata>(get(C));
 210   }
 211   static LocalAsMetadata *getLocal(Value *Local) {
 212     return cast<LocalAsMetadata>(get(Local));
 213   }
 214
 215   static ValueAsMetadata *getIfExists(Value *V);
 216   static ConstantAsMetadata *getConstantIfExists(Value *C) {
 217     return cast_or_null<ConstantAsMetadata>(getIfExists(C));
 218   }
 219   static LocalAsMetadata *getLocalIfExists(Value *Local) {
 220     return cast_or_null<LocalAsMetadata>(getIfExists(Local));
 221   }
 222
 223   Value *getValue() const { return V; }
 224   Type *getType() const { return V->getType(); }
 225   LLVMContext &getContext() const { return V->getContext(); }
 226
 227   static void handleDeletion(Value *V);
 228   static void handleRAUW(Value *From, Value *To);
 229
 230 protected:
 231   /// \brief Handle collisions after \a Value::replaceAllUsesWith().
 232   ///
 233   /// RAUW isn't supported directly for \a ValueAsMetadata, but if the wrapped
 234   /// \a Value gets RAUW'ed and the target already exists, this is used to
 235   /// merge the two metadata nodes.
 236   void replaceAllUsesWith(Metadata *MD) {
 237     ReplaceableMetadataImpl::replaceAllUsesWith(MD);
 238   }
 239
 240 public:
 241   static bool classof(const Metadata *MD) {
 242     return MD->getMetadataID() == LocalAsMetadataKind ||
 243            MD->getMetadataID() == ConstantAsMetadataKind;
 244   }
 245 };
 246
 247 class ConstantAsMetadata : public ValueAsMetadata {
 248   friend class ValueAsMetadata;
 249
 250   ConstantAsMetadata(Constant *C)
 251       : ValueAsMetadata(ConstantAsMetadataKind, C) {}
 252
 253 public:
 254   static ConstantAsMetadata *get(Constant *C) {
 255     return ValueAsMetadata::getConstant(C);
 256   }
 257   static ConstantAsMetadata *getIfExists(Constant *C) {
 258     return ValueAsMetadata::getConstantIfExists(C);
 259   }
 260
 261   Constant *getValue() const {
 262     return cast<Constant>(ValueAsMetadata::getValue());
 263   }
 264
 265   static bool classof(const Metadata *MD) {
 266     return MD->getMetadataID() == ConstantAsMetadataKind;
 267   }
 268 };
 269
 270 class LocalAsMetadata : public ValueAsMetadata {
 271   friend class ValueAsMetadata;
 272
 273   LocalAsMetadata(Value *Local)
 274       : ValueAsMetadata(LocalAsMetadataKind, Local) {
 275     assert(!isa<Constant>(Local) && "Expected local value");
 276   }
 277
 278 public:
 279   static LocalAsMetadata *get(Value *Local) {
 280     return ValueAsMetadata::getLocal(Local);
 281   }
 282   static LocalAsMetadata *getIfExists(Value *Local) {
 283     return ValueAsMetadata::getLocalIfExists(Local);
 284   }
 285
 286   static bool classof(const Metadata *MD) {
 287     return MD->getMetadataID() == LocalAsMetadataKind;
 288   }
 289 };
 290
 291 /// \brief Transitional API for extracting constants from Metadata.
 292 ///
 293 /// This namespace contains transitional functions for metadata that points to
 294 /// \a Constants.
 295 ///
 296 /// In prehistory -- when metadata was a subclass of \a Value -- \a MDNode
 297 /// operands could refer to any \a Value.  There's was a lot of code like this:
 298 ///
 299 /// \code
 300 ///     MDNode *N = ...;
 301 ///     auto *CI = dyn_cast<ConstantInt>(N->getOperand(2));
 302 /// \endcode
 303 ///
 304 /// Now that \a Value and \a Metadata are in separate hierarchies, maintaining
 305 /// the semantics for \a isa(), \a cast(), \a dyn_cast() (etc.) requires three
 306 /// steps: cast in the \a Metadata hierarchy, extraction of the \a Value, and
 307 /// cast in the \a Value hierarchy.  Besides creating boiler-plate, this
 308 /// requires subtle control flow changes.
 309 ///
 310 /// The end-goal is to create a new type of metadata, called (e.g.) \a MDInt,
 311 /// so that metadata can refer to numbers without traversing a bridge to the \a
 312 /// Value hierarchy.  In this final state, the code above would look like this:
 313 ///
 314 /// \code
 315 ///     MDNode *N = ...;
 316 ///     auto *MI = dyn_cast<MDInt>(N->getOperand(2));
 317 /// \endcode
 318 ///
 319 /// The API in this namespace supports the transition.  \a MDInt doesn't exist
 320 /// yet, and even once it does, changing each metadata schema to use it is its
 321 /// own mini-project.  In the meantime this API prevents us from introducing
 322 /// complex and bug-prone control flow that will disappear in the end.  In
 323 /// particular, the above code looks like this:
 324 ///
 325 /// \code
 326 ///     MDNode *N = ...;
 327 ///     auto *CI = mdconst::dyn_extract<ConstantInt>(N->getOperand(2));
 328 /// \endcode
 329 ///
 330 /// The full set of provided functions includes:
 331 ///
 332 ///   mdconst::hasa                <=> isa
 333 ///   mdconst::extract             <=> cast
 334 ///   mdconst::extract_or_null     <=> cast_or_null
 335 ///   mdconst::dyn_extract         <=> dyn_cast
 336 ///   mdconst::dyn_extract_or_null <=> dyn_cast_or_null
 337 ///
 338 /// The target of the cast must be a subclass of \a Constant.
 339 namespace mdconst {
 340
 341 namespace detail {
 342 template <class T> T &make();
 343 template <class T, class Result> struct HasDereference {
 344   typedef char Yes[1];
 345   typedef char No[2];
 346   template <size_t N> struct SFINAE {};
 347
 348   template <class U, class V>
 349   static Yes &hasDereference(SFINAE<sizeof(static_cast<V>(*make<U>()))> * = 0);
 350   template <class U, class V> static No &hasDereference(...);
 351
 352   static const bool value =
 353       sizeof(hasDereference<T, Result>(nullptr)) == sizeof(Yes);
 354 };
 355 template <class V, class M> struct IsValidPointer {
 356   static const bool value = std::is_base_of<Constant, V>::value &&
 357                             HasDereference<M, const Metadata &>::value;
 358 };
 359 template <class V, class M> struct IsValidReference {
 360   static const bool value = std::is_base_of<Constant, V>::value &&
 361                             std::is_convertible<M, const Metadata &>::value;
 362 };
 363 } // end namespace detail
 364
 365 /// \brief Check whether Metadata has a Value.
 366 ///
 367 /// As an analogue to \a isa(), check whether \c MD has an \a Value inside of
 368 /// type \c X.
 369 template <class X, class Y>
 370 inline typename std::enable_if<detail::IsValidPointer<X, Y>::value, bool>::type
 371 hasa(Y &&MD) {
 372   assert(MD && "Null pointer sent into hasa");
 373   if (auto *V = dyn_cast<ConstantAsMetadata>(MD))
 374     return isa<X>(V->getValue());
 375   return false;
 376 }
 377 template <class X, class Y>
 378 inline
 379     typename std::enable_if<detail::IsValidReference<X, Y &>::value, bool>::type
 380     hasa(Y &MD) {
 381   return hasa(&MD);
 382 }
 383
 384 /// \brief Extract a Value from Metadata.
 385 ///
 386 /// As an analogue to \a cast(), extract the \a Value subclass \c X from \c MD.
 387 template <class X, class Y>
 388 inline typename std::enable_if<detail::IsValidPointer<X, Y>::value, X *>::type
 389 extract(Y &&MD) {
 390   return cast<X>(cast<ConstantAsMetadata>(MD)->getValue());
 391 }
 392 template <class X, class Y>
 393 inline
 394     typename std::enable_if<detail::IsValidReference<X, Y &>::value, X *>::type
 395     extract(Y &MD) {
 396   return extract(&MD);
 397 }
 398
 399 /// \brief Extract a Value from Metadata, allowing null.
 400 ///
 401 /// As an analogue to \a cast_or_null(), extract the \a Value subclass \c X
 402 /// from \c MD, allowing \c MD to be null.
 403 template <class X, class Y>
 404 inline typename std::enable_if<detail::IsValidPointer<X, Y>::value, X *>::type
 405 extract_or_null(Y &&MD) {
 406   if (auto *V = cast_or_null<ConstantAsMetadata>(MD))
 407     return cast<X>(V->getValue());
 408   return nullptr;
 409 }
 410
 411 /// \brief Extract a Value from Metadata, if any.
 412 ///
 413 /// As an analogue to \a dyn_cast_or_null(), extract the \a Value subclass \c X
 414 /// from \c MD, return null if \c MD doesn't contain a \a Value or if the \a
 415 /// Value it does contain is of the wrong subclass.
 416 template <class X, class Y>
 417 inline typename std::enable_if<detail::IsValidPointer<X, Y>::value, X *>::type
 418 dyn_extract(Y &&MD) {
 419   if (auto *V = dyn_cast<ConstantAsMetadata>(MD))
 420     return dyn_cast<X>(V->getValue());
 421   return nullptr;
 422 }
 423
 424 /// \brief Extract a Value from Metadata, if any, allowing null.
 425 ///
 426 /// As an analogue to \a dyn_cast_or_null(), extract the \a Value subclass \c X
 427 /// from \c MD, return null if \c MD doesn't contain a \a Value or if the \a
 428 /// Value it does contain is of the wrong subclass, allowing \c MD to be null.
 429 template <class X, class Y>
 430 inline typename std::enable_if<detail::IsValidPointer<X, Y>::value, X *>::type
 431 dyn_extract_or_null(Y &&MD) {
 432   if (auto *V = dyn_cast_or_null<ConstantAsMetadata>(MD))
 433     return dyn_cast<X>(V->getValue());
 434   return nullptr;
 435 }
 436
 437 } // end namespace mdconst
 438
 439 //===----------------------------------------------------------------------===//
 440 /// \brief A single uniqued string.
 441 ///
 442 /// These are used to efficiently contain a byte sequence for metadata.
 443 /// MDString is always unnamed.
 444 class MDString : public Metadata {
 445   friend class StringMapEntry<MDString>;
 446
 447   MDString(const MDString &) LLVM_DELETED_FUNCTION;
 448   MDString &operator=(MDString &&) LLVM_DELETED_FUNCTION;
 449   MDString &operator=(const MDString &) LLVM_DELETED_FUNCTION;
 450
 451   StringMapEntry<MDString> *Entry;
 452   MDString() : Metadata(MDStringKind, Uniqued), Entry(nullptr) {}
 453   MDString(MDString &&) : Metadata(MDStringKind, Uniqued) {}
 454
 455 public:
 456   static MDString *get(LLVMContext &Context, StringRef Str);
 457   static MDString *get(LLVMContext &Context, const char *Str) {
 458     return get(Context, Str ? StringRef(Str) : StringRef());
 459   }
 460
 461   StringRef getString() const;
 462
 463   unsigned getLength() const { return (unsigned)getString().size(); }
 464
 465   typedef StringRef::iterator iterator;
 466
 467   /// \brief Pointer to the first byte of the string.
 468   iterator begin() const { return getString().begin(); }
 469
 470   /// \brief Pointer to one byte past the end of the string.
 471   iterator end() const { return getString().end(); }
 472
 473   const unsigned char *bytes_begin() const { return getString().bytes_begin(); }
 474   const unsigned char *bytes_end() const { return getString().bytes_end(); }
 475
 476   /// \brief Methods for support type inquiry through isa, cast, and dyn_cast.
 477   static bool classof(const Metadata *MD) {
 478     return MD->getMetadataID() == MDStringKind;
 479   }
 480 };
 481
 482 /// \brief A collection of metadata nodes that might be associated with a
 483 /// memory access used by the alias-analysis infrastructure.
 484 struct AAMDNodes {
 485   explicit AAMDNodes(MDNode *T = nullptr, MDNode *S = nullptr,
 486                      MDNode *N = nullptr)
 487       : TBAA(T), Scope(S), NoAlias(N) {}
 488
 489   bool operator==(const AAMDNodes &A) const {
 490     return TBAA == A.TBAA && Scope == A.Scope && NoAlias == A.NoAlias;
 491   }
 492
 493   bool operator!=(const AAMDNodes &A) const { return !(*this == A); }
 494
 495   LLVM_EXPLICIT operator bool() const { return TBAA || Scope || NoAlias; }
 496
 497   /// \brief The tag for type-based alias analysis.
 498   MDNode *TBAA;
 499
 500   /// \brief The tag for alias scope specification (used with noalias).
 501   MDNode *Scope;
 502
 503   /// \brief The tag specifying the noalias scope.
 504   MDNode *NoAlias;
 505 };
 506
 507 // Specialize DenseMapInfo for AAMDNodes.
 508 template<>
 509 struct DenseMapInfo<AAMDNodes> {
 510   static inline AAMDNodes getEmptyKey() {
 511     return AAMDNodes(DenseMapInfo<MDNode *>::getEmptyKey(), 0, 0);
 512   }
 513   static inline AAMDNodes getTombstoneKey() {
 514     return AAMDNodes(DenseMapInfo<MDNode *>::getTombstoneKey(), 0, 0);
 515   }
 516   static unsigned getHashValue(const AAMDNodes &Val) {
 517     return DenseMapInfo<MDNode *>::getHashValue(Val.TBAA) ^
 518            DenseMapInfo<MDNode *>::getHashValue(Val.Scope) ^
 519            DenseMapInfo<MDNode *>::getHashValue(Val.NoAlias);
 520   }
 521   static bool isEqual(const AAMDNodes &LHS, const AAMDNodes &RHS) {
 522     return LHS == RHS;
 523   }
 524 };
 525
 526 /// \brief Tracking metadata reference owned by Metadata.
 527 ///
 528 /// Similar to \a TrackingMDRef, but it's expected to be owned by an instance
 529 /// of \a Metadata, which has the option of registering itself for callbacks to
 530 /// re-unique itself.
 531 ///
 532 /// In particular, this is used by \a MDNode.
 533 class MDOperand {
 534   MDOperand(MDOperand &&) LLVM_DELETED_FUNCTION;
 535   MDOperand(const MDOperand &) LLVM_DELETED_FUNCTION;
 536   MDOperand &operator=(MDOperand &&) LLVM_DELETED_FUNCTION;
 537   MDOperand &operator=(const MDOperand &) LLVM_DELETED_FUNCTION;
 538
 539   Metadata *MD;
 540
 541 public:
 542   MDOperand() : MD(nullptr) {}
 543   ~MDOperand() { untrack(); }
 544
 545   Metadata *get() const { return MD; }
 546   operator Metadata *() const { return get(); }
 547   Metadata *operator->() const { return get(); }
 548   Metadata &operator*() const { return *get(); }
 549
 550   void reset() {
 551     untrack();
 552     MD = nullptr;
 553   }
 554   void reset(Metadata *MD, Metadata *Owner) {
 555     untrack();
 556     this->MD = MD;
 557     track(Owner);
 558   }
 559
 560 private:
 561   void track(Metadata *Owner) {
 562     if (MD) {
 563       if (Owner)
 564         MetadataTracking::track(this, *MD, *Owner);
 565       else
 566         MetadataTracking::track(MD);
 567     }
 568   }
 569   void untrack() {
 570     assert(static_cast<void *>(this) == &MD && "Expected same address");
 571     if (MD)
 572       MetadataTracking::untrack(MD);
 573   }
 574 };
 575
 576 template <> struct simplify_type<MDOperand> {
 577   typedef Metadata *SimpleType;
 578   static SimpleType getSimplifiedValue(MDOperand &MD) { return MD.get(); }
 579 };
 580
 581 template <> struct simplify_type<const MDOperand> {
 582   typedef Metadata *SimpleType;
 583   static SimpleType getSimplifiedValue(const MDOperand &MD) { return MD.get(); }
 584 };
 585
 586 /// \brief Pointer to the context, with optional RAUW support.
 587 ///
 588 /// Either a raw (non-null) pointer to the \a LLVMContext, or an owned pointer
 589 /// to \a ReplaceableMetadataImpl (which has a reference to \a LLVMContext).
 590 class ContextAndReplaceableUses {
 591   PointerUnion<LLVMContext *, ReplaceableMetadataImpl *> Ptr;
 592
 593   ContextAndReplaceableUses() LLVM_DELETED_FUNCTION;
 594   ContextAndReplaceableUses(ContextAndReplaceableUses &&)
 595       LLVM_DELETED_FUNCTION;
 596   ContextAndReplaceableUses(const ContextAndReplaceableUses &)
 597       LLVM_DELETED_FUNCTION;
 598   ContextAndReplaceableUses &
 599   operator=(ContextAndReplaceableUses &&) LLVM_DELETED_FUNCTION;
 600   ContextAndReplaceableUses &
 601   operator=(const ContextAndReplaceableUses &) LLVM_DELETED_FUNCTION;
 602
 603 public:
 604   ContextAndReplaceableUses(LLVMContext &Context) : Ptr(&Context) {}
 605   ContextAndReplaceableUses(
 606       std::unique_ptr<ReplaceableMetadataImpl> ReplaceableUses)
 607       : Ptr(ReplaceableUses.release()) {
 608     assert(getReplaceableUses() && "Expected non-null replaceable uses");
 609   }
 610   ~ContextAndReplaceableUses() { delete getReplaceableUses(); }
 611
 612   operator LLVMContext &() { return getContext(); }
 613
 614   /// \brief Whether this contains RAUW support.
 615   bool hasReplaceableUses() const {
 616     return Ptr.is<ReplaceableMetadataImpl *>();
 617   }
 618   LLVMContext &getContext() const {
 619     if (hasReplaceableUses())
 620       return getReplaceableUses()->getContext();
 621     return *Ptr.get<LLVMContext *>();
 622   }
 623   ReplaceableMetadataImpl *getReplaceableUses() const {
 624     if (hasReplaceableUses())
 625       return Ptr.get<ReplaceableMetadataImpl *>();
 626     return nullptr;
 627   }
 628
 629   /// \brief Assign RAUW support to this.
 630   ///
 631   /// Make this replaceable, taking ownership of \c ReplaceableUses (which must
 632   /// not be null).
 633   void
 634   makeReplaceable(std::unique_ptr<ReplaceableMetadataImpl> ReplaceableUses) {
 635     assert(ReplaceableUses && "Expected non-null replaceable uses");
 636     assert(&ReplaceableUses->getContext() == &getContext() &&
 637            "Expected same context");
 638     delete getReplaceableUses();
 639     Ptr = ReplaceableUses.release();
 640   }
 641
 642   /// \brief Drop RAUW support.
 643   ///
 644   /// Cede ownership of RAUW support, returning it.
 645   std::unique_ptr<ReplaceableMetadataImpl> takeReplaceableUses() {
 646     assert(hasReplaceableUses() && "Expected to own replaceable uses");
 647     std::unique_ptr<ReplaceableMetadataImpl> ReplaceableUses(
 648         getReplaceableUses());
 649     Ptr = &ReplaceableUses->getContext();
 650     return ReplaceableUses;
 651   }
 652 };
 653
 654 //===----------------------------------------------------------------------===//
 655 /// \brief Tuple of metadata.
 656 class MDNode : public Metadata {
 657   friend class ReplaceableMetadataImpl;
 658
 659   MDNode(const MDNode &) LLVM_DELETED_FUNCTION;
 660   void operator=(const MDNode &) LLVM_DELETED_FUNCTION;
 661   void *operator new(size_t) LLVM_DELETED_FUNCTION;
 662
 663 protected:
 664   ContextAndReplaceableUses Context;
 665
 666 private:
 667   unsigned NumOperands;
 668
 669 protected:
 670   unsigned MDNodeSubclassData;
 671
 672   void *operator new(size_t Size, unsigned NumOps);
 673   void operator delete(void *Mem);
 674
 675   /// \brief Required by std, but never called.
 676   void operator delete(void *, unsigned) {
 677     llvm_unreachable("Constructor throws?");
 678   }
 679
 680   /// \brief Required by std, but never called.
 681   void operator delete(void *, unsigned, bool) {
 682     llvm_unreachable("Constructor throws?");
 683   }
 684
 685   MDNode(LLVMContext &Context, unsigned ID, StorageType Storage,
 686          ArrayRef<Metadata *> MDs);
 687   ~MDNode() {}
 688
 689   void dropAllReferences();
 690
 691   MDOperand *mutable_begin() { return mutable_end() - NumOperands; }
 692   MDOperand *mutable_end() { return reinterpret_cast<MDOperand *>(this); }
 693
 694 public:
 695   static inline MDTuple *get(LLVMContext &Context, ArrayRef<Metadata *> MDs);
 696   static inline MDTuple *getIfExists(LLVMContext &Context,
 697                                      ArrayRef<Metadata *> MDs);
 698   static inline MDTuple *getDistinct(LLVMContext &Context,
 699                                      ArrayRef<Metadata *> MDs);
 700   static inline MDTuple *getTemporary(LLVMContext &Context,
 701                                       ArrayRef<Metadata *> MDs);
 702
 703   /// \brief Deallocate a node created by getTemporary.
 704   ///
 705   /// The node must not have any users.
 706   static void deleteTemporary(MDNode *N);
 707
 708   LLVMContext &getContext() const { return Context.getContext(); }
 709
 710   /// \brief Replace a specific operand.
 711   void replaceOperandWith(unsigned I, Metadata *New);
 712
 713   /// \brief Check if node is fully resolved.
 714   ///
 715   /// If \a isTemporary(), this always returns \c false; if \a isDistinct(),
 716   /// this always returns \c true.
 717   ///
 718   /// If \a isUniqued(), returns \c true if this has already dropped RAUW
 719   /// support (because all operands are resolved).
 720   ///
 721   /// As forward declarations are resolved, their containers should get
 722   /// resolved automatically.  However, if this (or one of its operands) is
 723   /// involved in a cycle, \a resolveCycles() needs to be called explicitly.
 724   bool isResolved() const { return !Context.hasReplaceableUses(); }
 725
 726   bool isUniqued() const { return Storage == Uniqued; }
 727   bool isDistinct() const { return Storage == Distinct; }
 728   bool isTemporary() const { return Storage == Temporary; }
 729
 730   /// \brief RAUW a temporary.
 731   ///
 732   /// \pre \a isTemporary() must be \c true.
 733   void replaceAllUsesWith(Metadata *MD) {
 734     assert(isTemporary() && "Expected temporary node");
 735     assert(!isResolved() && "Expected RAUW support");
 736     Context.getReplaceableUses()->replaceAllUsesWith(MD);
 737   }
 738
 739 protected:
 740   /// \brief Set an operand.
 741   ///
 742   /// Sets the operand directly, without worrying about uniquing.
 743   void setOperand(unsigned I, Metadata *New);
 744
 745 public:
 746   typedef const MDOperand *op_iterator;
 747   typedef iterator_range<op_iterator> op_range;
 748
 749   op_iterator op_begin() const {
 750     return const_cast<MDNode *>(this)->mutable_begin();
 751   }
 752   op_iterator op_end() const {
 753     return const_cast<MDNode *>(this)->mutable_end();
 754   }
 755   op_range operands() const { return op_range(op_begin(), op_end()); }
 756
 757   const MDOperand &getOperand(unsigned I) const {
 758     assert(I < NumOperands && "Out of range");
 759     return op_begin()[I];
 760   }
 761
 762   /// \brief Return number of MDNode operands.
 763   unsigned getNumOperands() const { return NumOperands; }
 764
 765   /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
 766   static bool classof(const Metadata *MD) {
 767     return MD->getMetadataID() == MDTupleKind ||
 768            MD->getMetadataID() == MDLocationKind;
 769   }
 770
 771   /// \brief Check whether MDNode is a vtable access.
 772   bool isTBAAVtableAccess() const;
 773
 774   /// \brief Methods for metadata merging.
 775   static MDNode *concatenate(MDNode *A, MDNode *B);
 776   static MDNode *intersect(MDNode *A, MDNode *B);
 777   static MDNode *getMostGenericTBAA(MDNode *A, MDNode *B);
 778   static AAMDNodes getMostGenericAA(const AAMDNodes &A, const AAMDNodes &B);
 779   static MDNode *getMostGenericFPMath(MDNode *A, MDNode *B);
 780   static MDNode *getMostGenericRange(MDNode *A, MDNode *B);
 781 };
 782
 783 /// \brief Uniquable metadata node.
 784 ///
 785 /// A uniquable metadata node.  This contains the basic functionality
 786 /// for implementing sub-types of \a MDNode that can be uniqued like
 787 /// constants.
 788 ///
 789 /// There is limited support for RAUW at construction time.  At construction
 790 /// time, if any operand is a temporary node (or an unresolved uniqued node,
 791 /// which indicates a transitive temporary operand), the node itself will be
 792 /// unresolved.  As soon as all operands become resolved, it will drop RAUW
 793 /// support permanently.
 794 ///
 795 /// If an unresolved node is part of a cycle, \a resolveCycles() needs
 796 /// to be called on some member of the cycle once all temporary nodes have been
 797 /// replaced.
 798 class UniquableMDNode : public MDNode {
 799   friend class ReplaceableMetadataImpl;
 800   friend class MDNode;
 801   friend class LLVMContextImpl;
 802
 803 protected:
 804   /// \brief Create a new node.
 805   ///
 806   /// If \c AllowRAUW, then if any operands are unresolved support RAUW.  RAUW
 807   /// will be dropped once all operands have been resolved (or if \a
 808   /// resolveCycles() is called).
 809   UniquableMDNode(LLVMContext &C, unsigned ID, StorageType Storage,
 810                   ArrayRef<Metadata *> Vals);
 811   ~UniquableMDNode() {}
 812
 813   void storeDistinctInContext();
 814   template <class T, class StoreT>
 815   static T *storeImpl(T *N, StorageType Storage, StoreT &Store);
 816
 817 public:
 818   static bool classof(const Metadata *MD) {
 819     return MD->getMetadataID() == MDTupleKind ||
 820            MD->getMetadataID() == MDLocationKind;
 821   }
 822
 823   /// \brief Resolve cycles.
 824   ///
 825   /// Once all forward declarations have been resolved, force cycles to be
 826   /// resolved.
 827   ///
 828   /// \pre No operands (or operands' operands, etc.) have \a isTemporary().
 829   void resolveCycles();
 830
 831 private:
 832   void handleChangedOperand(void *Ref, Metadata *New);
 833
 834   void resolve();
 835   void resolveAfterOperandChange(Metadata *Old, Metadata *New);
 836   void decrementUnresolvedOperandCount();
 837
 838   void deleteAsSubclass();
 839   UniquableMDNode *uniquify();
 840   void eraseFromStore();
 841 };
 842
 843 /// \brief Tuple of metadata.
 844 ///
 845 /// This is the simple \a MDNode arbitrary tuple.  Nodes are uniqued by
 846 /// default based on their operands.
 847 class MDTuple : public UniquableMDNode {
 848   friend class LLVMContextImpl;
 849   friend class UniquableMDNode;
 850
 851   MDTuple(LLVMContext &C, StorageType Storage, unsigned Hash,
 852           ArrayRef<Metadata *> Vals)
 853       : UniquableMDNode(C, MDTupleKind, Storage, Vals) {
 854     setHash(Hash);
 855   }
 856   ~MDTuple() { dropAllReferences(); }
 857
 858   void setHash(unsigned Hash) { MDNodeSubclassData = Hash; }
 859   void recalculateHash();
 860
 861   static MDTuple *getImpl(LLVMContext &Context, ArrayRef<Metadata *> MDs,
 862                           StorageType Storage, bool ShouldCreate = true);
 863
 864 public:
 865   /// \brief Get the hash, if any.
 866   unsigned getHash() const { return MDNodeSubclassData; }
 867
 868   static MDTuple *get(LLVMContext &Context, ArrayRef<Metadata *> MDs) {
 869     return getImpl(Context, MDs, Uniqued);
 870   }
 871   static MDTuple *getIfExists(LLVMContext &Context, ArrayRef<Metadata *> MDs) {
 872     return getImpl(Context, MDs, Uniqued, /* ShouldCreate */ false);
 873   }
 874
 875   /// \brief Return a distinct node.
 876   ///
 877   /// Return a distinct node -- i.e., a node that is not uniqued.
 878   static MDTuple *getDistinct(LLVMContext &Context, ArrayRef<Metadata *> MDs) {
 879     return getImpl(Context, MDs, Distinct);
 880   }
 881
 882   /// \brief Return a temporary node.
 883   ///
 884   /// For use in constructing cyclic MDNode structures. A temporary MDNode is
 885   /// not uniqued, may be RAUW'd, and must be manually deleted with
 886   /// deleteTemporary.
 887   static MDTuple *getTemporary(LLVMContext &Context, ArrayRef<Metadata *> MDs) {
 888     return getImpl(Context, MDs, Temporary);
 889   }
 890
 891   static bool classof(const Metadata *MD) {
 892     return MD->getMetadataID() == MDTupleKind;
 893   }
 894
 895 private:
 896   MDTuple *uniquifyImpl();
 897   void eraseFromStoreImpl();
 898 };
 899
 900 MDTuple *MDNode::get(LLVMContext &Context, ArrayRef<Metadata *> MDs) {
 901   return MDTuple::get(Context, MDs);
 902 }
 903 MDTuple *MDNode::getIfExists(LLVMContext &Context, ArrayRef<Metadata *> MDs) {
 904   return MDTuple::getIfExists(Context, MDs);
 905 }
 906 MDTuple *MDNode::getDistinct(LLVMContext &Context, ArrayRef<Metadata *> MDs) {
 907   return MDTuple::getDistinct(Context, MDs);
 908 }
 909 MDTuple *MDNode::getTemporary(LLVMContext &Context, ArrayRef<Metadata *> MDs) {
 910   return MDTuple::getTemporary(Context, MDs);
 911 }
 912
 913 /// \brief Debug location.
 914 ///
 915 /// A debug location in source code, used for debug info and otherwise.
 916 class MDLocation : public UniquableMDNode {
 917   friend class LLVMContextImpl;
 918   friend class UniquableMDNode;
 919
 920   MDLocation(LLVMContext &C, StorageType Storage, unsigned Line,
 921              unsigned Column, ArrayRef<Metadata *> MDs);
 922   ~MDLocation() { dropAllReferences(); }
 923
 924   static MDLocation *getImpl(LLVMContext &Context, unsigned Line,
 925                              unsigned Column, Metadata *Scope,
 926                              Metadata *InlinedAt, StorageType Storage,
 927                              bool ShouldCreate = true);
 928
 929   // Disallow replacing operands.
 930   void replaceOperandWith(unsigned I, Metadata *New) LLVM_DELETED_FUNCTION;
 931
 932 public:
 933   static MDLocation *get(LLVMContext &Context, unsigned Line, unsigned Column,
 934                          Metadata *Scope, Metadata *InlinedAt = nullptr) {
 935     return getImpl(Context, Line, Column, Scope, InlinedAt, Uniqued);
 936   }
 937   static MDLocation *getIfExists(LLVMContext &Context, unsigned Line,
 938                                  unsigned Column, Metadata *Scope,
 939                                  Metadata *InlinedAt = nullptr) {
 940     return getImpl(Context, Line, Column, Scope, InlinedAt, Uniqued,
 941                    /* ShouldCreate */ false);
 942   }
 943   static MDLocation *getDistinct(LLVMContext &Context, unsigned Line,
 944                                  unsigned Column, Metadata *Scope,
 945                                  Metadata *InlinedAt = nullptr) {
 946     return getImpl(Context, Line, Column, Scope, InlinedAt, Distinct);
 947   }
 948
 949   unsigned getLine() const { return MDNodeSubclassData; }
 950   unsigned getColumn() const { return SubclassData16; }
 951   Metadata *getScope() const { return getOperand(0); }
 952   Metadata *getInlinedAt() const {
 953     if (getNumOperands() == 2)
 954       return getOperand(1);
 955     return nullptr;
 956   }
 957
 958   static bool classof(const Metadata *MD) {
 959     return MD->getMetadataID() == MDLocationKind;
 960   }
 961
 962 private:
 963   MDLocation *uniquifyImpl();
 964   void eraseFromStoreImpl();
 965 };
 966
 967 //===----------------------------------------------------------------------===//
 968 /// \brief A tuple of MDNodes.
 969 ///
 970 /// Despite its name, a NamedMDNode isn't itself an MDNode. NamedMDNodes belong
 971 /// to modules, have names, and contain lists of MDNodes.
 972 ///
 973 /// TODO: Inherit from Metadata.
 974 class NamedMDNode : public ilist_node<NamedMDNode> {
 975   friend class SymbolTableListTraits<NamedMDNode, Module>;
 976   friend struct ilist_traits<NamedMDNode>;
 977   friend class LLVMContextImpl;
 978   friend class Module;
 979   NamedMDNode(const NamedMDNode &) LLVM_DELETED_FUNCTION;
 980
 981   std::string Name;
 982   Module *Parent;
 983   void *Operands; // SmallVector<TrackingMDRef, 4>
 984
 985   void setParent(Module *M) { Parent = M; }
 986
 987   explicit NamedMDNode(const Twine &N);
 988
 989   template<class T1, class T2>
 990   class op_iterator_impl :
 991       public std::iterator<std::bidirectional_iterator_tag, T2> {
 992     const NamedMDNode *Node;
 993     unsigned Idx;
 994     op_iterator_impl(const NamedMDNode *N, unsigned i) : Node(N), Idx(i) { }
 995
 996     friend class NamedMDNode;
 997
 998   public:
 999     op_iterator_impl() : Node(nullptr), Idx(0) { }
1000
1001     bool operator==(const op_iterator_impl &o) const { return Idx == o.Idx; }
1002     bool operator!=(const op_iterator_impl &o) const { return Idx != o.Idx; }
1003     op_iterator_impl &operator++() {
1004       ++Idx;
1005       return *this;
1006     }
1007     op_iterator_impl operator++(int) {
1008       op_iterator_impl tmp(*this);
1009       operator++();
1010       return tmp;
1011     }
1012     op_iterator_impl &operator--() {
1013       --Idx;
1014       return *this;
1015     }
1016     op_iterator_impl operator--(int) {
1017       op_iterator_impl tmp(*this);
1018       operator--();
1019       return tmp;
1020     }
1021
1022     T1 operator*() const { return Node->getOperand(Idx); }
1023   };
1024
1025 public:
1026   /// \brief Drop all references and remove the node from parent module.
1027   void eraseFromParent();
1028
1029   /// \brief Remove all uses and clear node vector.
1030   void dropAllReferences();
1031
1032   ~NamedMDNode();
1033
1034   /// \brief Get the module that holds this named metadata collection.
1035   inline Module *getParent() { return Parent; }
1036   inline const Module *getParent() const { return Parent; }
1037
1038   MDNode *getOperand(unsigned i) const;
1039   unsigned getNumOperands() const;
1040   void addOperand(MDNode *M);
1041   void setOperand(unsigned I, MDNode *New);
1042   StringRef getName() const;
1043   void print(raw_ostream &ROS) const;
1044   void dump() const;
1045
1046   // ---------------------------------------------------------------------------
1047   // Operand Iterator interface...
1048   //
1049   typedef op_iterator_impl<MDNode *, MDNode> op_iterator;
1050   op_iterator op_begin() { return op_iterator(this, 0); }
1051   op_iterator op_end()   { return op_iterator(this, getNumOperands()); }
1052
1053   typedef op_iterator_impl<const MDNode *, MDNode> const_op_iterator;
1054   const_op_iterator op_begin() const { return const_op_iterator(this, 0); }
1055   const_op_iterator op_end()   const { return const_op_iterator(this, getNumOperands()); }
1056
1057   inline iterator_range<op_iterator>  operands() {
1058     return iterator_range<op_iterator>(op_begin(), op_end());
1059   }
1060   inline iterator_range<const_op_iterator> operands() const {
1061     return iterator_range<const_op_iterator>(op_begin(), op_end());
1062   }
1063 };
1064
1065 } // end llvm namespace
1066
1067 #endif