Merging the linear scan register allocator in trunk. It currently passes most tests...
[oota-llvm.git] / include / llvm / ConstantHandling.h
index 14231cb6abfbf129a600d86db48a8bde955c3e05..27eed8a7bec9f1f0a9148bc80d342a8dec1df5c4 100644 (file)
@@ -1,4 +1,11 @@
-//===-- ConstantHandling.h - Stuff for manipulating constants ----*- C++ -*--=//
+//===-- ConstantHandling.h - Stuff for manipulating constants ---*- 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 contains the declarations of some cool operators that allow you
 // to do natural things with constant pool values.
 #define LLVM_CONSTANTHANDLING_H
 
 #include "llvm/Constants.h"
-#include "llvm/Instruction.h"
 #include "llvm/Type.h"
-class PointerType;
 
-//===----------------------------------------------------------------------===//
-//  Implement == and != directly...
-//===----------------------------------------------------------------------===//
+namespace llvm {
 
-inline ConstantBool *operator==(const Constant &V1, 
-                                const Constant &V2) {
-  assert(V1.getType() == V2.getType() && "Constant types must be identical!");
-  return ConstantBool::get(&V1 == &V2);
-}
-
-inline ConstantBool *operator!=(const Constant &V1, 
-                                const Constant &V2) {
-  return ConstantBool::get(&V1 != &V2);
-}
+class PointerType;
 
 //===----------------------------------------------------------------------===//
 //  Implement all other operators indirectly through TypeRules system
 //===----------------------------------------------------------------------===//
 
-class ConstRules : public Annotation {
-protected:
-  inline ConstRules() : Annotation(AID) {}  // Can only be subclassed...
-public:
-  static AnnotationID AID;    // AnnotationID for this class
-
-  // Unary Operators...
-  virtual Constant *op_not(const Constant *V) const = 0;
+struct ConstRules {
+  ConstRules() {}
 
   // Binary Operators...
-  virtual Constant *add(const Constant *V1, 
-                        const Constant *V2) const = 0;
-  virtual Constant *sub(const Constant *V1, 
-                        const Constant *V2) const = 0;
-  virtual Constant *mul(const Constant *V1, 
-                        const Constant *V2) const = 0;
-  virtual Constant *div(const Constant *V1, 
-                        const Constant *V2) const = 0;
+  virtual Constant *add(const Constant *V1, const Constant *V2) const = 0;
+  virtual Constant *sub(const Constant *V1, const Constant *V2) const = 0;
+  virtual Constant *mul(const Constant *V1, const Constant *V2) const = 0;
+  virtual Constant *div(const Constant *V1, const Constant *V2) const = 0;
+  virtual Constant *rem(const Constant *V1, const Constant *V2) const = 0;
+  virtual Constant *op_and(const Constant *V1, const Constant *V2) const = 0;
+  virtual Constant *op_or (const Constant *V1, const Constant *V2) const = 0;
+  virtual Constant *op_xor(const Constant *V1, const Constant *V2) const = 0;
+  virtual Constant *shl(const Constant *V1, const Constant *V2) const = 0;
+  virtual Constant *shr(const Constant *V1, const Constant *V2) const = 0;
 
   virtual ConstantBool *lessthan(const Constant *V1, 
                                  const Constant *V2) const = 0;
+  virtual ConstantBool *equalto(const Constant *V1, 
+                                const Constant *V2) const = 0;
 
   // Casting operators.  ick
   virtual ConstantBool *castToBool  (const Constant *V) const = 0;
@@ -91,8 +83,8 @@ public:
   virtual ConstantUInt *castToULong (const Constant *V) const = 0;
   virtual ConstantFP   *castToFloat (const Constant *V) const = 0;
   virtual ConstantFP   *castToDouble(const Constant *V) const = 0;
-  virtual ConstantPointer *castToPointer(const Constant *V,
-                                         const PointerType *Ty) const = 0;
+  virtual Constant     *castToPointer(const Constant *V,
+                                      const PointerType *Ty) const = 0;
 
   inline Constant *castTo(const Constant *V, const Type *Ty) const {
     switch (Ty->getPrimitiveID()) {
@@ -107,63 +99,106 @@ public:
     case Type::LongTyID:   return castToLong(V);
     case Type::FloatTyID:  return castToFloat(V);
     case Type::DoubleTyID: return castToDouble(V);
-    case Type::PointerTyID:return castToPointer(V, (PointerType*)Ty);
+    case Type::PointerTyID:
+      return castToPointer(V, reinterpret_cast<const PointerType*>(Ty));
     default: return 0;
     }
   }
 
-  // ConstRules::get - A type will cache its own type rules if one is needed...
-  // we just want to make sure to hit the cache instead of doing it indirectly,
-  //  if possible...
+  // ConstRules::get - Return an instance of ConstRules for the specified
+  // constant operands.
   //
-  static inline ConstRules *get(const Constant &V) {
-    return (ConstRules*)V.getType()->getOrCreateAnnotation(AID);
-  }
-private :
-  static Annotation *find(AnnotationID AID, const Annotable *Ty, void *);
-
+  static ConstRules &get(const Constant &V1, const Constant &V2);
+private:
   ConstRules(const ConstRules &);             // Do not implement
   ConstRules &operator=(const ConstRules &);  // Do not implement
 };
 
-
-inline Constant *operator!(const Constant &V) {
-  return ConstRules::get(V)->op_not(&V);
+// Unary operators...
+inline Constant *operator~(const Constant &V) {
+  assert(V.getType()->isIntegral() && "Cannot invert non-integral constant!");
+  return ConstRules::get(V, V).op_xor(&V,
+                                    ConstantInt::getAllOnesValue(V.getType()));
 }
 
+inline Constant *operator-(const Constant &V) {
+  return ConstRules::get(V, V).sub(Constant::getNullValue(V.getType()), &V);
+}
 
-
+// Standard binary operators...
 inline Constant *operator+(const Constant &V1, const Constant &V2) {
   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
-  return ConstRules::get(V1)->add(&V1, &V2);
+  return ConstRules::get(V1, V2).add(&V1, &V2);
 }
 
 inline Constant *operator-(const Constant &V1, const Constant &V2) {
   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
-  return ConstRules::get(V1)->sub(&V1, &V2);
+  return ConstRules::get(V1, V2).sub(&V1, &V2);
 }
 
 inline Constant *operator*(const Constant &V1, const Constant &V2) {
   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
-  return ConstRules::get(V1)->mul(&V1, &V2);
+  return ConstRules::get(V1, V2).mul(&V1, &V2);
 }
 
 inline Constant *operator/(const Constant &V1, const Constant &V2) {
   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
-  return ConstRules::get(V1)->div(&V1, &V2);
+  return ConstRules::get(V1, V2).div(&V1, &V2);
+}
+
+inline Constant *operator%(const Constant &V1, const Constant &V2) {
+  assert(V1.getType() == V2.getType() && "Constant types must be identical!");
+  return ConstRules::get(V1, V2).rem(&V1, &V2);
+}
+
+// Logical Operators...
+inline Constant *operator&(const Constant &V1, const Constant &V2) {
+  assert(V1.getType() == V2.getType() && "Constant types must be identical!");
+  return ConstRules::get(V1, V2).op_and(&V1, &V2);
+}
+
+inline Constant *operator|(const Constant &V1, const Constant &V2) {
+  assert(V1.getType() == V2.getType() && "Constant types must be identical!");
+  return ConstRules::get(V1, V2).op_or(&V1, &V2);
+}
+
+inline Constant *operator^(const Constant &V1, const Constant &V2) {
+  assert(V1.getType() == V2.getType() && "Constant types must be identical!");
+  return ConstRules::get(V1, V2).op_xor(&V1, &V2);
+}
+
+// Shift Instructions...
+inline Constant *operator<<(const Constant &V1, const Constant &V2) {
+  assert(V1.getType()->isInteger() && V2.getType() == Type::UByteTy);
+  return ConstRules::get(V1, V2).shl(&V1, &V2);
+}
+
+inline Constant *operator>>(const Constant &V1, const Constant &V2) {
+  assert(V1.getType()->isInteger() && V2.getType() == Type::UByteTy);
+  return ConstRules::get(V1, V2).shr(&V1, &V2);
 }
 
 inline ConstantBool *operator<(const Constant &V1, 
                                const Constant &V2) {
   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
-  return ConstRules::get(V1)->lessthan(&V1, &V2);
+  return ConstRules::get(V1, V2).lessthan(&V1, &V2);
 }
 
+inline ConstantBool *operator==(const Constant &V1, const Constant &V2) {
+  assert(V1.getType() == V2.getType() && "Constant types must be identical!");
+  return ConstRules::get(V1, V2).equalto(&V1, &V2);
+}
 
 //===----------------------------------------------------------------------===//
 //  Implement 'derived' operators based on what we already have...
 //===----------------------------------------------------------------------===//
 
+inline ConstantBool *operator!=(const Constant &V1, const Constant &V2) {
+  if (ConstantBool *V = (V1 == V2))
+    return V->inverted();                // !(V1 == V2)
+  return 0;
+}
+
 inline ConstantBool *operator>(const Constant &V1, 
                                const Constant &V2) {
   return V2 < V1;
@@ -171,12 +206,16 @@ inline ConstantBool *operator>(const Constant &V1,
 
 inline ConstantBool *operator>=(const Constant &V1, 
                                 const Constant &V2) {
-  return (V1 < V2)->inverted();      // !(V1 < V2)
+  if (ConstantBool *V = (V1 < V2))
+    return V->inverted();                // !(V1 < V2)
+  return 0;
 }
 
 inline ConstantBool *operator<=(const Constant &V1, 
                                 const Constant &V2) {
-  return (V1 > V2)->inverted();      // !(V1 > V2)
+  if (ConstantBool *V = (V1 > V2))
+    return V->inverted();                // !(V1 > V2)
+  return 0;
 }
 
 
@@ -184,37 +223,20 @@ inline ConstantBool *operator<=(const Constant &V1,
 //  Implement higher level instruction folding type instructions
 //===----------------------------------------------------------------------===//
 
-inline Constant *ConstantFoldCastInstruction(const Constant *V,
-                                             const Type *DestTy) {
-  return ConstRules::get(*V)->castTo(V, DestTy);
-}
-
-inline Constant *ConstantFoldUnaryInstruction(unsigned Opcode, 
-                                              const Constant *V) {
-  switch (Opcode) {
-  case Instruction::Not:  return !*V;
-    // TODO: Handle get element ptr instruction here in the future? GEP null?
-  }
-  return 0;
-}
-
-inline Constant *ConstantFoldBinaryInstruction(unsigned Opcode,
-                                               const Constant *V1, 
-                                               const Constant *V2) {
-  switch (Opcode) {
-  case Instruction::Add:     return *V1 + *V2;
-  case Instruction::Sub:     return *V1 - *V2;
-  case Instruction::Mul:     return *V1 * *V2;
-  case Instruction::Div:     return *V1 / *V2;
-
-  case Instruction::SetEQ:   return *V1 == *V2;
-  case Instruction::SetNE:   return *V1 != *V2;
-  case Instruction::SetLE:   return *V1 <= *V2;
-  case Instruction::SetGE:   return *V1 >= *V2;
-  case Instruction::SetLT:   return *V1 <  *V2;
-  case Instruction::SetGT:   return *V1 >  *V2;
-  }
-  return 0;
-}
+// ConstantFoldInstruction - Attempt to constant fold the specified instruction.
+// If successful, the constant result is returned, if not, null is returned.
+//
+Constant *ConstantFoldInstruction(Instruction *I);
+
+// Constant fold various types of instruction...
+Constant *ConstantFoldCastInstruction(const Constant *V, const Type *DestTy);
+Constant *ConstantFoldBinaryInstruction(unsigned Opcode, const Constant *V1,
+                                        const Constant *V2);
+Constant *ConstantFoldShiftInstruction(unsigned Opcode, const Constant *V1,
+                                       const Constant *V2);
+Constant *ConstantFoldGetElementPtr(const Constant *C,
+                                    const std::vector<Constant*> &IdxList);
+
+} // End llvm namespace
 
 #endif