include/llvm/ConstantHandling.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_OPT_CONSTANTHANDLING_H
  34 #define LLVM_OPT_CONSTANTHANDLING_H
  35
  36 #include "llvm/ConstantVals.h"
  37 #include "llvm/Instruction.h"
  38 #include "llvm/Type.h"
  39 class PointerType;
  40
  41 //===----------------------------------------------------------------------===//
  42 //  Implement == and != directly...
  43 //===----------------------------------------------------------------------===//
  44
  45 inline ConstantBool *operator==(const Constant &V1,
  46                                 const Constant &V2) {
  47   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
  48   return ConstantBool::get(&V1 == &V2);
  49 }
  50
  51 inline ConstantBool *operator!=(const Constant &V1,
  52                                 const Constant &V2) {
  53   return ConstantBool::get(&V1 != &V2);
  54 }
  55
  56 //===----------------------------------------------------------------------===//
  57 //  Implement all other operators indirectly through TypeRules system
  58 //===----------------------------------------------------------------------===//
  59
  60 class ConstRules : public Annotation {
  61 protected:
  62   inline ConstRules() : Annotation(AID) {}  // Can only be subclassed...
  63 public:
  64   static AnnotationID AID;    // AnnotationID for this class
  65
  66   // Unary Operators...
  67   virtual Constant *op_not(const Constant *V) const = 0;
  68
  69   // Binary Operators...
  70   virtual Constant *add(const Constant *V1,
  71                         const Constant *V2) const = 0;
  72   virtual Constant *sub(const Constant *V1,
  73                         const Constant *V2) const = 0;
  74   virtual Constant *mul(const Constant *V1,
  75                         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 inline Constant *operator!(const Constant &V) {
 129   return ConstRules::get(V)->op_not(&V);
 130 }
 131
 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)->add(&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)->sub(&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)->mul(&V1, &V2);
 147 }
 148
 149 inline ConstantBool *operator<(const Constant &V1,
 150                                const Constant &V2) {
 151   assert(V1.getType() == V2.getType() && "Constant types must be identical!");
 152   return ConstRules::get(V1)->lessthan(&V1, &V2);
 153 }
 154
 155
 156 //===----------------------------------------------------------------------===//
 157 //  Implement 'derived' operators based on what we already have...
 158 //===----------------------------------------------------------------------===//
 159
 160 inline ConstantBool *operator>(const Constant &V1,
 161                                const Constant &V2) {
 162   return V2 < V1;
 163 }
 164
 165 inline ConstantBool *operator>=(const Constant &V1,
 166                                 const Constant &V2) {
 167   return (V1 < V2)->inverted();      // !(V1 < V2)
 168 }
 169
 170 inline ConstantBool *operator<=(const Constant &V1,
 171                                 const Constant &V2) {
 172   return (V1 > V2)->inverted();      // !(V1 > V2)
 173 }
 174
 175
 176 //===----------------------------------------------------------------------===//
 177 //  Implement higher level instruction folding type instructions
 178 //===----------------------------------------------------------------------===//
 179
 180 inline Constant *ConstantFoldCastInstruction(const Constant *V,
 181                                              const Type *DestTy) {
 182   return ConstRules::get(*V)->castTo(V, DestTy);
 183 }
 184
 185 inline Constant *ConstantFoldUnaryInstruction(unsigned Opcode,
 186                                               const Constant *V) {
 187   switch (Opcode) {
 188   case Instruction::Not:  return !*V;
 189     // TODO: Handle get element ptr instruction here in the future? GEP null?
 190   }
 191   return 0;
 192 }
 193
 194 inline Constant *ConstantFoldBinaryInstruction(unsigned Opcode,
 195                                                const Constant *V1,
 196                                                const Constant *V2) {
 197   switch (Opcode) {
 198   case Instruction::Add:     return *V1 + *V2;
 199   case Instruction::Sub:     return *V1 - *V2;
 200
 201   case Instruction::SetEQ:   return *V1 == *V2;
 202   case Instruction::SetNE:   return *V1 != *V2;
 203   case Instruction::SetLE:   return *V1 <= *V2;
 204   case Instruction::SetGE:   return *V1 >= *V2;
 205   case Instruction::SetLT:   return *V1 <  *V2;
 206   case Instruction::SetGT:   return *V1 >  *V2;
 207   }
 208   return 0;
 209 }
 210
 211 #endif