1 //===-- llvm/Constants.h - Constant class subclass definitions --*- 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 for the subclasses of Constant, which
11 // represent the different type of constant pool values
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_CONSTANTS_H
16 #define LLVM_CONSTANTS_H
18 #include "llvm/Constant.h"
19 #include "Support/DataTypes.h"
27 template<class ConstantClass, class TypeClass, class ValType>
28 struct ConstantCreator;
29 template<class ConstantClass, class TypeClass>
30 struct ConvertConstantType;
33 //===---------------------------------------------------------------------------
34 /// ConstantIntegral - Shared superclass of boolean and integer constants.
36 /// This class just defines some common interfaces to be implemented.
38 class ConstantIntegral : public Constant {
40 ConstantIntegral(const Type *Ty) : Constant(Ty) {}
43 /// isNullValue - Return true if this is the value that would be returned by
46 virtual bool isNullValue() const = 0;
48 /// isMaxValue - Return true if this is the largest value that may be
49 /// represented by this type.
51 virtual bool isMaxValue() const = 0;
53 /// isMinValue - Return true if this is the smallest value that may be
54 /// represented by this type.
56 virtual bool isMinValue() const = 0;
58 /// isAllOnesValue - Return true if every bit in this constant is set to true.
60 virtual bool isAllOnesValue() const = 0;
62 /// Static constructor to get the maximum/minimum/allones constant of
63 /// specified (integral) type...
65 static ConstantIntegral *getMaxValue(const Type *Ty);
66 static ConstantIntegral *getMinValue(const Type *Ty);
67 static ConstantIntegral *getAllOnesValue(const Type *Ty);
69 /// Methods for support type inquiry through isa, cast, and dyn_cast:
70 static inline bool classof(const ConstantIntegral *) { return true; }
71 static bool classof(const Constant *CPV); // defined in Constants.cpp
72 static inline bool classof(const Value *V) {
73 return isa<Constant>(V) && classof(cast<Constant>(V));
78 //===---------------------------------------------------------------------------
79 /// ConstantBool - Boolean Values
81 class ConstantBool : public ConstantIntegral {
85 static ConstantBool *True, *False; // The True & False values
87 /// get() - Static factory methods - Return objects of the specified value
88 static ConstantBool *get(bool Value) { return Value ? True : False; }
89 static ConstantBool *get(const Type *Ty, bool Value) { return get(Value); }
91 /// inverted - Return the opposite value of the current value.
92 inline ConstantBool *inverted() const { return (this==True) ? False : True; }
94 /// getValue - return the boolean value of this constant.
96 inline bool getValue() const { return Val; }
98 /// isNullValue - Return true if this is the value that would be returned by
101 virtual bool isNullValue() const { return this == False; }
102 virtual bool isMaxValue() const { return this == True; }
103 virtual bool isMinValue() const { return this == False; }
104 virtual bool isAllOnesValue() const { return this == True; }
106 /// Methods for support type inquiry through isa, cast, and dyn_cast:
107 static inline bool classof(const ConstantBool *) { return true; }
108 static bool classof(const Constant *CPV) {
109 return (CPV == True) | (CPV == False);
111 static inline bool classof(const Value *V) {
112 return isa<Constant>(V) && classof(cast<Constant>(V));
117 //===---------------------------------------------------------------------------
118 /// ConstantInt - Superclass of ConstantSInt & ConstantUInt, to make dealing
119 /// with integral constants easier.
121 class ConstantInt : public ConstantIntegral {
127 ConstantInt(const ConstantInt &); // DO NOT IMPLEMENT
128 ConstantInt(const Type *Ty, uint64_t V);
130 /// equalsInt - Provide a helper method that can be used to determine if the
131 /// constant contained within is equal to a constant. This only works for
132 /// very small values, because this is all that can be represented with all
135 bool equalsInt(unsigned char V) const {
137 "equals: Can only be used with very small positive constants!");
138 return Val.Unsigned == V;
141 /// ConstantInt::get static method: return a ConstantInt with the specified
142 /// value. as above, we work only with very small values here.
144 static ConstantInt *get(const Type *Ty, unsigned char V);
146 /// getRawValue - return the underlying value of this constant as a 64-bit
147 /// unsigned integer value.
149 inline uint64_t getRawValue() const { return Val.Unsigned; }
151 /// isNullValue - Return true if this is the value that would be returned by
153 virtual bool isNullValue() const { return Val.Unsigned == 0; }
154 virtual bool isMaxValue() const = 0;
155 virtual bool isMinValue() const = 0;
157 /// Methods for support type inquiry through isa, cast, and dyn_cast:
158 static inline bool classof(const ConstantInt *) { return true; }
159 static bool classof(const Constant *CPV); // defined in Constants.cpp
160 static inline bool classof(const Value *V) {
161 return isa<Constant>(V) && classof(cast<Constant>(V));
166 //===---------------------------------------------------------------------------
167 /// ConstantSInt - Signed Integer Values [sbyte, short, int, long]
169 class ConstantSInt : public ConstantInt {
170 ConstantSInt(const ConstantSInt &); // DO NOT IMPLEMENT
171 friend struct ConstantCreator<ConstantSInt, Type, int64_t>;
174 ConstantSInt(const Type *Ty, int64_t V);
176 /// get() - Static factory methods - Return objects of the specified value
178 static ConstantSInt *get(const Type *Ty, int64_t V);
180 /// isValueValidForType - return true if Ty is big enough to represent V.
182 static bool isValueValidForType(const Type *Ty, int64_t V);
184 /// getValue - return the underlying value of this constant.
186 inline int64_t getValue() const { return Val.Signed; }
188 virtual bool isAllOnesValue() const { return getValue() == -1; }
190 /// isMaxValue - Return true if this is the largest value that may be
191 /// represented by this type.
193 virtual bool isMaxValue() const {
194 int64_t V = getValue();
195 if (V < 0) return false; // Be careful about wrap-around on 'long's
197 return !isValueValidForType(getType(), V) || V < 0;
200 /// isMinValue - Return true if this is the smallest value that may be
201 /// represented by this type.
203 virtual bool isMinValue() const {
204 int64_t V = getValue();
205 if (V > 0) return false; // Be careful about wrap-around on 'long's
207 return !isValueValidForType(getType(), V) || V > 0;
210 /// Methods for support type inquiry through isa, cast, and dyn_cast:
212 static inline bool classof(const ConstantSInt *) { return true; }
213 static bool classof(const Constant *CPV); // defined in Constants.cpp
214 static inline bool classof(const Value *V) {
215 return isa<Constant>(V) && classof(cast<Constant>(V));
219 //===---------------------------------------------------------------------------
220 /// ConstantUInt - Unsigned Integer Values [ubyte, ushort, uint, ulong]
222 class ConstantUInt : public ConstantInt {
223 ConstantUInt(const ConstantUInt &); // DO NOT IMPLEMENT
224 friend struct ConstantCreator<ConstantUInt, Type, uint64_t>;
226 ConstantUInt(const Type *Ty, uint64_t V);
228 /// get() - Static factory methods - Return objects of the specified value
230 static ConstantUInt *get(const Type *Ty, uint64_t V);
232 /// isValueValidForType - return true if Ty is big enough to represent V.
234 static bool isValueValidForType(const Type *Ty, uint64_t V);
236 /// getValue - return the underlying value of this constant.
238 inline uint64_t getValue() const { return Val.Unsigned; }
240 /// isMaxValue - Return true if this is the largest value that may be
241 /// represented by this type.
243 virtual bool isAllOnesValue() const;
244 virtual bool isMaxValue() const { return isAllOnesValue(); }
245 virtual bool isMinValue() const { return getValue() == 0; }
247 /// Methods for support type inquiry through isa, cast, and dyn_cast:
248 static inline bool classof(const ConstantUInt *) { return true; }
249 static bool classof(const Constant *CPV); // defined in Constants.cpp
250 static inline bool classof(const Value *V) {
251 return isa<Constant>(V) && classof(cast<Constant>(V));
256 //===---------------------------------------------------------------------------
257 /// ConstantFP - Floating Point Values [float, double]
259 class ConstantFP : public Constant {
261 friend struct ConstantCreator<ConstantFP, Type, uint64_t>;
262 friend struct ConstantCreator<ConstantFP, Type, uint32_t>;
263 ConstantFP(const ConstantFP &); // DO NOT IMPLEMENT
265 ConstantFP(const Type *Ty, double V);
267 /// get() - Static factory methods - Return objects of the specified value
268 static ConstantFP *get(const Type *Ty, double V);
270 /// isValueValidForType - return true if Ty is big enough to represent V.
271 static bool isValueValidForType(const Type *Ty, double V);
272 inline double getValue() const { return Val; }
274 /// isNullValue - Return true if this is the value that would be returned by
275 /// getNullValue. Don't depend on == for doubles to tell us it's zero, it
276 /// considers -0.0 to be null as well as 0.0. :(
277 virtual bool isNullValue() const {
286 /// isExactlyValue - We don't rely on operator== working on double values, as
287 /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
288 /// As such, this method can be used to do an exact bit-for-bit comparison of
289 /// two floating point values.
290 bool isExactlyValue(double V) const {
304 /// Methods for support type inquiry through isa, cast, and dyn_cast:
305 static inline bool classof(const ConstantFP *) { return true; }
306 static bool classof(const Constant *CPV); // defined in Constants.cpp
307 static inline bool classof(const Value *V) {
308 return isa<Constant>(V) && classof(cast<Constant>(V));
312 //===---------------------------------------------------------------------------
313 /// ConstantAggregateZero - All zero aggregate value
315 class ConstantAggregateZero : public Constant {
316 friend struct ConstantCreator<ConstantAggregateZero, Type, char>;
317 ConstantAggregateZero(const ConstantAggregateZero &); // DO NOT IMPLEMENT
319 ConstantAggregateZero(const Type *Ty) : Constant(Ty) {}
321 /// get() - static factory method for creating a null aggregate. It is
322 /// illegal to call this method with a non-aggregate type.
323 static Constant *get(const Type *Ty);
325 /// isNullValue - Return true if this is the value that would be returned by
327 virtual bool isNullValue() const { return true; }
329 virtual void destroyConstant();
330 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To,
331 bool DisableChecking = false);
333 /// Methods for support type inquiry through isa, cast, and dyn_cast:
335 static inline bool classof(const ConstantAggregateZero *) { return true; }
336 static bool classof(const Constant *CPV);
337 static inline bool classof(const Value *V) {
338 return isa<Constant>(V) && classof(cast<Constant>(V));
343 //===---------------------------------------------------------------------------
344 /// ConstantArray - Constant Array Declarations
346 class ConstantArray : public Constant {
347 friend struct ConstantCreator<ConstantArray, ArrayType,
348 std::vector<Constant*> >;
349 ConstantArray(const ConstantArray &); // DO NOT IMPLEMENT
351 ConstantArray(const ArrayType *T, const std::vector<Constant*> &Val);
353 /// get() - Static factory methods - Return objects of the specified value
354 static Constant *get(const ArrayType *T, const std::vector<Constant*> &);
355 static Constant *get(const std::string &Initializer);
357 /// getType - Specialize the getType() method to always return an ArrayType,
358 /// which reduces the amount of casting needed in parts of the compiler.
360 inline const ArrayType *getType() const {
361 return reinterpret_cast<const ArrayType*>(Value::getType());
364 /// isString - This method returns true if the array is an array of sbyte or
365 /// ubyte, and if the elements of the array are all ConstantInt's.
366 bool isString() const;
368 /// getAsString - If this array is isString(), then this method converts the
369 /// array to an std::string and returns it. Otherwise, it asserts out.
371 std::string getAsString() const;
373 /// getValues - Return a vector of the component constants that make up this
375 inline const std::vector<Use> &getValues() const { return Operands; }
377 /// isNullValue - Return true if this is the value that would be returned by
378 /// getNullValue. This always returns false because zero arrays are always
379 /// created as ConstantAggregateZero objects.
380 virtual bool isNullValue() const { return false; }
382 virtual void destroyConstant();
383 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To,
384 bool DisableChecking = false);
386 /// Methods for support type inquiry through isa, cast, and dyn_cast:
387 static inline bool classof(const ConstantArray *) { return true; }
388 static bool classof(const Constant *CPV); // defined in Constants.cpp
389 static inline bool classof(const Value *V) {
390 return isa<Constant>(V) && classof(cast<Constant>(V));
395 //===---------------------------------------------------------------------------
396 // ConstantStruct - Constant Struct Declarations
398 class ConstantStruct : public Constant {
399 friend struct ConstantCreator<ConstantStruct, StructType,
400 std::vector<Constant*> >;
401 ConstantStruct(const ConstantStruct &); // DO NOT IMPLEMENT
403 ConstantStruct(const StructType *T, const std::vector<Constant*> &Val);
405 /// get() - Static factory methods - Return objects of the specified value
406 static Constant *get(const StructType *T, const std::vector<Constant*> &V);
408 /// getType() specialization - Reduce amount of casting...
409 inline const StructType *getType() const {
410 return reinterpret_cast<const StructType*>(Value::getType());
413 /// getValues - Return a vector of the component constants that make up this
415 inline const std::vector<Use> &getValues() const { return Operands; }
417 /// isNullValue - Return true if this is the value that would be returned by
418 /// getNullValue. This always returns false because zero structs are always
419 /// created as ConstantAggregateZero objects.
420 virtual bool isNullValue() const {
424 virtual void destroyConstant();
425 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To,
426 bool DisableChecking = false);
428 /// Methods for support type inquiry through isa, cast, and dyn_cast:
429 static inline bool classof(const ConstantStruct *) { return true; }
430 static bool classof(const Constant *CPV); // defined in Constants.cpp
431 static inline bool classof(const Value *V) {
432 return isa<Constant>(V) && classof(cast<Constant>(V));
436 //===---------------------------------------------------------------------------
437 /// ConstantPointerNull - a constant pointer value that points to null
439 class ConstantPointerNull : public Constant {
440 friend struct ConstantCreator<ConstantPointerNull, PointerType, char>;
441 ConstantPointerNull(const ConstantPointerNull &); // DO NOT IMPLEMENT
443 ConstantPointerNull(const PointerType *T)
444 : Constant(reinterpret_cast<const Type*>(T)) {}
448 /// get() - Static factory methods - Return objects of the specified value
449 static ConstantPointerNull *get(const PointerType *T);
451 /// isNullValue - Return true if this is the value that would be returned by
453 virtual bool isNullValue() const { return true; }
455 virtual void destroyConstant();
457 /// Methods for support type inquiry through isa, cast, and dyn_cast:
458 static inline bool classof(const ConstantPointerNull *) { return true; }
459 static bool classof(const Constant *CPV);
460 static inline bool classof(const Value *V) {
461 return isa<Constant>(V) && classof(cast<Constant>(V));
466 //===---------------------------------------------------------------------------
467 /// ConstantPointerRef - a constant pointer value that is initialized to
468 /// point to a global value, which lies at a constant, fixed address.
470 class ConstantPointerRef : public Constant {
471 friend class Module; // Modules maintain these references
472 ConstantPointerRef(const ConstantPointerRef &); // DNI!
475 ConstantPointerRef(GlobalValue *GV);
477 /// get() - Static factory methods - Return objects of the specified value
478 static ConstantPointerRef *get(GlobalValue *GV);
480 const GlobalValue *getValue() const {
481 return cast<GlobalValue>(Operands[0].get());
484 GlobalValue *getValue() {
485 return cast<GlobalValue>(Operands[0].get());
488 /// isNullValue - Return true if this is the value that would be returned by
490 virtual bool isNullValue() const { return false; }
492 virtual void destroyConstant();
493 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To,
494 bool DisableChecking = false);
496 /// Methods for support type inquiry through isa, cast, and dyn_cast:
497 static inline bool classof(const ConstantPointerRef *) { return true; }
498 static bool classof(const Constant *CPV);
499 static inline bool classof(const Value *V) {
500 return isa<Constant>(V) && classof(cast<Constant>(V));
504 // ConstantExpr - a constant value that is initialized with an expression using
505 // other constant values. This is only used to represent values that cannot be
506 // evaluated at compile-time (e.g., something derived from an address) because
507 // it does not have a mechanism to store the actual value. Use the appropriate
508 // Constant subclass above for known constants.
510 class ConstantExpr : public Constant {
511 unsigned iType; // Operation type (an Instruction opcode)
512 friend struct ConstantCreator<ConstantExpr,Type,
513 std::pair<unsigned, std::vector<Constant*> > >;
514 friend struct ConvertConstantType<ConstantExpr, Type>;
517 // Cast creation ctor
518 ConstantExpr(unsigned Opcode, Constant *C, const Type *Ty);
519 // Binary/Shift instruction creation ctor
520 ConstantExpr(unsigned Opcode, Constant *C1, Constant *C2);
521 // Select instruction creation ctor
522 ConstantExpr(Constant *C, Constant *V1, Constant *V2);
523 // GEP instruction creation ctor
524 ConstantExpr(Constant *C, const std::vector<Constant*> &IdxList,
527 // These private methods are used by the type resolution code to create
528 // ConstantExprs in intermediate forms.
529 static Constant *getTy(const Type *Ty, unsigned Opcode,
530 Constant *C1, Constant *C2);
531 static Constant *getShiftTy(const Type *Ty,
532 unsigned Opcode, Constant *C1, Constant *C2);
533 static Constant *getSelectTy(const Type *Ty,
534 Constant *C1, Constant *C2, Constant *C3);
535 static Constant *getGetElementPtrTy(const Type *Ty, Constant *C,
536 const std::vector<Constant*> &IdxList);
539 // Static methods to construct a ConstantExpr of different kinds. Note that
540 // these methods may return a object that is not an instance of the
541 // ConstantExpr class, because they will attempt to fold the constant
542 // expression into something simpler if possible.
544 /// Cast constant expr
546 static Constant *getCast(Constant *C, const Type *Ty);
547 static Constant *getSignExtend(Constant *C, const Type *Ty);
548 static Constant *getZeroExtend(Constant *C, const Type *Ty);
550 /// Select constant expr
552 static Constant *getSelect(Constant *C, Constant *V1, Constant *V2) {
553 return getSelectTy(V1->getType(), C, V1, V2);
557 /// ConstantExpr::get - Return a binary or shift operator constant expression,
558 /// folding if possible.
560 static Constant *get(unsigned Opcode, Constant *C1, Constant *C2) {
561 return getTy(C1->getType(), Opcode, C1, C2);
564 /// ConstantExpr::get* - Return some common constants without having to
565 /// specify the full Instruction::OPCODE identifier.
567 static Constant *getNeg(Constant *C);
568 static Constant *getNot(Constant *C);
569 static Constant *getAdd(Constant *C1, Constant *C2);
570 static Constant *getSub(Constant *C1, Constant *C2);
571 static Constant *getMul(Constant *C1, Constant *C2);
572 static Constant *getDiv(Constant *C1, Constant *C2);
573 static Constant *getRem(Constant *C1, Constant *C2);
574 static Constant *getAnd(Constant *C1, Constant *C2);
575 static Constant *getOr(Constant *C1, Constant *C2);
576 static Constant *getXor(Constant *C1, Constant *C2);
577 static Constant *getSetEQ(Constant *C1, Constant *C2);
578 static Constant *getSetNE(Constant *C1, Constant *C2);
579 static Constant *getSetLT(Constant *C1, Constant *C2);
580 static Constant *getSetGT(Constant *C1, Constant *C2);
581 static Constant *getSetLE(Constant *C1, Constant *C2);
582 static Constant *getSetGE(Constant *C1, Constant *C2);
583 static Constant *getShl(Constant *C1, Constant *C2);
584 static Constant *getShr(Constant *C1, Constant *C2);
586 static Constant *getUShr(Constant *C1, Constant *C2); // unsigned shr
587 static Constant *getSShr(Constant *C1, Constant *C2); // signed shr
589 /// Getelementptr form...
591 static Constant *getGetElementPtr(Constant *C,
592 const std::vector<Constant*> &IdxList);
594 /// isNullValue - Return true if this is the value that would be returned by
596 virtual bool isNullValue() const { return false; }
598 /// getOpcode - Return the opcode at the root of this constant expression
599 unsigned getOpcode() const { return iType; }
601 /// getOpcodeName - Return a string representation for an opcode.
602 const char *getOpcodeName() const;
604 /// isConstantExpr - Return true if this is a ConstantExpr
605 virtual bool isConstantExpr() const { return true; }
607 virtual void destroyConstant();
608 virtual void replaceUsesOfWithOnConstant(Value *From, Value *To,
609 bool DisableChecking = false);
611 /// Override methods to provide more type information...
612 inline Constant *getOperand(unsigned i) {
613 return cast<Constant>(User::getOperand(i));
615 inline Constant *getOperand(unsigned i) const {
616 return const_cast<Constant*>(cast<Constant>(User::getOperand(i)));
620 /// Methods for support type inquiry through isa, cast, and dyn_cast:
621 static inline bool classof(const ConstantExpr *) { return true; }
622 static inline bool classof(const Constant *CPV) {
623 return CPV->isConstantExpr();
625 static inline bool classof(const Value *V) {
626 return isa<Constant>(V) && classof(cast<Constant>(V));
630 } // End llvm namespace