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