X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=include%2Fllvm%2FUse.h;h=970f69b9da883553e2fbb8a664839fa8162295b8;hb=e885af9fb773f5a01a5b31fa0a0b7fd0489bde56;hp=bbf523574cd61afc7ae94d1bc6cae48b5becb5dd;hpb=a26619748932b146a09773d51465d7b7dcdb7dd2;p=oota-llvm.git

diff --git a/include/llvm/Use.h b/include/llvm/Use.h
index bbf523574cd..970f69b9da8 100644
--- a/include/llvm/Use.h
+++ b/include/llvm/Use.h
@@ -1,52 +1,94 @@
 //===-- llvm/Use.h - Definition of the Use class ----------------*- C++ -*-===//
-// 
+//
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by the LLVM research group and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
-// 
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
 //===----------------------------------------------------------------------===//
 //
 // This defines the Use class.  The Use class represents the operand of an
 // instruction or some other User instance which refers to a Value.  The Use
 // class keeps the "use list" of the referenced value up to date.
 //
+// Pointer tagging is used to efficiently find the User corresponding
+// to a Use without having to store a User pointer in every Use. A
+// User is preceded in memory by all the Uses corresponding to its
+// operands, and the low bits of one of the fields (Prev) of the Use
+// class are used to encode offsets to be able to find that User given
+// a pointer to any Use. For details, see:
+//
+//   http://www.llvm.org/docs/ProgrammersManual.html#UserLayout
+//
 //===----------------------------------------------------------------------===//
 
 #ifndef LLVM_USE_H
 #define LLVM_USE_H
 
 #include "llvm/Support/Casting.h"
