On x86 favors folding short immediate into some arithmetic operations (e.g. add,...
[oota-llvm.git] / include / llvm / Value.h
index fc1cf482095745012b91c8f220b435fc824eceee..ee7e25ac76a7aae45bbc949e3a94fb39fa6fcbdf 100644 (file)
@@ -8,7 +8,6 @@
 //===----------------------------------------------------------------------===//
 //
 // This file declares the Value class. 
-// This file also defines the Use<> template for users of value.
 //
 //===----------------------------------------------------------------------===//
 
@@ -18,7 +17,7 @@
 #include "llvm/AbstractTypeUser.h"
 #include "llvm/Use.h"
 #include "llvm/Support/Casting.h"
-#include "llvm/Support/Streams.h"
+#include <iosfwd>
 #include <string>
 
 namespace llvm {
@@ -36,6 +35,8 @@ class ValueSymbolTable;
 class TypeSymbolTable;
 template<typename ValueTy> class StringMapEntry;
 typedef StringMapEntry<Value*> ValueName;
+class raw_ostream;
+class AssemblyAnnotationWriter;
 
 //===----------------------------------------------------------------------===//
 //                                 Value Class
@@ -46,7 +47,7 @@ typedef StringMapEntry<Value*> ValueName;
 /// the super class of other important classes such as Instruction and Function.
 /// All Values have a Type. Type is not a subclass of Value. All types can have
 /// a name and they should belong to some Module. Setting the name on the Value
-/// automatically update's the module's symbol table.
+/// automatically updates the module's symbol table.
 ///
 /// Every value has a "use list" that keeps track of which other Values are
 /// using this Value.
@@ -59,7 +60,7 @@ protected:
   /// This field is initialized to zero by the ctor.
   unsigned short SubclassData;
 private:
-  PATypeHolder Ty;
+  PATypeHolder VTy;
   Use *UseList;
 
   friend class ValueSymbolTable; // Allow ValueSymbolTable to directly mod Name.
@@ -77,14 +78,14 @@ public:
   //
   virtual void dump() const;
 
-  /// print - Implement operator<< on Value...
+  /// print - Implement operator<< on Value.
   ///
-  virtual void print(std::ostream &O) const = 0;
-  void print(std::ostream *O) const { if (O) print(*O); }
+  void print(std::ostream &O, AssemblyAnnotationWriter *AAW = 0) const;
+  void print(raw_ostream &O, AssemblyAnnotationWriter *AAW = 0) const;
 
   /// All values are typed, get the type of this value.
   ///
-  inline const Type *getType() const { return Ty; }
+  inline const Type *getType() const { return VTy; }
 
   // All values can potentially be named...
   inline bool hasName() const { return Name != 0; }
@@ -94,6 +95,12 @@ public:
   /// Note that names can have null characters within the string as well as at
   /// their end.  This always returns a non-null pointer.
   const char *getNameStart() const;
+  /// getNameEnd - Return a pointer to the end of the name.
+  const char *getNameEnd() const { return getNameStart() + getNameLen(); }
+  
+  /// isName - Return true if this value has the name specified by the provided
+  /// nul terminated string.
+  bool isName(const char *N) const;
   
   /// getNameLen - Return the length of the string, correctly handling nul
   /// characters embedded into them.
@@ -126,7 +133,7 @@ public:
   void uncheckedReplaceAllUsesWith(Value *V);
 
   //----------------------------------------------------------------------
-  // Methods for handling the vector of uses of this Value.
+  // Methods for handling the chain of uses of this Value.
   //
   typedef value_use_iterator<User>       use_iterator;
   typedef value_use_iterator<const User> use_const_iterator;
@@ -137,7 +144,7 @@ public:
   use_iterator       use_end()         { return use_iterator(0);   }
   use_const_iterator use_end()   const { return use_const_iterator(0);   }
   User              *use_back()        { return *use_begin(); }
-  const User        *use_back() const  { return *use_begin(); }
+  const User        *use_back()  const { return *use_begin(); }
 
   /// hasOneUse - Return true if there is exactly one user of this value.  This
   /// is specialized because it is a common request and does not require
@@ -158,12 +165,14 @@ public:
   ///
   bool hasNUsesOrMore(unsigned N) const;
 
+  bool isUsedInBasicBlock(const BasicBlock *BB) const;
+
   /// getNumUses - This method computes the number of uses of this Value.  This
   /// is a linear time operation.  Use hasOneUse, hasNUses, or hasMoreThanNUses
   /// to check for specific values.
   unsigned getNumUses() const;
 
-  /// addUse/killUse - These two methods should only be used by the Use class.
+  /// addUse - This method should only be used by the Use class.
   ///
   void addUse(Use &U) { U.addToList(&UseList); }
 
@@ -187,6 +196,7 @@ public:
     ConstantVectorVal,        // This is an instance of ConstantVector
     ConstantPointerNullVal,   // This is an instance of ConstantPointerNull
     InlineAsmVal,             // This is an instance of InlineAsm
+    PseudoSourceValueVal,     // This is an instance of PseudoSourceValue
     InstructionVal,           // This is an instance of Instruction
     
     // Markers:
@@ -214,24 +224,35 @@ public:
 
   /// getRawType - This should only be used to implement the vmcore library.
   ///
-  const Type *getRawType() const { return Ty.getRawType(); }
+  const Type *getRawType() const { return VTy.getRawType(); }
+
+  /// stripPointerCasts - This method strips off any unneeded pointer
+  /// casts from the specified value, returning the original uncasted value.
+  /// Note that the returned value has pointer type if the specified value does.
+  Value *stripPointerCasts();
+  const Value *stripPointerCasts() const {
+    return const_cast<Value*>(this)->stripPointerCasts();
+  }
+
+  /// getUnderlyingObject - This method strips off any GEP address adjustments
+  /// and pointer casts from the specified value, returning the original object
+  /// being addressed.  Note that the returned value has pointer type if the
+  /// specified value does.
+  Value *getUnderlyingObject();
+  const Value *getUnderlyingObject() const {
+    return const_cast<Value*>(this)->getUnderlyingObject();
+  }
 };
 
 inline std::ostream &operator<<(std::ostream &OS, const Value &V) {
   V.print(OS);
   return OS;
 }
-
-void Use::init(Value *v, User *user) {
-  Val = v;
-  U = user;
-  if (Val) Val->addUse(*this);
-}
-
-Use::~Use() {
-  if (Val) removeFromList();
+inline raw_ostream &operator<<(raw_ostream &OS, const Value &V) {
+  V.print(OS);
+  return OS;
 }
-
+  
 void Use::set(Value *V) {
   if (Val) removeFromList();
   Val = V;
@@ -268,7 +289,8 @@ template <> inline bool isa_impl<GlobalAlias, Value>(const Value &Val) {
   return Val.getValueID() == Value::GlobalAliasVal;
 }
 template <> inline bool isa_impl<GlobalValue, Value>(const Value &Val) {
-  return isa<GlobalVariable>(Val) || isa<Function>(Val) || isa<GlobalAlias>(Val);
+  return isa<GlobalVariable>(Val) || isa<Function>(Val) ||
+         isa<GlobalAlias>(Val);
 }
 
 } // End llvm namespace