1 //===-- ConstantHandling.h - Stuff for manipulating constants ---*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
10 // This file contains the declarations of some cool operators that allow you
11 // to do natural things with constant pool values.
13 // Unfortunately we can't overload operators on pointer types (like this:)
15 // inline bool operator==(const Constant *V1, const Constant *V2)
17 // so we must make due with references, even though it leads to some butt ugly
18 // looking code downstream. *sigh* (ex: Constant *Result = *V1 + *v2; )
20 //===----------------------------------------------------------------------===//
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.
25 //===----------------------------------------------------------------------===//
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.
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.
38 //===----------------------------------------------------------------------===//
40 #ifndef LLVM_CONSTANTHANDLING_H
41 #define LLVM_CONSTANTHANDLING_H
43 #include "llvm/Constants.h"
44 #include "llvm/Type.h"
47 //===----------------------------------------------------------------------===//
48 // Implement == and != directly...
49 //===----------------------------------------------------------------------===//
51 inline ConstantBool *operator==(const Constant &V1, const Constant &V2) {
52 assert(V1.getType() == V2.getType() && "Constant types must be identical!");
53 return ConstantBool::get(&V1 == &V2);
56 inline ConstantBool *operator!=(const Constant &V1, const Constant &V2) {
57 return ConstantBool::get(&V1 != &V2);
60 //===----------------------------------------------------------------------===//
61 // Implement all other operators indirectly through TypeRules system
62 //===----------------------------------------------------------------------===//
64 class ConstRules : public Annotation {
66 inline ConstRules() : Annotation(AID) {} // Can only be subclassed...
68 static AnnotationID AID; // AnnotationID for this class
70 // Binary Operators...
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;
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;
79 virtual Constant *shl(const Constant *V1, const Constant *V2) const = 0;
80 virtual Constant *shr(const Constant *V1, const Constant *V2) const = 0;
82 virtual ConstantBool *lessthan(const Constant *V1,
83 const Constant *V2) const = 0;
85 // Casting operators. ick
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;
97 virtual Constant *castToPointer(const Constant *V,
98 const PointerType *Ty) const = 0;
100 inline Constant *castTo(const Constant *V, const Type *Ty) const {
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);
113 case Type::PointerTyID:return castToPointer(V, (PointerType*)Ty);
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,
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);
128 static ConstRules *getConstantExprRules();
129 static Annotation *find(AnnotationID AID, const Annotable *Ty, void *);
131 ConstRules(const ConstRules &); // Do not implement
132 ConstRules &operator=(const ConstRules &); // Do not implement
135 // Unary operators...
136 inline Constant *operator~(const Constant &V) {
137 assert(V.getType()->isIntegral() && "Cannot invert non-integral constant!");
138 return ConstRules::get(V, V)->op_xor(&V,
139 ConstantInt::getAllOnesValue(V.getType()));
142 inline Constant *operator-(const Constant &V) {
143 return ConstRules::get(V, V)->sub(Constant::getNullValue(V.getType()), &V);
146 // Standard binary operators...
147 inline Constant *operator+(const Constant &V1, const Constant &V2) {
148 assert(V1.getType() == V2.getType() && "Constant types must be identical!");
149 return ConstRules::get(V1, V2)->add(&V1, &V2);
152 inline Constant *operator-(const Constant &V1, const Constant &V2) {
153 assert(V1.getType() == V2.getType() && "Constant types must be identical!");
154 return ConstRules::get(V1, V2)->sub(&V1, &V2);
157 inline Constant *operator*(const Constant &V1, const Constant &V2) {
158 assert(V1.getType() == V2.getType() && "Constant types must be identical!");
159 return ConstRules::get(V1, V2)->mul(&V1, &V2);
162 inline Constant *operator/(const Constant &V1, const Constant &V2) {
163 assert(V1.getType() == V2.getType() && "Constant types must be identical!");
164 return ConstRules::get(V1, V2)->div(&V1, &V2);
167 inline Constant *operator%(const Constant &V1, const Constant &V2) {
168 assert(V1.getType() == V2.getType() && "Constant types must be identical!");
169 return ConstRules::get(V1, V2)->rem(&V1, &V2);
172 // Logical Operators...
173 inline Constant *operator&(const Constant &V1, const Constant &V2) {
174 assert(V1.getType() == V2.getType() && "Constant types must be identical!");
175 return ConstRules::get(V1, V2)->op_and(&V1, &V2);
178 inline Constant *operator|(const Constant &V1, const Constant &V2) {
179 assert(V1.getType() == V2.getType() && "Constant types must be identical!");
180 return ConstRules::get(V1, V2)->op_or(&V1, &V2);
183 inline Constant *operator^(const Constant &V1, const Constant &V2) {
184 assert(V1.getType() == V2.getType() && "Constant types must be identical!");
185 return ConstRules::get(V1, V2)->op_xor(&V1, &V2);
188 // Shift Instructions...
189 inline Constant *operator<<(const Constant &V1, const Constant &V2) {
190 assert(V1.getType()->isInteger() && V2.getType() == Type::UByteTy);
191 return ConstRules::get(V1, V2)->shl(&V1, &V2);
194 inline Constant *operator>>(const Constant &V1, const Constant &V2) {
195 assert(V1.getType()->isInteger() && V2.getType() == Type::UByteTy);
196 return ConstRules::get(V1, V2)->shr(&V1, &V2);
199 inline ConstantBool *operator<(const Constant &V1,
200 const Constant &V2) {
201 assert(V1.getType() == V2.getType() && "Constant types must be identical!");
202 return ConstRules::get(V1, V2)->lessthan(&V1, &V2);
206 //===----------------------------------------------------------------------===//
207 // Implement 'derived' operators based on what we already have...
208 //===----------------------------------------------------------------------===//
210 inline ConstantBool *operator>(const Constant &V1,
211 const Constant &V2) {
215 inline ConstantBool *operator>=(const Constant &V1,
216 const Constant &V2) {
217 if (ConstantBool *V = (V1 < V2))
218 return V->inverted(); // !(V1 < V2)
222 inline ConstantBool *operator<=(const Constant &V1,
223 const Constant &V2) {
224 if (ConstantBool *V = (V1 > V2))
225 return V->inverted(); // !(V1 > V2)
230 //===----------------------------------------------------------------------===//
231 // Implement higher level instruction folding type instructions
232 //===----------------------------------------------------------------------===//
234 // ConstantFoldInstruction - Attempt to constant fold the specified instruction.
235 // If successful, the constant result is returned, if not, null is returned.
237 Constant *ConstantFoldInstruction(Instruction *I);
239 // Constant fold various types of instruction...
240 Constant *ConstantFoldCastInstruction(const Constant *V, const Type *DestTy);
241 Constant *ConstantFoldBinaryInstruction(unsigned Opcode, const Constant *V1,
243 Constant *ConstantFoldShiftInstruction(unsigned Opcode, const Constant *V1,
245 Constant *ConstantFoldGetElementPtr(const Constant *C,
246 const std::vector<Constant*> &IdxList);