-#include "llvm/ADT/iterator"
+#include "llvm/ADT/PointerIntPair.h"
+#include <iterator>
 
 namespace llvm {
 
 class Value;
 class User;
+class Use;
 
+/// Tag - generic tag type for (at least 32 bit) pointers
+enum Tag { noTag, tagOne, tagTwo, tagThree };
+
+// Use** is only 4-byte aligned.
+template<>
+class PointerLikeTypeTraits<Use**> {
+public:
+  static inline void *getAsVoidPointer(Use** P) { return P; }
+  static inline Use **getFromVoidPointer(void *P) {
+    return static_cast<Use**>(P);
+  }
+  enum { NumLowBitsAvailable = 2 };
+};
 
 //===----------------------------------------------------------------------===//
 //                                  Use Class
 //===----------------------------------------------------------------------===//
 
-// Use is here to make keeping the "use" list of a Value up-to-date really easy.
-//
+/// Use is here to make keeping the "use" list of a Value up-to-date really
+/// easy.
 class Use {
 public:
-  inline void init(Value *V, User *U);
+  /// swap - provide a fast substitute to std::swap<Use>
+  /// that also works with less standard-compliant compilers
+  void swap(Use &RHS);
 
-  Use(Value *V, User *U) { init(V, U); }
-  Use(const Use &U) { init(U.Val, U.U); }
-  inline ~Use();
+private:
+  /// Copy ctor - do not implement
+  Use(const Use &U);
 
-  /// Default ctor - This leaves the Use completely unitialized.  The only thing
-  /// that is valid to do with this use is to call the "init" method.
-  inline Use() : Val(0) {}
+  /// Destructor - Only for zap()
+  inline ~Use() {
+    if (Val) removeFromList();
+  }
 
+  /// Default ctor - This leaves the Use completely uninitialized.  The only
+  /// thing that is valid to do with this use is to call the "init" method.
+  inline Use() {}
+  enum PrevPtrTag { zeroDigitTag = noTag
+                  , oneDigitTag = tagOne
+                  , stopTag = tagTwo
+                  , fullStopTag = tagThree };
 
+public:
+  /// Normally Use will just implicitly convert to a Value* that it holds.
   operator Value*() const { return Val; }
+  
+  /// If implicit conversion to Value* doesn't work, the get() method returns
+  /// the Value*.
   Value *get() const { return Val; }
-  User *getUser() const { return U; }
+  
+  /// getUser - This returns the User that contains this Use.  For an
+  /// instruction operand, for example, this will return the instruction.
+  User *getUser() const;
 
   inline void set(Value *Val);
 
@@ -63,23 +105,39 @@ public:
   const Value *operator->() const { return Val; }
 
   Use *getNext() const { return Next; }
+
+  
+  /// zap - This is used to destroy Use operands when the number of operands of
+  /// a User changes.
+  static void zap(Use *Start, const Use *Stop, bool del = false);
+
+  /// getPrefix - Return deletable pointer if appropriate
+  Use *getPrefix();
 private:
-  Use *Next, **Prev;
+  const Use* getImpliedUser() const;
+  static Use *initTags(Use *Start, Use *Stop, ptrdiff_t Done = 0);
+  
   Value *Val;
-  User *U;
+  Use *Next;
+  PointerIntPair<Use**, 2, PrevPtrTag> Prev;
 
+  void setPrev(Use **NewPrev) {
+    Prev.setPointer(NewPrev);
+  }
   void addToList(Use **List) {
     Next = *List;
-    if (Next) Next->Prev = &Next;
-    Prev = List;
+    if (Next) Next->setPrev(&Next);
+    setPrev(List);
     *List = this;
   }
   void removeFromList() {
-    *Prev = Next;
-    if (Next) Next->Prev = Prev;
+    Use **StrippedPrev = Prev.getPointer();
+    *StrippedPrev = Next;
+    if (Next) Next->setPrev(StrippedPrev);
   }
 
   friend class Value;
+  friend class User;
 };
 
 // simplify_type - Allow clients to treat uses just like values when using
@@ -100,12 +158,13 @@ template<> struct simplify_type<const Use> {
 
 
 template<typename UserTy>  // UserTy == 'User' or 'const User'
-class value_use_iterator : public forward_iterator<UserTy*, ptrdiff_t> {
-  typedef forward_iterator<UserTy*, ptrdiff_t> super;
+class value_use_iterator : public std::iterator<std::forward_iterator_tag,
+                                                UserTy*, ptrdiff_t> {
+  typedef std::iterator<std::forward_iterator_tag, UserTy*, ptrdiff_t> super;
   typedef value_use_iterator<UserTy> _Self;
 
   Use *U;
-  value_use_iterator(Use *u) : U(u) {}
+  explicit value_use_iterator(Use *u) : U(u) {}
   friend class Value;
 public:
   typedef typename super::reference reference;
@@ -114,34 +173,66 @@ public:
   value_use_iterator(const _Self &I) : U(I.U) {}
   value_use_iterator() {}
 
-  bool operator==(const _Self &x) const { 
+  bool operator==(const _Self &x) const {
     return U == x.U;
   }
   bool operator!=(const _Self &x) const {
     return !operator==(x);
   }
 
+  /// atEnd - return true if this iterator is equal to use_end() on the value.
+  bool atEnd() const { return U == 0; }
+
   // Iterator traversal: forward iteration only
   _Self &operator++() {          // Preincrement
     assert(U && "Cannot increment end iterator!");
     U = U->getNext();
-    return *this; 
+    return *this;
   }
   _Self operator++(int) {        // Postincrement
-    _Self tmp = *this; ++*this; return tmp; 
+    _Self tmp = *this; ++*this; return tmp;
   }
 
-  // Retrieve a reference to the current SCC
-   UserTy *operator*() const { 
-    assert(U && "Cannot increment end iterator!");
+  // Retrieve a pointer to the current User.
+  UserTy *operator*() const {
+    assert(U && "Cannot dereference end iterator!");
     return U->getUser();
   }
 
   UserTy *operator->() const { return operator*(); }
 
   Use &getUse() const { return *U; }
+  
+  /// getOperandNo - Return the operand # of this use in its User.  Defined in
+  /// User.h
+  ///
+  unsigned getOperandNo() const;
+};
+
+
+template<> struct simplify_type<value_use_iterator<User> > {
+  typedef User* SimpleType;
+  
+  static SimpleType getSimplifiedValue(const value_use_iterator<User> &Val) {
+    return *Val;
+  }
+};
+
+template<> struct simplify_type<const value_use_iterator<User> >
+ : public simplify_type<value_use_iterator<User> > {};
+
+template<> struct simplify_type<value_use_iterator<const User> > {
+  typedef const User* SimpleType;
+  
+  static SimpleType getSimplifiedValue(const 
+                                       value_use_iterator<const User> &Val) {
+    return *Val;
+  }
 };
 
+template<> struct simplify_type<const value_use_iterator<const User> >
+  : public simplify_type<value_use_iterator<const User> > {};
+ 
 } // End llvm namespace
 
 #endif