lib/VMCore/ConstantFolding.h

   1 //===-- ConstantHandling.h - Stuff for manipulating constants ----*- C++ -*--=//
   2 //
   3 // This file contains the declarations of some cool operators that allow you
   4 // to do natural things with constant pool values.
   5 //
   6 // Unfortunately we can't overload operators on pointer types (like this:)
   7 //
   8 //      inline bool operator==(const Constant *V1, const Constant *V2)
   9 //
  10 // so we must make due with references, even though it leads to some butt ugly
  11 // looking code downstream.  *sigh*  (ex:  Constant *Result = *V1 + *v2; )
  12 //
  13 //===----------------------------------------------------------------------===//
  14 //
  15 // WARNING: These operators may return a null object if I don't know how to
  16 //          perform the specified operation on the specified constant types.
  17 //
  18 //===----------------------------------------------------------------------===//
  19 //
  20 // Implementation notes:
  21 //   This library is implemented this way for a reason: In most cases, we do
  22 //   not want to have to link the constant mucking code into an executable.
  23 //   We do, however want to tie some of this into the main type system, as an
  24 //   optional component.  By using a mutable cache member in the Type class, we
  25 //   get exactly the kind of behavior we want.
  26 //
  27 // In the end, we get performance almost exactly the same as having a virtual
  28 // function dispatch, but we don't have to put our virtual functions into the
  29 // "Type" class, and we can implement functionality with templates. Good deal.
  30 //
  31 //===----------------------------------------------------------------------===//
  32
  33 #ifndef LLVM_CONSTANTHANDLING_H
  34 #define LLVM_CONSTANTHANDLING_H
  35
  36 #include "llvm/Constants.h"
  37 #include "llvm/Type.h"
  38 class PointerType;
  39
  40 //===----------------------------------------------------------------------===//
  41 //  Implement == and != directly...
  42 //===----------------------------------------------------------------------===//
  43
  44 inline ConstantBool *operator==(const Constant &V1,
  45                                 const Constant &V2) {
  46   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
  47   return ConstantBool::get(&V1 == &V2);
  48 }
  49
  50 inline ConstantBool *operator!=(const Constant &V1,
  51                                 const Constant &V2) {
  52   return ConstantBool::get(&V1 != &V2);
  53 }
  54
  55 //===----------------------------------------------------------------------===//
  56 //  Implement all other operators indirectly through TypeRules system
  57 //===----------------------------------------------------------------------===//
  58
  59 class ConstRules : public Annotation {
  60 protected:
  61   inline ConstRules() : Annotation(AID) {}  // Can only be subclassed...
  62 public:
  63   static AnnotationID AID;    // AnnotationID for this class
  64
  65   // Binary Operators...
  66   virtual Constant *add(const Constant *V1, const Constant *V2) const = 0;
  67   virtual Constant *sub(const Constant *V1, const Constant *V2) const = 0;
  68   virtual Constant *mul(const Constant *V1, const Constant *V2) const = 0;
  69   virtual Constant *div(const Constant *V1, const Constant *V2) const = 0;
  70   virtual Constant *rem(const Constant *V1, const Constant *V2) const = 0;
  71   virtual Constant *op_and(const Constant *V1, const Constant *V2) const = 0;
  72   virtual Constant *op_or (const Constant *V1, const Constant *V2) const = 0;
  73   virtual Constant *op_xor(const Constant *V1, const Constant *V2) const = 0;
  74   virtual Constant *shl(const Constant *V1, const Constant *V2) const = 0;
  75   virtual Constant *shr(const Constant *V1, const Constant *V2) const = 0;
  76
  77   virtual ConstantBool *lessthan(const Constant *V1,
  78                                  const Constant *V2) const = 0;
  79
  80   // Casting operators.  ick
  81   virtual ConstantBool *castToBool  (const Constant *V) const = 0;
  82   virtual ConstantSInt *castToSByte (const Constant *V) const = 0;
  83   virtual ConstantUInt *castToUByte (const Constant *V) const = 0;
  84   virtual ConstantSInt *castToShort (const Constant *V) const = 0;
  85   virtual ConstantUInt *castToUShort(const Constant *V) const = 0;
  86   virtual ConstantSInt *castToInt   (const Constant *V) const = 0;
  87   virtual ConstantUInt *castToUInt  (const Constant *V) const = 0;
  88   virtual ConstantSInt *castToLong  (const Constant *V) const = 0;
  89   virtual ConstantUInt *castToULong (const Constant *V) const = 0;
  90   virtual ConstantFP   *castToFloat (const Constant *V) const = 0;
  91   virtual ConstantFP   *castToDouble(const Constant *V) const = 0;
  92   virtual ConstantPointer *castToPointer(const Constant *V,
  93                                          const PointerType *Ty) const = 0;
  94
  95   inline Constant *castTo(const Constant *V, const Type *Ty) const {
  96     switch (Ty->getPrimitiveID()) {
  97     case Type::BoolTyID:   return castToBool(V);
  98     case Type::UByteTyID:  return castToUByte(V);
  99     case Type::SByteTyID:  return castToSByte(V);
 100     case Type::UShortTyID: return castToUShort(V);
 101     case Type::ShortTyID:  return castToShort(V);
 102     case Type::UIntTyID:   return castToUInt(V);
 103     case Type::IntTyID:    return castToInt(V);
 104     case Type::ULongTyID:  return castToULong(V);
 105     case Type::LongTyID:   return castToLong(V);
 106     case Type::FloatTyID:  return castToFloat(V);
 107     case Type::DoubleTyID: return castToDouble(V);
 108     case Type::PointerTyID:return castToPointer(V, (PointerType*)Ty);
 109     default: return 0;
 110     }
 111   }
 112
 113   // ConstRules::get - A type will cache its own type rules if one is needed...
 114   // we just want to make sure to hit the cache instead of doing it indirectly,
 115   //  if possible...
 116   //
 117   static inline ConstRules *get(const Constant &V) {
 118     return (ConstRules*)V.getType()->getOrCreateAnnotation(AID);
 119   }
 120 private :
 121   static Annotation *find(AnnotationID AID, const Annotable *Ty, void *);
 122
 123   ConstRules(const ConstRules &);             // Do not implement
 124   ConstRules &operator=(const ConstRules &);  // Do not implement
 125 };
 126
 127
 128 // Standard binary operators...
 129 inline Constant *operator+(const Constant &V1, const Constant &V2) {
 130   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
 131   return ConstRules::get(V1)->add(&V1, &V2);
 132 }
 133
 134 inline Constant *operator-(const Constant &V1, const Constant &V2) {
 135   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
 136   return ConstRules::get(V1)->sub(&V1, &V2);
 137 }
 138
 139 inline Constant *operator*(const Constant &V1, const Constant &V2) {
 140   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
 141   return ConstRules::get(V1)->mul(&V1, &V2);
 142 }
 143
 144 inline Constant *operator/(const Constant &V1, const Constant &V2) {
 145   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
 146   return ConstRules::get(V1)->div(&V1, &V2);
 147 }
 148
 149 inline Constant *operator%(const Constant &V1, const Constant &V2) {
 150   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
 151   return ConstRules::get(V1)->rem(&V1, &V2);
 152 }
 153
 154 // Logical Operators...
 155 inline Constant *operator&(const Constant &V1, const Constant &V2) {
 156   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
 157   return ConstRules::get(V1)->op_and(&V1, &V2);
 158 }
 159
 160 inline Constant *operator|(const Constant &V1, const Constant &V2) {
 161   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
 162   return ConstRules::get(V1)->op_or(&V1, &V2);
 163 }
 164
 165 inline Constant *operator^(const Constant &V1, const Constant &V2) {
 166   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
 167   return ConstRules::get(V1)->op_xor(&V1, &V2);
 168 }
 169
 170 // Shift Instructions...
 171 inline Constant *operator<<(const Constant &V1, const Constant &V2) {
 172   assert(V1.getType()->isInteger() && V2.getType() == Type::UByteTy);
 173   return ConstRules::get(V1)->shl(&V1, &V2);
 174 }
 175
 176 inline Constant *operator>>(const Constant &V1, const Constant &V2) {
 177   assert(V1.getType()->isInteger() && V2.getType() == Type::UByteTy);
 178   return ConstRules::get(V1)->shr(&V1, &V2);
 179 }
 180
 181 inline ConstantBool *operator<(const Constant &V1,
 182                                const Constant &V2) {
 183   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
 184   return ConstRules::get(V1)->lessthan(&V1, &V2);
 185 }
 186
 187
 188 //===----------------------------------------------------------------------===//
 189 //  Implement 'derived' operators based on what we already have...
 190 //===----------------------------------------------------------------------===//
 191
 192 inline ConstantBool *operator>(const Constant &V1,
 193                                const Constant &V2) {
 194   return V2 < V1;
 195 }
 196
 197 inline ConstantBool *operator>=(const Constant &V1,
 198                                 const Constant &V2) {
 199   return (V1 < V2)->inverted();      // !(V1 < V2)
 200 }
 201
 202 inline ConstantBool *operator<=(const Constant &V1,
 203                                 const Constant &V2) {
 204   return (V1 > V2)->inverted();      // !(V1 > V2)
 205 }
 206
 207
 208 //===----------------------------------------------------------------------===//
 209 //  Implement higher level instruction folding type instructions
 210 //===----------------------------------------------------------------------===//
 211
 212 // ConstantFoldInstruction - Attempt to constant fold the specified instruction.
 213 // If successful, the constant result is returned, if not, null is returned.
 214 //
 215 Constant *ConstantFoldInstruction(Instruction *I);
 216
 217 // Constant fold various types of instruction...
 218 Constant *ConstantFoldCastInstruction(const Constant *V, const Type *DestTy);
 219 Constant *ConstantFoldBinaryInstruction(unsigned Opcode, const Constant *V1,
 220                                         const Constant *V2);
 221 Constant *ConstantFoldShiftInstruction(unsigned Opcode, const Constant *V1,
 222                                        const Constant *V2);
 223
 224 #endif