include/llvm/IR/ValueMap.h

   1 //===- ValueMap.h - Safe map from Values to data ----------------*- 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 // This file defines the ValueMap class.  ValueMap maps Value* or any subclass
  11 // to an arbitrary other type.  It provides the DenseMap interface but updates
  12 // itself to remain safe when keys are RAUWed or deleted.  By default, when a
  13 // key is RAUWed from V1 to V2, the old mapping V1->target is removed, and a new
  14 // mapping V2->target is added.  If V2 already existed, its old target is
  15 // overwritten.  When a key is deleted, its mapping is removed.
  16 //
  17 // You can override a ValueMap's Config parameter to control exactly what
  18 // happens on RAUW and destruction and to get called back on each event.  It's
  19 // legal to call back into the ValueMap from a Config's callbacks.  Config
  20 // parameters should inherit from ValueMapConfig<KeyT> to get default
  21 // implementations of all the methods ValueMap uses.  See ValueMapConfig for
  22 // documentation of the functions you can override.
  23 //
  24 //===----------------------------------------------------------------------===//
  25
  26 #ifndef LLVM_IR_VALUEMAP_H
  27 #define LLVM_IR_VALUEMAP_H
  28
  29 #include "llvm/ADT/DenseMap.h"
  30 #include "llvm/IR/ValueHandle.h"
  31 #include "llvm/Support/type_traits.h"
  32 #include <iterator>
  33 #include <mutex>
  34
  35 namespace llvm {
  36
  37 template<typename KeyT, typename ValueT, typename Config>
  38 class ValueMapCallbackVH;
  39
  40 template<typename DenseMapT, typename KeyT>
  41 class ValueMapIterator;
  42 template<typename DenseMapT, typename KeyT>
  43 class ValueMapConstIterator;
  44
  45 /// This class defines the default behavior for configurable aspects of
  46 /// ValueMap<>.  User Configs should inherit from this class to be as compatible
  47 /// as possible with future versions of ValueMap.
  48 template<typename KeyT, typename MutexT = std::recursive_mutex>
  49 struct ValueMapConfig {
  50   typedef MutexT mutex_type;
  51
  52   /// If FollowRAUW is true, the ValueMap will update mappings on RAUW. If it's
  53   /// false, the ValueMap will leave the original mapping in place.
  54   enum { FollowRAUW = true };
  55
  56   // All methods will be called with a first argument of type ExtraData.  The
  57   // default implementations in this class take a templated first argument so
  58   // that users' subclasses can use any type they want without having to
  59   // override all the defaults.
  60   struct ExtraData {};
  61
  62   template<typename ExtraDataT>
  63   static void onRAUW(const ExtraDataT & /*Data*/, KeyT /*Old*/, KeyT /*New*/) {}
  64   template<typename ExtraDataT>
  65   static void onDelete(const ExtraDataT &/*Data*/, KeyT /*Old*/) {}
  66
  67   /// Returns a mutex that should be acquired around any changes to the map.
  68   /// This is only acquired from the CallbackVH (and held around calls to onRAUW
  69   /// and onDelete) and not inside other ValueMap methods.  NULL means that no
  70   /// mutex is necessary.
  71   template<typename ExtraDataT>
  72   static mutex_type *getMutex(const ExtraDataT &/*Data*/) { return nullptr; }
  73 };
  74
  75 /// See the file comment.
  76 template<typename KeyT, typename ValueT, typename Config =ValueMapConfig<KeyT> >
  77 class ValueMap {
  78   friend class ValueMapCallbackVH<KeyT, ValueT, Config>;
  79   typedef ValueMapCallbackVH<KeyT, ValueT, Config> ValueMapCVH;
  80   typedef DenseMap<ValueMapCVH, ValueT, DenseMapInfo<ValueMapCVH> > MapT;
  81   typedef typename Config::ExtraData ExtraData;
  82   MapT Map;
  83   ExtraData Data;
  84   ValueMap(const ValueMap&) LLVM_DELETED_FUNCTION;
  85   ValueMap& operator=(const ValueMap&) LLVM_DELETED_FUNCTION;
  86 public:
  87   typedef KeyT key_type;
  88   typedef ValueT mapped_type;
  89   typedef std::pair<KeyT, ValueT> value_type;
  90
  91   explicit ValueMap(unsigned NumInitBuckets = 64)
  92     : Map(NumInitBuckets), Data() {}
  93   explicit ValueMap(const ExtraData &Data, unsigned NumInitBuckets = 64)
  94     : Map(NumInitBuckets), Data(Data) {}
  95
  96   ~ValueMap() {}
  97
  98   typedef ValueMapIterator<MapT, KeyT> iterator;
  99   typedef ValueMapConstIterator<MapT, KeyT> const_iterator;
 100   inline iterator begin() { return iterator(Map.begin()); }
 101   inline iterator end() { return iterator(Map.end()); }
 102   inline const_iterator begin() const { return const_iterator(Map.begin()); }
 103   inline const_iterator end() const { return const_iterator(Map.end()); }
 104
 105   bool empty() const { return Map.empty(); }
 106   unsigned size() const { return Map.size(); }
 107
 108   /// Grow the map so that it has at least Size buckets. Does not shrink
 109   void resize(size_t Size) { Map.resize(Size); }
 110
 111   void clear() { Map.clear(); }
 112
 113   /// count - Return true if the specified key is in the map.
 114   bool count(const KeyT &Val) const {
 115     return Map.find_as(Val) != Map.end();
 116   }
 117
 118   iterator find(const KeyT &Val) {
 119     return iterator(Map.find_as(Val));
 120   }
 121   const_iterator find(const KeyT &Val) const {
 122     return const_iterator(Map.find_as(Val));
 123   }
 124
 125   /// lookup - Return the entry for the specified key, or a default
 126   /// constructed value if no such entry exists.
 127   ValueT lookup(const KeyT &Val) const {
 128     typename MapT::const_iterator I = Map.find_as(Val);
 129     return I != Map.end() ? I->second : ValueT();
 130   }
 131
 132   // Inserts key,value pair into the map if the key isn't already in the map.
 133   // If the key is already in the map, it returns false and doesn't update the
 134   // value.
 135   std::pair<iterator, bool> insert(const std::pair<KeyT, ValueT> &KV) {
 136     std::pair<typename MapT::iterator, bool> map_result=
 137       Map.insert(std::make_pair(Wrap(KV.first), KV.second));
 138     return std::make_pair(iterator(map_result.first), map_result.second);
 139   }
 140
 141   /// insert - Range insertion of pairs.
 142   template<typename InputIt>
 143   void insert(InputIt I, InputIt E) {
 144     for (; I != E; ++I)
 145       insert(*I);
 146   }
 147
 148
 149   bool erase(const KeyT &Val) {
 150     typename MapT::iterator I = Map.find_as(Val);
 151     if (I == Map.end())
 152       return false;
 153
 154     Map.erase(I);
 155     return true;
 156   }
 157   void erase(iterator I) {
 158     return Map.erase(I.base());
 159   }
 160
 161   value_type& FindAndConstruct(const KeyT &Key) {
 162     return Map.FindAndConstruct(Wrap(Key));
 163   }
 164
 165   ValueT &operator[](const KeyT &Key) {
 166     return Map[Wrap(Key)];
 167   }
 168
 169   /// isPointerIntoBucketsArray - Return true if the specified pointer points
 170   /// somewhere into the ValueMap's array of buckets (i.e. either to a key or
 171   /// value in the ValueMap).
 172   bool isPointerIntoBucketsArray(const void *Ptr) const {
 173     return Map.isPointerIntoBucketsArray(Ptr);
 174   }
 175
 176   /// getPointerIntoBucketsArray() - Return an opaque pointer into the buckets
 177   /// array.  In conjunction with the previous method, this can be used to
 178   /// determine whether an insertion caused the ValueMap to reallocate.
 179   const void *getPointerIntoBucketsArray() const {
 180     return Map.getPointerIntoBucketsArray();
 181   }
 182
 183 private:
 184   // Takes a key being looked up in the map and wraps it into a
 185   // ValueMapCallbackVH, the actual key type of the map.  We use a helper
 186   // function because ValueMapCVH is constructed with a second parameter.
 187   ValueMapCVH Wrap(KeyT key) const {
 188     // The only way the resulting CallbackVH could try to modify *this (making
 189     // the const_cast incorrect) is if it gets inserted into the map.  But then
 190     // this function must have been called from a non-const method, making the
 191     // const_cast ok.
 192     return ValueMapCVH(key, const_cast<ValueMap*>(this));
 193   }
 194 };
 195
 196 // This CallbackVH updates its ValueMap when the contained Value changes,
 197 // according to the user's preferences expressed through the Config object.
 198 template<typename KeyT, typename ValueT, typename Config>
 199 class ValueMapCallbackVH : public CallbackVH {
 200   friend class ValueMap<KeyT, ValueT, Config>;
 201   friend struct DenseMapInfo<ValueMapCallbackVH>;
 202   typedef ValueMap<KeyT, ValueT, Config> ValueMapT;
 203   typedef typename std::remove_pointer<KeyT>::type KeySansPointerT;
 204
 205   ValueMapT *Map;
 206
 207   ValueMapCallbackVH(KeyT Key, ValueMapT *Map)
 208       : CallbackVH(const_cast<Value*>(static_cast<const Value*>(Key))),
 209         Map(Map) {}
 210
 211 public:
 212   KeyT Unwrap() const { return cast_or_null<KeySansPointerT>(getValPtr()); }
 213
 214   void deleted() override {
 215     // Make a copy that won't get changed even when *this is destroyed.
 216     ValueMapCallbackVH Copy(*this);
 217     typename Config::mutex_type *M = Config::getMutex(Copy.Map->Data);
 218     if (M)
 219       M->lock();
 220     Config::onDelete(Copy.Map->Data, Copy.Unwrap());  // May destroy *this.
 221     Copy.Map->Map.erase(Copy);  // Definitely destroys *this.
 222     if (M)
 223       M->unlock();
 224   }
 225   void allUsesReplacedWith(Value *new_key) override {
 226     assert(isa<KeySansPointerT>(new_key) &&
 227            "Invalid RAUW on key of ValueMap<>");
 228     // Make a copy that won't get changed even when *this is destroyed.
 229     ValueMapCallbackVH Copy(*this);
 230     typename Config::mutex_type *M = Config::getMutex(Copy.Map->Data);
 231     if (M)
 232       M->lock();
 233
 234     KeyT typed_new_key = cast<KeySansPointerT>(new_key);
 235     // Can destroy *this:
 236     Config::onRAUW(Copy.Map->Data, Copy.Unwrap(), typed_new_key);
 237     if (Config::FollowRAUW) {
 238       typename ValueMapT::MapT::iterator I = Copy.Map->Map.find(Copy);
 239       // I could == Copy.Map->Map.end() if the onRAUW callback already
 240       // removed the old mapping.
 241       if (I != Copy.Map->Map.end()) {
 242         ValueT Target(I->second);
 243         Copy.Map->Map.erase(I);  // Definitely destroys *this.
 244         Copy.Map->insert(std::make_pair(typed_new_key, Target));
 245       }
 246     }
 247     if (M)
 248       M->unlock();
 249   }
 250 };
 251
 252 template<typename KeyT, typename ValueT, typename Config>
 253 struct DenseMapInfo<ValueMapCallbackVH<KeyT, ValueT, Config> > {
 254   typedef ValueMapCallbackVH<KeyT, ValueT, Config> VH;
 255   typedef DenseMapInfo<KeyT> PointerInfo;
 256
 257   static inline VH getEmptyKey() {
 258     return VH(PointerInfo::getEmptyKey(), nullptr);
 259   }
 260   static inline VH getTombstoneKey() {
 261     return VH(PointerInfo::getTombstoneKey(), nullptr);
 262   }
 263   static unsigned getHashValue(const VH &Val) {
 264     return PointerInfo::getHashValue(Val.Unwrap());
 265   }
 266   static unsigned getHashValue(const KeyT &Val) {
 267     return PointerInfo::getHashValue(Val);
 268   }
 269   static bool isEqual(const VH &LHS, const VH &RHS) {
 270     return LHS == RHS;
 271   }
 272   static bool isEqual(const KeyT &LHS, const VH &RHS) {
 273     return LHS == RHS.getValPtr();
 274   }
 275 };
 276
 277
 278 template<typename DenseMapT, typename KeyT>
 279 class ValueMapIterator :
 280     public std::iterator<std::forward_iterator_tag,
 281                          std::pair<KeyT, typename DenseMapT::mapped_type>,
 282                          ptrdiff_t> {
 283   typedef typename DenseMapT::iterator BaseT;
 284   typedef typename DenseMapT::mapped_type ValueT;
 285   BaseT I;
 286 public:
 287   ValueMapIterator() : I() {}
 288
 289   ValueMapIterator(BaseT I) : I(I) {}
 290
 291   BaseT base() const { return I; }
 292
 293   struct ValueTypeProxy {
 294     const KeyT first;
 295     ValueT& second;
 296     ValueTypeProxy *operator->() { return this; }
 297     operator std::pair<KeyT, ValueT>() const {
 298       return std::make_pair(first, second);
 299     }
 300   };
 301
 302   ValueTypeProxy operator*() const {
 303     ValueTypeProxy Result = {I->first.Unwrap(), I->second};
 304     return Result;
 305   }
 306
 307   ValueTypeProxy operator->() const {
 308     return operator*();
 309   }
 310
 311   bool operator==(const ValueMapIterator &RHS) const {
 312     return I == RHS.I;
 313   }
 314   bool operator!=(const ValueMapIterator &RHS) const {
 315     return I != RHS.I;
 316   }
 317
 318   inline ValueMapIterator& operator++() {  // Preincrement
 319     ++I;
 320     return *this;
 321   }
 322   ValueMapIterator operator++(int) {  // Postincrement
 323     ValueMapIterator tmp = *this; ++*this; return tmp;
 324   }
 325 };
 326
 327 template<typename DenseMapT, typename KeyT>
 328 class ValueMapConstIterator :
 329     public std::iterator<std::forward_iterator_tag,
 330                          std::pair<KeyT, typename DenseMapT::mapped_type>,
 331                          ptrdiff_t> {
 332   typedef typename DenseMapT::const_iterator BaseT;
 333   typedef typename DenseMapT::mapped_type ValueT;
 334   BaseT I;
 335 public:
 336   ValueMapConstIterator() : I() {}
 337   ValueMapConstIterator(BaseT I) : I(I) {}
 338   ValueMapConstIterator(ValueMapIterator<DenseMapT, KeyT> Other)
 339     : I(Other.base()) {}
 340
 341   BaseT base() const { return I; }
 342
 343   struct ValueTypeProxy {
 344     const KeyT first;
 345     const ValueT& second;
 346     ValueTypeProxy *operator->() { return this; }
 347     operator std::pair<KeyT, ValueT>() const {
 348       return std::make_pair(first, second);
 349     }
 350   };
 351
 352   ValueTypeProxy operator*() const {
 353     ValueTypeProxy Result = {I->first.Unwrap(), I->second};
 354     return Result;
 355   }
 356
 357   ValueTypeProxy operator->() const {
 358     return operator*();
 359   }
 360
 361   bool operator==(const ValueMapConstIterator &RHS) const {
 362     return I == RHS.I;
 363   }
 364   bool operator!=(const ValueMapConstIterator &RHS) const {
 365     return I != RHS.I;
 366   }
 367
 368   inline ValueMapConstIterator& operator++() {  // Preincrement
 369     ++I;
 370     return *this;
 371   }
 372   ValueMapConstIterator operator++(int) {  // Postincrement
 373     ValueMapConstIterator tmp = *this; ++*this; return tmp;
 374   }
 375 };
 376
 377 } // end namespace llvm
 378
 379 #endif