-//===-- ConstantHandling.h - Stuff for manipulating constants ----*- C++ -*--=//
+//===-- ConstantHandling.h - Stuff for manipulating constants ---*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
//
// This file contains the declarations of some cool operators that allow you
// to do natural things with constant pool values.
//
// Unfortunately we can't overload operators on pointer types (like this:)
//
-// inline bool operator==(const ConstPoolVal *V1, const ConstPoolVal *V2)
+// inline bool operator==(const Constant *V1, const Constant *V2)
//
// so we must make due with references, even though it leads to some butt ugly
-// looking code downstream. *sigh* (ex: ConstPoolVal *Result = *V1 + *v2; )
+// looking code downstream. *sigh* (ex: Constant *Result = *V1 + *v2; )
//
//===----------------------------------------------------------------------===//
//
-// WARNING: These operators return pointers to newly 'new'd objects. You MUST
-// make sure to free them if you don't want them hanging around. Also,
-// note that these may return a null object if I don't know how to
-// perform those operations on the specified constant types.
+// WARNING: These operators may return a null object if I don't know how to
+// perform the specified operation on the specified constant types.
//
//===----------------------------------------------------------------------===//
//
//
//===----------------------------------------------------------------------===//
-#ifndef LLVM_OPT_CONSTANTHANDLING_H
-#define LLVM_OPT_CONSTANTHANDLING_H
+#ifndef LLVM_CONSTANTHANDLING_H
+#define LLVM_CONSTANTHANDLING_H
-#include "llvm/ConstPoolVals.h"
+#include "llvm/Constants.h"
#include "llvm/Type.h"
+namespace llvm {
+
+class PointerType;
+
//===----------------------------------------------------------------------===//
-// Implement == directly...
+// Implement == and != directly...
//===----------------------------------------------------------------------===//
-inline ConstPoolBool *operator==(const ConstPoolVal &V1,
- const ConstPoolVal &V2) {
+inline ConstantBool *operator==(const Constant &V1, const Constant &V2) {
assert(V1.getType() == V2.getType() && "Constant types must be identical!");
- return new ConstPoolBool(V1.equals(&V2));
+ return ConstantBool::get(&V1 == &V2);
+}
+
+inline ConstantBool *operator!=(const Constant &V1, const Constant &V2) {
+ return ConstantBool::get(&V1 != &V2);
}
//===----------------------------------------------------------------------===//
// Implement all other operators indirectly through TypeRules system
//===----------------------------------------------------------------------===//
-class ConstRules {
+class ConstRules : public Annotation {
protected:
- inline ConstRules() {} // Can only be subclassed...
+ inline ConstRules() : Annotation(AID) {} // Can only be subclassed...
public:
- // Unary Operators...
- virtual ConstPoolVal *neg(const ConstPoolVal *V) const = 0;
- virtual ConstPoolVal *not(const ConstPoolVal *V) const = 0;
+ static AnnotationID AID; // AnnotationID for this class
// Binary Operators...
- virtual ConstPoolVal *add(const ConstPoolVal *V1,
- const ConstPoolVal *V2) const = 0;
- virtual ConstPoolVal *sub(const ConstPoolVal *V1,
- const ConstPoolVal *V2) const = 0;
-
- virtual ConstPoolBool *lessthan(const ConstPoolVal *V1,
- const ConstPoolVal *V2) const = 0;
+ virtual Constant *add(const Constant *V1, const Constant *V2) const = 0;
+ virtual Constant *sub(const Constant *V1, const Constant *V2) const = 0;
+ virtual Constant *mul(const Constant *V1, const Constant *V2) const = 0;
+ virtual Constant *div(const Constant *V1, const Constant *V2) const = 0;
+ virtual Constant *rem(const Constant *V1, const Constant *V2) const = 0;
+ virtual Constant *op_and(const Constant *V1, const Constant *V2) const = 0;
+ virtual Constant *op_or (const Constant *V1, const Constant *V2) const = 0;
+ virtual Constant *op_xor(const Constant *V1, const Constant *V2) const = 0;
+ virtual Constant *shl(const Constant *V1, const Constant *V2) const = 0;
+ virtual Constant *shr(const Constant *V1, const Constant *V2) const = 0;
+
+ virtual ConstantBool *lessthan(const Constant *V1,
+ const Constant *V2) const = 0;
+
+ // Casting operators. ick
+ virtual ConstantBool *castToBool (const Constant *V) const = 0;
+ virtual ConstantSInt *castToSByte (const Constant *V) const = 0;
+ virtual ConstantUInt *castToUByte (const Constant *V) const = 0;
+ virtual ConstantSInt *castToShort (const Constant *V) const = 0;
+ virtual ConstantUInt *castToUShort(const Constant *V) const = 0;
+ virtual ConstantSInt *castToInt (const Constant *V) const = 0;
+ virtual ConstantUInt *castToUInt (const Constant *V) const = 0;
+ virtual ConstantSInt *castToLong (const Constant *V) const = 0;
+ virtual ConstantUInt *castToULong (const Constant *V) const = 0;
+ virtual ConstantFP *castToFloat (const Constant *V) const = 0;
+ virtual ConstantFP *castToDouble(const Constant *V) const = 0;
+ virtual Constant *castToPointer(const Constant *V,
+ const PointerType *Ty) const = 0;
+
+ inline Constant *castTo(const Constant *V, const Type *Ty) const {
+ switch (Ty->getPrimitiveID()) {
+ case Type::BoolTyID: return castToBool(V);
+ case Type::UByteTyID: return castToUByte(V);
+ case Type::SByteTyID: return castToSByte(V);
+ case Type::UShortTyID: return castToUShort(V);
+ case Type::ShortTyID: return castToShort(V);
+ case Type::UIntTyID: return castToUInt(V);
+ case Type::IntTyID: return castToInt(V);
+ case Type::ULongTyID: return castToULong(V);
+ case Type::LongTyID: return castToLong(V);
+ case Type::FloatTyID: return castToFloat(V);
+ case Type::DoubleTyID: return castToDouble(V);
+ case Type::PointerTyID:
+ return castToPointer(V, reinterpret_cast<const PointerType*>(Ty));
+ default: return 0;
+ }
+ }
// ConstRules::get - A type will cache its own type rules if one is needed...
// we just want to make sure to hit the cache instead of doing it indirectly,
// if possible...
//
- static inline const ConstRules *get(const ConstPoolVal &V) {
- const ConstRules *Result = V.getType()->getConstRules();
- return Result ? Result : find(V.getType());
+ static inline ConstRules *get(const Constant &V1, const Constant &V2) {
+ if (isa<ConstantExpr>(V1) || isa<ConstantExpr>(V2))
+ return getConstantExprRules();
+ return static_cast<ConstRules*>(V1.getType()->getOrCreateAnnotation(AID));
}
-private :
- static const ConstRules *find(const Type *Ty);
+private:
+ static ConstRules *getConstantExprRules();
+ static Annotation *find(AnnotationID AID, const Annotable *Ty, void *);
ConstRules(const ConstRules &); // Do not implement
ConstRules &operator=(const ConstRules &); // Do not implement
};
+// Unary operators...
+inline Constant *operator~(const Constant &V) {
+ assert(V.getType()->isIntegral() && "Cannot invert non-integral constant!");
+ return ConstRules::get(V, V)->op_xor(&V,
+ ConstantInt::getAllOnesValue(V.getType()));
+}
-inline ConstPoolVal *operator-(const ConstPoolVal &V) {
- return ConstRules::get(V)->neg(&V);
+inline Constant *operator-(const Constant &V) {
+ return ConstRules::get(V, V)->sub(Constant::getNullValue(V.getType()), &V);
}
-inline ConstPoolVal *operator!(const ConstPoolVal &V) {
- return ConstRules::get(V)->not(&V);
+// Standard binary operators...
+inline Constant *operator+(const Constant &V1, const Constant &V2) {
+ assert(V1.getType() == V2.getType() && "Constant types must be identical!");
+ return ConstRules::get(V1, V2)->add(&V1, &V2);
}
+inline Constant *operator-(const Constant &V1, const Constant &V2) {
+ assert(V1.getType() == V2.getType() && "Constant types must be identical!");
+ return ConstRules::get(V1, V2)->sub(&V1, &V2);
+}
+inline Constant *operator*(const Constant &V1, const Constant &V2) {
+ assert(V1.getType() == V2.getType() && "Constant types must be identical!");
+ return ConstRules::get(V1, V2)->mul(&V1, &V2);
+}
-inline ConstPoolVal *operator+(const ConstPoolVal &V1, const ConstPoolVal &V2) {
+inline Constant *operator/(const Constant &V1, const Constant &V2) {
assert(V1.getType() == V2.getType() && "Constant types must be identical!");
- return ConstRules::get(V1)->add(&V1, &V2);
+ return ConstRules::get(V1, V2)->div(&V1, &V2);
}
-inline ConstPoolVal *operator-(const ConstPoolVal &V1, const ConstPoolVal &V2) {
+inline Constant *operator%(const Constant &V1, const Constant &V2) {
assert(V1.getType() == V2.getType() && "Constant types must be identical!");
- return ConstRules::get(V1)->sub(&V1, &V2);
+ return ConstRules::get(V1, V2)->rem(&V1, &V2);
}
-inline ConstPoolBool *operator<(const ConstPoolVal &V1,
- const ConstPoolVal &V2) {
+// Logical Operators...
+inline Constant *operator&(const Constant &V1, const Constant &V2) {
assert(V1.getType() == V2.getType() && "Constant types must be identical!");
- return ConstRules::get(V1)->lessthan(&V1, &V2);
+ return ConstRules::get(V1, V2)->op_and(&V1, &V2);
+}
+
+inline Constant *operator|(const Constant &V1, const Constant &V2) {
+ assert(V1.getType() == V2.getType() && "Constant types must be identical!");
+ return ConstRules::get(V1, V2)->op_or(&V1, &V2);
+}
+
+inline Constant *operator^(const Constant &V1, const Constant &V2) {
+ assert(V1.getType() == V2.getType() && "Constant types must be identical!");
+ return ConstRules::get(V1, V2)->op_xor(&V1, &V2);
+}
+
+// Shift Instructions...
+inline Constant *operator<<(const Constant &V1, const Constant &V2) {
+ assert(V1.getType()->isInteger() && V2.getType() == Type::UByteTy);
+ return ConstRules::get(V1, V2)->shl(&V1, &V2);
+}
+
+inline Constant *operator>>(const Constant &V1, const Constant &V2) {
+ assert(V1.getType()->isInteger() && V2.getType() == Type::UByteTy);
+ return ConstRules::get(V1, V2)->shr(&V1, &V2);
+}
+
+inline ConstantBool *operator<(const Constant &V1,
+ const Constant &V2) {
+ assert(V1.getType() == V2.getType() && "Constant types must be identical!");
+ return ConstRules::get(V1, V2)->lessthan(&V1, &V2);
}
// Implement 'derived' operators based on what we already have...
//===----------------------------------------------------------------------===//
-inline ConstPoolBool *operator>(const ConstPoolVal &V1,
- const ConstPoolVal &V2) {
+inline ConstantBool *operator>(const Constant &V1,
+ const Constant &V2) {
return V2 < V1;
}
-inline ConstPoolBool *operator!=(const ConstPoolVal &V1,
- const ConstPoolVal &V2) {
- ConstPoolBool *Result = V1 == V2;
- Result->setValue(!Result->getValue()); // Invert value
- return Result; // !(V1 == V2)
+inline ConstantBool *operator>=(const Constant &V1,
+ const Constant &V2) {
+ if (ConstantBool *V = (V1 < V2))
+ return V->inverted(); // !(V1 < V2)
+ return 0;
}
-inline ConstPoolBool *operator>=(const ConstPoolVal &V1,
- const ConstPoolVal &V2) {
- ConstPoolBool *Result = V1 < V2;
- Result->setValue(!Result->getValue()); // Invert value
- return Result; // !(V1 < V2)
+inline ConstantBool *operator<=(const Constant &V1,
+ const Constant &V2) {
+ if (ConstantBool *V = (V1 > V2))
+ return V->inverted(); // !(V1 > V2)
+ return 0;
}
-inline ConstPoolBool *operator<=(const ConstPoolVal &V1,
- const ConstPoolVal &V2) {
- ConstPoolBool *Result = V1 > V2;
- Result->setValue(!Result->getValue()); // Invert value
- return Result; // !(V1 > V2)
-}
+
+//===----------------------------------------------------------------------===//
+// Implement higher level instruction folding type instructions
+//===----------------------------------------------------------------------===//
+
+// ConstantFoldInstruction - Attempt to constant fold the specified instruction.
+// If successful, the constant result is returned, if not, null is returned.
+//
+Constant *ConstantFoldInstruction(Instruction *I);
+
+// Constant fold various types of instruction...
+Constant *ConstantFoldCastInstruction(const Constant *V, const Type *DestTy);
+Constant *ConstantFoldBinaryInstruction(unsigned Opcode, const Constant *V1,
+ const Constant *V2);
+Constant *ConstantFoldShiftInstruction(unsigned Opcode, const Constant *V1,
+ const Constant *V2);
+Constant *ConstantFoldGetElementPtr(const Constant *C,
+ const std::vector<Constant*> &IdxList);
+
+} // End llvm namespace
#endif