lib/VMCore/ConstantFold.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, const Constant &V2) {
  45   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
  46   return ConstantBool::get(&V1 == &V2);
  47 }
  48
  49 inline ConstantBool *operator!=(const Constant &V1, const Constant &V2) {
  50   return ConstantBool::get(&V1 != &V2);
  51 }
  52
  53 //===----------------------------------------------------------------------===//
  54 //  Implement all other operators indirectly through TypeRules system
  55 //===----------------------------------------------------------------------===//
  56
  57 class ConstRules : public Annotation {
  58 protected:
  59   inline ConstRules() : Annotation(AID) {}  // Can only be subclassed...
  60 public:
  61   static AnnotationID AID;    // AnnotationID for this class
  62
  63   // Binary Operators...
  64   virtual Constant *add(const Constant *V1, const Constant *V2) const = 0;
  65   virtual Constant *sub(const Constant *V1, const Constant *V2) const = 0;
  66   virtual Constant *mul(const Constant *V1, const Constant *V2) const = 0;
  67   virtual Constant *div(const Constant *V1, const Constant *V2) const = 0;
  68   virtual Constant *rem(const Constant *V1, const Constant *V2) const = 0;
  69   virtual Constant *op_and(const Constant *V1, const Constant *V2) const = 0;
  70   virtual Constant *op_or (const Constant *V1, const Constant *V2) const = 0;
  71   virtual Constant *op_xor(const Constant *V1, const Constant *V2) const = 0;
  72   virtual Constant *shl(const Constant *V1, const Constant *V2) const = 0;
  73   virtual Constant *shr(const Constant *V1, const Constant *V2) const = 0;
  74
  75   virtual ConstantBool *lessthan(const Constant *V1,
  76                                  const Constant *V2) const = 0;
  77
  78   // Casting operators.  ick
  79   virtual ConstantBool *castToBool  (const Constant *V) const = 0;
  80   virtual ConstantSInt *castToSByte (const Constant *V) const = 0;
  81   virtual ConstantUInt *castToUByte (const Constant *V) const = 0;
  82   virtual ConstantSInt *castToShort (const Constant *V) const = 0;
  83   virtual ConstantUInt *castToUShort(const Constant *V) const = 0;
  84   virtual ConstantSInt *castToInt   (const Constant *V) const = 0;
  85   virtual ConstantUInt *castToUInt  (const Constant *V) const = 0;
  86   virtual ConstantSInt *castToLong  (const Constant *V) const = 0;
  87   virtual ConstantUInt *castToULong (const Constant *V) const = 0;
  88   virtual ConstantFP   *castToFloat (const Constant *V) const = 0;
  89   virtual ConstantFP   *castToDouble(const Constant *V) const = 0;
  90   virtual Constant     *castToPointer(const Constant *V,
  91                                       const PointerType *Ty) const = 0;
  92
  93   inline Constant *castTo(const Constant *V, const Type *Ty) const {
  94     switch (Ty->getPrimitiveID()) {
  95     case Type::BoolTyID:   return castToBool(V);
  96     case Type::UByteTyID:  return castToUByte(V);
  97     case Type::SByteTyID:  return castToSByte(V);
  98     case Type::UShortTyID: return castToUShort(V);
  99     case Type::ShortTyID:  return castToShort(V);
 100     case Type::UIntTyID:   return castToUInt(V);
 101     case Type::IntTyID:    return castToInt(V);
 102     case Type::ULongTyID:  return castToULong(V);
 103     case Type::LongTyID:   return castToLong(V);
 104     case Type::FloatTyID:  return castToFloat(V);
 105     case Type::DoubleTyID: return castToDouble(V);
 106     case Type::PointerTyID:return castToPointer(V, (PointerType*)Ty);
 107     default: return 0;
 108     }
 109   }
 110
 111   // ConstRules::get - A type will cache its own type rules if one is needed...
 112   // we just want to make sure to hit the cache instead of doing it indirectly,
 113   //  if possible...
 114   //
 115   static inline ConstRules *get(const Constant &V1, const Constant &V2) {
 116     if (isa<ConstantExpr>(V1) || isa<ConstantExpr>(V2))
 117       return getConstantExprRules();
 118     return (ConstRules*)V1.getType()->getOrCreateAnnotation(AID);
 119   }
 120 private:
 121   static ConstRules *getConstantExprRules();
 122   static Annotation *find(AnnotationID AID, const Annotable *Ty, void *);
 123
 124   ConstRules(const ConstRules &);             // Do not implement
 125   ConstRules &operator=(const ConstRules &);  // Do not implement
 126 };
 127
 128
 129 // Standard binary operators...
 130 inline Constant *operator+(const Constant &V1, const Constant &V2) {
 131   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
 132   return ConstRules::get(V1, V2)->add(&V1, &V2);
 133 }
 134
 135 inline Constant *operator-(const Constant &V1, const Constant &V2) {
 136   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
 137   return ConstRules::get(V1, V2)->sub(&V1, &V2);
 138 }
 139
 140 inline Constant *operator*(const Constant &V1, const Constant &V2) {
 141   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
 142   return ConstRules::get(V1, V2)->mul(&V1, &V2);
 143 }
 144
 145 inline Constant *operator/(const Constant &V1, const Constant &V2) {
 146   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
 147   return ConstRules::get(V1, V2)->div(&V1, &V2);
 148 }
 149
 150 inline Constant *operator%(const Constant &V1, const Constant &V2) {
 151   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
 152   return ConstRules::get(V1, V2)->rem(&V1, &V2);
 153 }
 154
 155 // Logical Operators...
 156 inline Constant *operator&(const Constant &V1, const Constant &V2) {
 157   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
 158   return ConstRules::get(V1, V2)->op_and(&V1, &V2);
 159 }
 160
 161 inline Constant *operator|(const Constant &V1, const Constant &V2) {
 162   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
 163   return ConstRules::get(V1, V2)->op_or(&V1, &V2);
 164 }
 165
 166 inline Constant *operator^(const Constant &V1, const Constant &V2) {
 167   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
 168   return ConstRules::get(V1, V2)->op_xor(&V1, &V2);
 169 }
 170
 171 // Shift Instructions...
 172 inline Constant *operator<<(const Constant &V1, const Constant &V2) {
 173   assert(V1.getType()->isInteger() && V2.getType() == Type::UByteTy);
 174   return ConstRules::get(V1, V2)->shl(&V1, &V2);
 175 }
 176
 177 inline Constant *operator>>(const Constant &V1, const Constant &V2) {
 178   assert(V1.getType()->isInteger() && V2.getType() == Type::UByteTy);
 179   return ConstRules::get(V1, V2)->shr(&V1, &V2);
 180 }
 181
 182 inline ConstantBool *operator<(const Constant &V1,
 183                                const Constant &V2) {
 184   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
 185   return ConstRules::get(V1, V2)->lessthan(&V1, &V2);
 186 }
 187
 188
 189 //===----------------------------------------------------------------------===//
 190 //  Implement 'derived' operators based on what we already have...
 191 //===----------------------------------------------------------------------===//
 192
 193 inline ConstantBool *operator>(const Constant &V1,
 194                                const Constant &V2) {
 195   return V2 < V1;
 196 }
 197
 198 inline ConstantBool *operator>=(const Constant &V1,
 199                                 const Constant &V2) {
 200   if (ConstantBool *V = (V1 < V2))
 201     return V->inverted();                // !(V1 < V2)
 202   return 0;
 203 }
 204
 205 inline ConstantBool *operator<=(const Constant &V1,
 206                                 const Constant &V2) {
 207   if (ConstantBool *V = (V1 > V2))
 208     return V->inverted();                // !(V1 > V2)
 209   return 0;
 210 }
 211
 212
 213 //===----------------------------------------------------------------------===//
 214 //  Implement higher level instruction folding type instructions
 215 //===----------------------------------------------------------------------===//
 216
 217 // ConstantFoldInstruction - Attempt to constant fold the specified instruction.
 218 // If successful, the constant result is returned, if not, null is returned.
 219 //
 220 Constant *ConstantFoldInstruction(Instruction *I);
 221
 222 // Constant fold various types of instruction...
 223 Constant *ConstantFoldCastInstruction(const Constant *V, const Type *DestTy);
 224 Constant *ConstantFoldBinaryInstruction(unsigned Opcode, const Constant *V1,
 225                                         const Constant *V2);
 226 Constant *ConstantFoldShiftInstruction(unsigned Opcode, const Constant *V1,
 227                                        const Constant *V2);
 228 Constant *ConstantFoldGetElementPtr(const Constant *C,
 229                                     const std::vector<Constant*> &IdxList);
 230 #endif