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 Storage flag for non-uniqued, otherwise unowned, metadata.
  51   bool IsDistinctInContext : 1;
  52   bool InRAUW : 1;
  53   // TODO: expose remaining bits to subclasses.
  54
  55   unsigned short SubclassData16;
  56   unsigned SubclassData32;
  57
  58 public:
  59   enum MetadataKind {
  60     GenericMDNodeKind,
  61     MDNodeFwdDeclKind,
  62     ConstantAsMetadataKind,
  63     LocalAsMetadataKind,
  64     MDStringKind
  65   };
  66
  67 protected:
  68   Metadata(unsigned ID)
  69       : SubclassID(ID), IsDistinctInContext(false), InRAUW(false),
  70         SubclassData16(0), SubclassData32(0) {}
  71   ~Metadata() {}
  72
  73   /// \brief Store this in a big non-uniqued untyped bucket.
  74   bool isStoredDistinctInContext() const { return IsDistinctInContext; }
  75
  76   /// \brief Default handling of a changed operand, which asserts.
  77   ///
  78   /// If subclasses pass themselves in as owners to a tracking node reference,
  79   /// they must provide an implementation of this method.
  80   void handleChangedOperand(void *, Metadata *) {
  81     llvm_unreachable("Unimplemented in Metadata subclass");
  82   }
  83
  84 public:
  85   unsigned getMetadataID() const { return SubclassID; }
  86
  87   /// \brief User-friendly dump.
  88   void dump() const;
  89   void print(raw_ostream &OS) const;
  90   void printAsOperand(raw_ostream &OS, bool PrintType = true,
  91                       const Module *M = nullptr) const;
  92 };
  93
  94 #define HANDLE_METADATA(CLASS) class CLASS;
  95 #include "llvm/IR/Metadata.def"
  96
  97 inline raw_ostream &operator<<(raw_ostream &OS, const Metadata &MD) {
  98   MD.print(OS);
  99   return OS;
 100 }
 101
 102 /// \brief Metadata wrapper in the Value hierarchy.
 103 ///
 104 /// A member of the \a Value hierarchy to represent a reference to metadata.
 105 /// This allows, e.g., instrinsics to have metadata as operands.
 106 ///
 107 /// Notably, this is the only thing in either hierarchy that is allowed to
 108 /// reference \a LocalAsMetadata.
 109 class MetadataAsValue : public Value {
 110   friend class ReplaceableMetadataImpl;
 111   friend class LLVMContextImpl;
 112
 113   Metadata *MD;
 114
 115   MetadataAsValue(Type *Ty, Metadata *MD);
 116   ~MetadataAsValue();
 117
 118 public:
 119   static MetadataAsValue *get(LLVMContext &Context, Metadata *MD);
 120   static MetadataAsValue *getIfExists(LLVMContext &Context, Metadata *MD);
 121   Metadata *getMetadata() const { return MD; }
 122
 123   static bool classof(const Value *V) {
 124     return V->getValueID() == MetadataAsValueVal;
 125   }
 126
 127 private:
 128   void handleChangedMetadata(Metadata *MD);
 129   void track();
 130   void untrack();
 131 };
 132
 133 /// \brief Shared implementation of use-lists for replaceable metadata.
 134 ///
 135 /// Most metadata cannot be RAUW'ed.  This is a shared implementation of
 136 /// use-lists and associated API for the two that support it (\a ValueAsMetadata
 137 /// and \a TempMDNode).
 138 class ReplaceableMetadataImpl {
 139   friend class MetadataTracking;
 140
 141 public:
 142   typedef MetadataTracking::OwnerTy OwnerTy;
 143
 144 private:
 145   uint64_t NextIndex;
 146   SmallDenseMap<void *, std::pair<OwnerTy, uint64_t>, 4> UseMap;
 147
 148 public:
 149   ReplaceableMetadataImpl() : NextIndex(0) {}
 150   ~ReplaceableMetadataImpl() {
 151     assert(UseMap.empty() && "Cannot destroy in-use replaceable metadata");
 152   }
 153
 154   /// \brief Replace all uses of this with MD.
 155   ///
 156   /// Replace all uses of this with \c MD, which is allowed to be null.
 157   void replaceAllUsesWith(Metadata *MD);
 158
 159   /// \brief Resolve all uses of this.
 160   ///
 161   /// Resolve all uses of this, turning off RAUW permanently.  If \c
 162   /// ResolveUsers, call \a GenericMDNode::resolve() on any users whose last
 163   /// operand is resolved.
 164   void resolveAllUses(bool ResolveUsers = true);
 165
 166 private:
 167   void addRef(void *Ref, OwnerTy Owner);
 168   void dropRef(void *Ref);
 169   void moveRef(void *Ref, void *New, const Metadata &MD);
 170
 171   static ReplaceableMetadataImpl *get(Metadata &MD);
 172 };
 173
 174 /// \brief Value wrapper in the Metadata hierarchy.
 175 ///
 176 /// This is a custom value handle that allows other metadata to refer to
 177 /// classes in the Value hierarchy.
 178 ///
 179 /// Because of full uniquing support, each value is only wrapped by a single \a
 180 /// ValueAsMetadata object, so the lookup maps are far more efficient than
 181 /// those using ValueHandleBase.
 182 class ValueAsMetadata : public Metadata, ReplaceableMetadataImpl {
 183   friend class ReplaceableMetadataImpl;
 184   friend class LLVMContextImpl;
 185
 186   Value *V;
 187
 188 protected:
 189   ValueAsMetadata(LLVMContext &Context, unsigned ID, Value *V)
 190       : Metadata(ID), V(V) {
 191     assert(V && "Expected valid value");
 192   }
 193   ~ValueAsMetadata() {}
 194
 195 public:
 196   static ValueAsMetadata *get(Value *V);
 197   static ConstantAsMetadata *getConstant(Value *C) {
 198     return cast<ConstantAsMetadata>(get(C));
 199   }
 200   static LocalAsMetadata *getLocal(Value *Local) {
 201     return cast<LocalAsMetadata>(get(Local));
 202   }
 203
 204   static ValueAsMetadata *getIfExists(Value *V);
 205   static ConstantAsMetadata *getConstantIfExists(Value *C) {
 206     return cast_or_null<ConstantAsMetadata>(getIfExists(C));
 207   }
 208   static LocalAsMetadata *getLocalIfExists(Value *Local) {
 209     return cast_or_null<LocalAsMetadata>(getIfExists(Local));
 210   }
 211
 212   Value *getValue() const { return V; }
 213   Type *getType() const { return V->getType(); }
 214   LLVMContext &getContext() const { return V->getContext(); }
 215
 216   static void handleDeletion(Value *V);
 217   static void handleRAUW(Value *From, Value *To);
 218
 219 protected:
 220   /// \brief Handle collisions after \a Value::replaceAllUsesWith().
 221   ///
 222   /// RAUW isn't supported directly for \a ValueAsMetadata, but if the wrapped
 223   /// \a Value gets RAUW'ed and the target already exists, this is used to
 224   /// merge the two metadata nodes.
 225   void replaceAllUsesWith(Metadata *MD) {
 226     ReplaceableMetadataImpl::replaceAllUsesWith(MD);
 227   }
 228
 229 public:
 230   static bool classof(const Metadata *MD) {
 231     return MD->getMetadataID() == LocalAsMetadataKind ||
 232            MD->getMetadataID() == ConstantAsMetadataKind;
 233   }
 234 };
 235
 236 class ConstantAsMetadata : public ValueAsMetadata {
 237   friend class ValueAsMetadata;
 238
 239   ConstantAsMetadata(LLVMContext &Context, Constant *C)
 240       : ValueAsMetadata(Context, ConstantAsMetadataKind, C) {}
 241
 242 public:
 243   static ConstantAsMetadata *get(Constant *C) {
 244     return ValueAsMetadata::getConstant(C);
 245   }
 246   static ConstantAsMetadata *getIfExists(Constant *C) {
 247     return ValueAsMetadata::getConstantIfExists(C);
 248   }
 249
 250   Constant *getValue() const {
 251     return cast<Constant>(ValueAsMetadata::getValue());
 252   }
 253
 254   static bool classof(const Metadata *MD) {
 255     return MD->getMetadataID() == ConstantAsMetadataKind;
 256   }
 257 };
 258
 259 class LocalAsMetadata : public ValueAsMetadata {
 260   friend class ValueAsMetadata;
 261
 262   LocalAsMetadata(LLVMContext &Context, Value *Local)
 263       : ValueAsMetadata(Context, LocalAsMetadataKind, Local) {
 264     assert(!isa<Constant>(Local) && "Expected local value");
 265   }
 266
 267 public:
 268   static LocalAsMetadata *get(Value *Local) {
 269     return ValueAsMetadata::getLocal(Local);
 270   }
 271   static LocalAsMetadata *getIfExists(Value *Local) {
 272     return ValueAsMetadata::getLocalIfExists(Local);
 273   }
 274
 275   static bool classof(const Metadata *MD) {
 276     return MD->getMetadataID() == LocalAsMetadataKind;
 277   }
 278 };
 279
 280 /// \brief Transitional API for extracting constants from Metadata.
 281 ///
 282 /// This namespace contains transitional functions for metadata that points to
 283 /// \a Constants.
 284 ///
 285 /// In prehistory -- when metadata was a subclass of \a Value -- \a MDNode
 286 /// operands could refer to any \a Value.  There's was a lot of code like this:
 287 ///
 288 /// \code
 289 ///     MDNode *N = ...;
 290 ///     auto *CI = dyn_cast<ConstantInt>(N->getOperand(2));
 291 /// \endcode
 292 ///
 293 /// Now that \a Value and \a Metadata are in separate hierarchies, maintaining
 294 /// the semantics for \a isa(), \a cast(), \a dyn_cast() (etc.) requires three
 295 /// steps: cast in the \a Metadata hierarchy, extraction of the \a Value, and
 296 /// cast in the \a Value hierarchy.  Besides creating boiler-plate, this
 297 /// requires subtle control flow changes.
 298 ///
 299 /// The end-goal is to create a new type of metadata, called (e.g.) \a MDInt,
 300 /// so that metadata can refer to numbers without traversing a bridge to the \a
 301 /// Value hierarchy.  In this final state, the code above would look like this:
 302 ///
 303 /// \code
 304 ///     MDNode *N = ...;
 305 ///     auto *MI = dyn_cast<MDInt>(N->getOperand(2));
 306 /// \endcode
 307 ///
 308 /// The API in this namespace supports the transition.  \a MDInt doesn't exist
 309 /// yet, and even once it does, changing each metadata schema to use it is its
 310 /// own mini-project.  In the meantime this API prevents us from introducing
 311 /// complex and bug-prone control flow that will disappear in the end.  In
 312 /// particular, the above code looks like this:
 313 ///
 314 /// \code
 315 ///     MDNode *N = ...;
 316 ///     auto *CI = mdconst::dyn_extract<ConstantInt>(N->getOperand(2));
 317 /// \endcode
 318 ///
 319 /// The full set of provided functions includes:
 320 ///
 321 ///   mdconst::hasa                <=> isa
 322 ///   mdconst::extract             <=> cast
 323 ///   mdconst::extract_or_null     <=> cast_or_null
 324 ///   mdconst::dyn_extract         <=> dyn_cast
 325 ///   mdconst::dyn_extract_or_null <=> dyn_cast_or_null
 326 ///
 327 /// The target of the cast must be a subclass of \a Constant.
 328 namespace mdconst {
 329
 330 namespace detail {
 331 template <class T> T &make();
 332 template <class T, class Result> struct HasDereference {
 333   typedef char Yes[1];
 334   typedef char No[2];
 335   template <size_t N> struct SFINAE {};
 336
 337   template <class U, class V>
 338   static Yes &hasDereference(SFINAE<sizeof(static_cast<V>(*make<U>()))> * = 0);
 339   template <class U, class V> static No &hasDereference(...);
 340
 341   static const bool value =
 342       sizeof(hasDereference<T, Result>(nullptr)) == sizeof(Yes);
 343 };
 344 template <class V, class M> struct IsValidPointer {
 345   static const bool value = std::is_base_of<Constant, V>::value &&
 346                             HasDereference<M, const Metadata &>::value;
 347 };
 348 template <class V, class M> struct IsValidReference {
 349   static const bool value = std::is_base_of<Constant, V>::value &&
 350                             std::is_convertible<M, const Metadata &>::value;
 351 };
 352 } // end namespace detail
 353
 354 /// \brief Check whether Metadata has a Value.
 355 ///
 356 /// As an analogue to \a isa(), check whether \c MD has an \a Value inside of
 357 /// type \c X.
 358 template <class X, class Y>
 359 inline typename std::enable_if<detail::IsValidPointer<X, Y>::value, bool>::type
 360 hasa(Y &&MD) {
 361   assert(MD && "Null pointer sent into hasa");
 362   if (auto *V = dyn_cast<ConstantAsMetadata>(MD))
 363     return isa<X>(V->getValue());
 364   return false;
 365 }
 366 template <class X, class Y>
 367 inline
 368     typename std::enable_if<detail::IsValidReference<X, Y &>::value, bool>::type
 369     hasa(Y &MD) {
 370   return hasa(&MD);
 371 }
 372
 373 /// \brief Extract a Value from Metadata.
 374 ///
 375 /// As an analogue to \a cast(), extract the \a Value subclass \c X from \c MD.
 376 template <class X, class Y>
 377 inline typename std::enable_if<detail::IsValidPointer<X, Y>::value, X *>::type
 378 extract(Y &&MD) {
 379   return cast<X>(cast<ConstantAsMetadata>(MD)->getValue());
 380 }
 381 template <class X, class Y>
 382 inline
 383     typename std::enable_if<detail::IsValidReference<X, Y &>::value, X *>::type
 384     extract(Y &MD) {
 385   return extract(&MD);
 386 }
 387
 388 /// \brief Extract a Value from Metadata, allowing null.
 389 ///
 390 /// As an analogue to \a cast_or_null(), extract the \a Value subclass \c X
 391 /// from \c MD, allowing \c MD to be null.
 392 template <class X, class Y>
 393 inline typename std::enable_if<detail::IsValidPointer<X, Y>::value, X *>::type
 394 extract_or_null(Y &&MD) {
 395   if (auto *V = cast_or_null<ConstantAsMetadata>(MD))
 396     return cast<X>(V->getValue());
 397   return nullptr;
 398 }
 399
 400 /// \brief Extract a Value from Metadata, if any.
 401 ///
 402 /// As an analogue to \a dyn_cast_or_null(), extract the \a Value subclass \c X
 403 /// from \c MD, return null if \c MD doesn't contain a \a Value or if the \a
 404 /// Value it does contain is of the wrong subclass.
 405 template <class X, class Y>
 406 inline typename std::enable_if<detail::IsValidPointer<X, Y>::value, X *>::type
 407 dyn_extract(Y &&MD) {
 408   if (auto *V = dyn_cast<ConstantAsMetadata>(MD))
 409     return dyn_cast<X>(V->getValue());
 410   return nullptr;
 411 }
 412
 413 /// \brief Extract a Value from Metadata, if any, allowing null.
 414 ///
 415 /// As an analogue to \a dyn_cast_or_null(), extract the \a Value subclass \c X
 416 /// from \c MD, return null if \c MD doesn't contain a \a Value or if the \a
 417 /// Value it does contain is of the wrong subclass, allowing \c MD to be null.
 418 template <class X, class Y>
 419 inline typename std::enable_if<detail::IsValidPointer<X, Y>::value, X *>::type
 420 dyn_extract_or_null(Y &&MD) {
 421   if (auto *V = dyn_cast_or_null<ConstantAsMetadata>(MD))
 422     return dyn_cast<X>(V->getValue());
 423   return nullptr;
 424 }
 425
 426 } // end namespace mdconst
 427
 428 //===----------------------------------------------------------------------===//
 429 /// \brief A single uniqued string.
 430 ///
 431 /// These are used to efficiently contain a byte sequence for metadata.
 432 /// MDString is always unnamed.
 433 class MDString : public Metadata {
 434   friend class StringMapEntry<MDString>;
 435
 436   MDString(const MDString &) LLVM_DELETED_FUNCTION;
 437   MDString &operator=(MDString &&) LLVM_DELETED_FUNCTION;
 438   MDString &operator=(const MDString &) LLVM_DELETED_FUNCTION;
 439
 440   StringMapEntry<MDString> *Entry;
 441   MDString() : Metadata(MDStringKind), Entry(nullptr) {}
 442   MDString(MDString &&) : Metadata(MDStringKind) {}
 443
 444 public:
 445   static MDString *get(LLVMContext &Context, StringRef Str);
 446   static MDString *get(LLVMContext &Context, const char *Str) {
 447     return get(Context, Str ? StringRef(Str) : StringRef());
 448   }
 449
 450   StringRef getString() const;
 451
 452   unsigned getLength() const { return (unsigned)getString().size(); }
 453
 454   typedef StringRef::iterator iterator;
 455
 456   /// \brief Pointer to the first byte of the string.
 457   iterator begin() const { return getString().begin(); }
 458
 459   /// \brief Pointer to one byte past the end of the string.
 460   iterator end() const { return getString().end(); }
 461
 462   /// \brief Methods for support type inquiry through isa, cast, and dyn_cast.
 463   static bool classof(const Metadata *MD) {
 464     return MD->getMetadataID() == MDStringKind;
 465   }
 466 };
 467
 468 /// \brief A collection of metadata nodes that might be associated with a
 469 /// memory access used by the alias-analysis infrastructure.
 470 struct AAMDNodes {
 471   explicit AAMDNodes(MDNode *T = nullptr, MDNode *S = nullptr,
 472                      MDNode *N = nullptr)
 473       : TBAA(T), Scope(S), NoAlias(N) {}
 474
 475   bool operator==(const AAMDNodes &A) const {
 476     return TBAA == A.TBAA && Scope == A.Scope && NoAlias == A.NoAlias;
 477   }
 478
 479   bool operator!=(const AAMDNodes &A) const { return !(*this == A); }
 480
 481   LLVM_EXPLICIT operator bool() const { return TBAA || Scope || NoAlias; }
 482
 483   /// \brief The tag for type-based alias analysis.
 484   MDNode *TBAA;
 485
 486   /// \brief The tag for alias scope specification (used with noalias).
 487   MDNode *Scope;
 488
 489   /// \brief The tag specifying the noalias scope.
 490   MDNode *NoAlias;
 491 };
 492
 493 // Specialize DenseMapInfo for AAMDNodes.
 494 template<>
 495 struct DenseMapInfo<AAMDNodes> {
 496   static inline AAMDNodes getEmptyKey() {
 497     return AAMDNodes(DenseMapInfo<MDNode *>::getEmptyKey(), 0, 0);
 498   }
 499   static inline AAMDNodes getTombstoneKey() {
 500     return AAMDNodes(DenseMapInfo<MDNode *>::getTombstoneKey(), 0, 0);
 501   }
 502   static unsigned getHashValue(const AAMDNodes &Val) {
 503     return DenseMapInfo<MDNode *>::getHashValue(Val.TBAA) ^
 504            DenseMapInfo<MDNode *>::getHashValue(Val.Scope) ^
 505            DenseMapInfo<MDNode *>::getHashValue(Val.NoAlias);
 506   }
 507   static bool isEqual(const AAMDNodes &LHS, const AAMDNodes &RHS) {
 508     return LHS == RHS;
 509   }
 510 };
 511
 512 /// \brief Tracking metadata reference owned by Metadata.
 513 ///
 514 /// Similar to \a TrackingMDRef, but it's expected to be owned by an instance
 515 /// of \a Metadata, which has the option of registering itself for callbacks to
 516 /// re-unique itself.
 517 ///
 518 /// In particular, this is used by \a MDNode.
 519 class MDOperand {
 520   MDOperand(MDOperand &&) LLVM_DELETED_FUNCTION;
 521   MDOperand(const MDOperand &) LLVM_DELETED_FUNCTION;
 522   MDOperand &operator=(MDOperand &&) LLVM_DELETED_FUNCTION;
 523   MDOperand &operator=(const MDOperand &) LLVM_DELETED_FUNCTION;
 524
 525   Metadata *MD;
 526
 527 public:
 528   MDOperand() : MD(nullptr) {}
 529   ~MDOperand() { untrack(); }
 530
 531   Metadata *get() const { return MD; }
 532   operator Metadata *() const { return get(); }
 533   Metadata *operator->() const { return get(); }
 534   Metadata &operator*() const { return *get(); }
 535
 536   void reset() {
 537     untrack();
 538     MD = nullptr;
 539   }
 540   void reset(Metadata *MD, Metadata *Owner) {
 541     untrack();
 542     this->MD = MD;
 543     track(Owner);
 544   }
 545
 546 private:
 547   void track(Metadata *Owner) {
 548     if (MD) {
 549       if (Owner)
 550         MetadataTracking::track(this, *MD, *Owner);
 551       else
 552         MetadataTracking::track(MD);
 553     }
 554   }
 555   void untrack() {
 556     assert(static_cast<void *>(this) == &MD && "Expected same address");
 557     if (MD)
 558       MetadataTracking::untrack(MD);
 559   }
 560 };
 561
 562 template <> struct simplify_type<MDOperand> {
 563   typedef Metadata *SimpleType;
 564   static SimpleType getSimplifiedValue(MDOperand &MD) { return MD.get(); }
 565 };
 566
 567 template <> struct simplify_type<const MDOperand> {
 568   typedef Metadata *SimpleType;
 569   static SimpleType getSimplifiedValue(const MDOperand &MD) { return MD.get(); }
 570 };
 571
 572 //===----------------------------------------------------------------------===//
 573 /// \brief Tuple of metadata.
 574 class MDNode : public Metadata {
 575   MDNode(const MDNode &) LLVM_DELETED_FUNCTION;
 576   void operator=(const MDNode &) LLVM_DELETED_FUNCTION;
 577   void *operator new(size_t) LLVM_DELETED_FUNCTION;
 578
 579   LLVMContext &Context;
 580   unsigned NumOperands;
 581
 582 protected:
 583   unsigned MDNodeSubclassData;
 584
 585   void *operator new(size_t Size, unsigned NumOps);
 586
 587   /// \brief Required by std, but never called.
 588   void operator delete(void *Mem);
 589
 590   /// \brief Required by std, but never called.
 591   void operator delete(void *, unsigned) {
 592     llvm_unreachable("Constructor throws?");
 593   }
 594
 595   /// \brief Required by std, but never called.
 596   void operator delete(void *, unsigned, bool) {
 597     llvm_unreachable("Constructor throws?");
 598   }
 599
 600   MDNode(LLVMContext &Context, unsigned ID, ArrayRef<Metadata *> MDs);
 601   ~MDNode() { dropAllReferences(); }
 602
 603   void dropAllReferences();
 604   void storeDistinctInContext();
 605
 606   static MDNode *getMDNode(LLVMContext &C, ArrayRef<Metadata *> MDs,
 607                            bool Insert = true);
 608
 609   MDOperand *mutable_begin() { return mutable_end() - NumOperands; }
 610   MDOperand *mutable_end() { return reinterpret_cast<MDOperand *>(this); }
 611
 612 public:
 613   static MDNode *get(LLVMContext &Context, ArrayRef<Metadata *> MDs) {
 614     return getMDNode(Context, MDs, true);
 615   }
 616   static MDNode *getWhenValsUnresolved(LLVMContext &Context,
 617                                        ArrayRef<Metadata *> MDs) {
 618     // TODO: Remove this.
 619     return get(Context, MDs);
 620   }
 621
 622   static MDNode *getIfExists(LLVMContext &Context, ArrayRef<Metadata *> MDs) {
 623     return getMDNode(Context, MDs, false);
 624   }
 625
 626   /// \brief Return a temporary MDNode
 627   ///
 628   /// For use in constructing cyclic MDNode structures. A temporary MDNode is
 629   /// not uniqued, may be RAUW'd, and must be manually deleted with
 630   /// deleteTemporary.
 631   static MDNodeFwdDecl *getTemporary(LLVMContext &Context,
 632                                      ArrayRef<Metadata *> MDs);
 633
 634   /// \brief Deallocate a node created by getTemporary.
 635   ///
 636   /// The node must not have any users.
 637   static void deleteTemporary(MDNode *N);
 638
 639   LLVMContext &getContext() const { return Context; }
 640
 641   /// \brief Replace a specific operand.
 642   void replaceOperandWith(unsigned I, Metadata *New);
 643
 644   /// \brief Check if node is fully resolved.
 645   bool isResolved() const;
 646
 647 protected:
 648   /// \brief Set an operand.
 649   ///
 650   /// Sets the operand directly, without worrying about uniquing.
 651   void setOperand(unsigned I, Metadata *New);
 652
 653 public:
 654   typedef const MDOperand *op_iterator;
 655   typedef iterator_range<op_iterator> op_range;
 656
 657   op_iterator op_begin() const {
 658     return const_cast<MDNode *>(this)->mutable_begin();
 659   }
 660   op_iterator op_end() const {
 661     return const_cast<MDNode *>(this)->mutable_end();
 662   }
 663   op_range operands() const { return op_range(op_begin(), op_end()); }
 664
 665   const MDOperand &getOperand(unsigned I) const {
 666     assert(I < NumOperands && "Out of range");
 667     return op_begin()[I];
 668   }
 669
 670   /// \brief Return number of MDNode operands.
 671   unsigned getNumOperands() const { return NumOperands; }
 672
 673   /// \brief Methods for support type inquiry through isa, cast, and dyn_cast:
 674   static bool classof(const Metadata *MD) {
 675     return MD->getMetadataID() == GenericMDNodeKind ||
 676            MD->getMetadataID() == MDNodeFwdDeclKind;
 677   }
 678
 679   /// \brief Check whether MDNode is a vtable access.
 680   bool isTBAAVtableAccess() const;
 681
 682   /// \brief Methods for metadata merging.
 683   static MDNode *concatenate(MDNode *A, MDNode *B);
 684   static MDNode *intersect(MDNode *A, MDNode *B);
 685   static MDNode *getMostGenericTBAA(MDNode *A, MDNode *B);
 686   static AAMDNodes getMostGenericAA(const AAMDNodes &A, const AAMDNodes &B);
 687   static MDNode *getMostGenericFPMath(MDNode *A, MDNode *B);
 688   static MDNode *getMostGenericRange(MDNode *A, MDNode *B);
 689 };
 690
 691 /// \brief Generic metadata node.
 692 ///
 693 /// Generic metadata nodes, with opt-out support for uniquing.
 694 ///
 695 /// Although nodes are uniqued by default, \a GenericMDNode has no support for
 696 /// RAUW.  If an operand change (due to RAUW or otherwise) causes a uniquing
 697 /// collision, the uniquing bit is dropped.
 698 ///
 699 /// TODO: Make uniquing opt-out (status: mandatory, sometimes dropped).
 700 /// TODO: Drop support for RAUW.
 701 class GenericMDNode : public MDNode {
 702   friend class Metadata;
 703   friend class MDNode;
 704   friend class LLVMContextImpl;
 705   friend class ReplaceableMetadataImpl;
 706
 707   /// \brief Support RAUW as long as one of its arguments is replaceable.
 708   ///
 709   /// If an operand is an \a MDNodeFwdDecl (or a replaceable \a GenericMDNode),
 710   /// support RAUW to support uniquing as forward declarations are resolved.
 711   /// As soon as operands have been resolved, drop support.
 712   ///
 713   /// FIXME: Save memory by storing this in a pointer union with the
 714   /// LLVMContext, and adding an LLVMContext reference to RMI.
 715   std::unique_ptr<ReplaceableMetadataImpl> ReplaceableUses;
 716
 717   GenericMDNode(LLVMContext &C, ArrayRef<Metadata *> Vals);
 718   ~GenericMDNode();
 719
 720   void setHash(unsigned Hash) { MDNodeSubclassData = Hash; }
 721
 722 public:
 723   /// \brief Get the hash, if any.
 724   unsigned getHash() const { return MDNodeSubclassData; }
 725
 726   static bool classof(const Metadata *MD) {
 727     return MD->getMetadataID() == GenericMDNodeKind;
 728   }
 729
 730   /// \brief Check whether any operands are forward declarations.
 731   ///
 732   /// Returns \c true as long as any operands (or their operands, etc.) are \a
 733   /// MDNodeFwdDecl.
 734   ///
 735   /// As forward declarations are resolved, their containers should get
 736   /// resolved automatically.  However, if this (or one of its operands) is
 737   /// involved in a cycle, \a resolveCycles() needs to be called explicitly.
 738   bool isResolved() const { return !ReplaceableUses; }
 739
 740   /// \brief Resolve cycles.
 741   ///
 742   /// Once all forward declarations have been resolved, force cycles to be
 743   /// resolved.
 744   ///
 745   /// \pre No operands (or operands' operands, etc.) are \a MDNodeFwdDecl.
 746   void resolveCycles();
 747
 748 private:
 749   void handleChangedOperand(void *Ref, Metadata *New);
 750
 751   bool hasUnresolvedOperands() const { return SubclassData32; }
 752   void incrementUnresolvedOperands() { ++SubclassData32; }
 753   void decrementUnresolvedOperands() { --SubclassData32; }
 754   void resolve();
 755 };
 756
 757 /// \brief Forward declaration of metadata.
 758 ///
 759 /// Forward declaration of metadata, in the form of a metadata node.  Unlike \a
 760 /// GenericMDNode, this class has support for RAUW and is suitable for forward
 761 /// references.
 762 class MDNodeFwdDecl : public MDNode, ReplaceableMetadataImpl {
 763   friend class Metadata;
 764   friend class MDNode;
 765   friend class ReplaceableMetadataImpl;
 766
 767   MDNodeFwdDecl(LLVMContext &C, ArrayRef<Metadata *> Vals)
 768       : MDNode(C, MDNodeFwdDeclKind, Vals) {}
 769   ~MDNodeFwdDecl() {}
 770
 771 public:
 772   static bool classof(const Metadata *MD) {
 773     return MD->getMetadataID() == MDNodeFwdDeclKind;
 774   }
 775
 776   using ReplaceableMetadataImpl::replaceAllUsesWith;
 777 };
 778
 779 //===----------------------------------------------------------------------===//
 780 /// \brief A tuple of MDNodes.
 781 ///
 782 /// Despite its name, a NamedMDNode isn't itself an MDNode. NamedMDNodes belong
 783 /// to modules, have names, and contain lists of MDNodes.
 784 ///
 785 /// TODO: Inherit from Metadata.
 786 class NamedMDNode : public ilist_node<NamedMDNode> {
 787   friend class SymbolTableListTraits<NamedMDNode, Module>;
 788   friend struct ilist_traits<NamedMDNode>;
 789   friend class LLVMContextImpl;
 790   friend class Module;
 791   NamedMDNode(const NamedMDNode &) LLVM_DELETED_FUNCTION;
 792
 793   std::string Name;
 794   Module *Parent;
 795   void *Operands; // SmallVector<TrackingMDRef, 4>
 796
 797   void setParent(Module *M) { Parent = M; }
 798
 799   explicit NamedMDNode(const Twine &N);
 800
 801   template<class T1, class T2>
 802   class op_iterator_impl :
 803       public std::iterator<std::bidirectional_iterator_tag, T2> {
 804     const NamedMDNode *Node;
 805     unsigned Idx;
 806     op_iterator_impl(const NamedMDNode *N, unsigned i) : Node(N), Idx(i) { }
 807
 808     friend class NamedMDNode;
 809
 810   public:
 811     op_iterator_impl() : Node(nullptr), Idx(0) { }
 812
 813     bool operator==(const op_iterator_impl &o) const { return Idx == o.Idx; }
 814     bool operator!=(const op_iterator_impl &o) const { return Idx != o.Idx; }
 815     op_iterator_impl &operator++() {
 816       ++Idx;
 817       return *this;
 818     }
 819     op_iterator_impl operator++(int) {
 820       op_iterator_impl tmp(*this);
 821       operator++();
 822       return tmp;
 823     }
 824     op_iterator_impl &operator--() {
 825       --Idx;
 826       return *this;
 827     }
 828     op_iterator_impl operator--(int) {
 829       op_iterator_impl tmp(*this);
 830       operator--();
 831       return tmp;
 832     }
 833
 834     T1 operator*() const { return Node->getOperand(Idx); }
 835   };
 836
 837 public:
 838   /// \brief Drop all references and remove the node from parent module.
 839   void eraseFromParent();
 840
 841   /// \brief Remove all uses and clear node vector.
 842   void dropAllReferences();
 843
 844   ~NamedMDNode();
 845
 846   /// \brief Get the module that holds this named metadata collection.
 847   inline Module *getParent() { return Parent; }
 848   inline const Module *getParent() const { return Parent; }
 849
 850   MDNode *getOperand(unsigned i) const;
 851   unsigned getNumOperands() const;
 852   void addOperand(MDNode *M);
 853   StringRef getName() const;
 854   void print(raw_ostream &ROS) const;
 855   void dump() const;
 856
 857   // ---------------------------------------------------------------------------
 858   // Operand Iterator interface...
 859   //
 860   typedef op_iterator_impl<MDNode *, MDNode> op_iterator;
 861   op_iterator op_begin() { return op_iterator(this, 0); }
 862   op_iterator op_end()   { return op_iterator(this, getNumOperands()); }
 863
 864   typedef op_iterator_impl<const MDNode *, MDNode> const_op_iterator;
 865   const_op_iterator op_begin() const { return const_op_iterator(this, 0); }
 866   const_op_iterator op_end()   const { return const_op_iterator(this, getNumOperands()); }
 867
 868   inline iterator_range<op_iterator>  operands() {
 869     return iterator_range<op_iterator>(op_begin(), op_end());
 870   }
 871   inline iterator_range<const_op_iterator> operands() const {
 872     return iterator_range<const_op_iterator>(op_begin(), op_end());
 873   }
 874 };
 875
 876 } // end llvm namespace
 877
 878 #endif