include/llvm/Constants.h

   1 //===-- llvm/Constants.h - Constant class subclass definitions --*- C++ -*-===//
   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 //===----------------------------------------------------------------------===//
   9 //
  10 /// @file This file contains the declarations for the subclasses of Constant,
  11 /// which represent the different flavors of constant values that live in LLVM.
  12 /// Note that Constants are immutable (once created they never change) and are
  13 /// fully shared by structural equivalence.  This means that two structurally
  14 /// equivalent constants will always have the same address.  Constant's are
  15 /// created on demand as needed and never deleted: thus clients don't have to
  16 /// worry about the lifetime of the objects.
  17 //
  18 //===----------------------------------------------------------------------===//
  19
  20 #ifndef LLVM_CONSTANTS_H
  21 #define LLVM_CONSTANTS_H
  22
  23 #include "llvm/Constant.h"
  24 #include "llvm/Type.h"
  25 #include "llvm/ADT/APInt.h"
  26
  27 namespace llvm {
  28
  29 class ArrayType;
  30 class StructType;
  31 class PointerType;
  32 class VectorType;
  33
  34 template<class ConstantClass, class TypeClass, class ValType>
  35 struct ConstantCreator;
  36 template<class ConstantClass, class TypeClass>
  37 struct ConvertConstantType;
  38
  39 //===----------------------------------------------------------------------===//
  40 /// This is the shared class of boolean and integer constants. This class
  41 /// represents both boolean and integral constants.
  42 /// @brief Class for constant integers.
  43 class ConstantInt : public Constant {
  44   static ConstantInt *TheTrueVal, *TheFalseVal;
  45   ConstantInt(const ConstantInt &);      // DO NOT IMPLEMENT
  46   ConstantInt(const IntegerType *Ty, const APInt& V);
  47   APInt Val;
  48 public:
  49   /// Return the constant as an APInt value reference. This allows clients to
  50   /// obtain a copy of the value, with all its precision in tact.
  51   /// @brief Return the constant's value.
  52   inline const APInt& getValue() const {
  53     return Val;
  54   }
  55
  56   /// getBitWidth - Return the bitwidth of this constant.
  57   unsigned getBitWidth() const { return Val.getBitWidth(); }
  58
  59   /// Return the constant as a 64-bit unsigned integer value after it
  60   /// has been zero extended as appropriate for the type of this constant. Note
  61   /// that this method can assert if the value does not fit in 64 bits.
  62   /// @deprecated
  63   /// @brief Return the zero extended value.
  64   inline uint64_t getZExtValue() const {
  65     return Val.getZExtValue();
  66   }
  67
  68   /// Return the constant as a 64-bit integer value after it has been sign
  69   /// sign extended as appropriate for the type of this constant. Note that
  70   /// this method can assert if the value does not fit in 64 bits.
  71   /// @deprecated
  72   /// @brief Return the sign extended value.
  73   inline int64_t getSExtValue() const {
  74     return Val.getSExtValue();
  75   }
  76
  77   /// A helper method that can be used to determine if the constant contained
  78   /// within is equal to a constant.  This only works for very small values,
  79   /// because this is all that can be represented with all types.
  80   /// @brief Determine if this constant's value is same as an unsigned char.
  81   bool equalsInt(uint64_t V) const {
  82     return Val == V;
  83   }
  84
  85   /// getTrue/getFalse - Return the singleton true/false values.
  86   static inline ConstantInt *getTrue() {
  87     if (TheTrueVal) return TheTrueVal;
  88     return CreateTrueFalseVals(true);
  89   }
  90   static inline ConstantInt *getFalse() {
  91     if (TheFalseVal) return TheFalseVal;
  92     return CreateTrueFalseVals(false);
  93   }
  94
  95   /// Return a ConstantInt with the specified value for the specified type. The
  96   /// value V will be canonicalized to a an unsigned APInt. Accessing it with
  97   /// either getSExtValue() or getZExtValue() will yield a correctly sized and
  98   /// signed value for the type Ty.
  99   /// @brief Get a ConstantInt for a specific value.
 100   static ConstantInt *get(const Type *Ty, uint64_t V, bool isSigned = false);
 101
 102   /// Return a ConstantInt with the specified value and an implied Type. The
 103   /// type is the integer type that corresponds to the bit width of the value.
 104   static ConstantInt *get(const APInt &V);
 105
 106   /// getType - Specialize the getType() method to always return an IntegerType,
 107   /// which reduces the amount of casting needed in parts of the compiler.
 108   ///
 109   inline const IntegerType *getType() const {
 110     return reinterpret_cast<const IntegerType*>(Value::getType());
 111   }
 112
 113   /// This static method returns true if the type Ty is big enough to
 114   /// represent the value V. This can be used to avoid having the get method
 115   /// assert when V is larger than Ty can represent. Note that there are two
 116   /// versions of this method, one for unsigned and one for signed integers.
 117   /// Although ConstantInt canonicalizes everything to an unsigned integer,
 118   /// the signed version avoids callers having to convert a signed quantity
 119   /// to the appropriate unsigned type before calling the method.
 120   /// @returns true if V is a valid value for type Ty
 121   /// @brief Determine if the value is in range for the given type.
 122   static bool isValueValidForType(const Type *Ty, uint64_t V);
 123   static bool isValueValidForType(const Type *Ty, int64_t V);
 124
 125   /// This function will return true iff this constant represents the "null"
 126   /// value that would be returned by the getNullValue method.
 127   /// @returns true if this is the null integer value.
 128   /// @brief Determine if the value is null.
 129   virtual bool isNullValue() const {
 130     return Val == 0;
 131   }
 132
 133   /// This is just a convenience method to make client code smaller for a
 134   /// common code. It also correctly performs the comparison without the
 135   /// potential for an assertion from getZExtValue().
 136   bool isZero() const {
 137     return Val == 0;
 138   }
 139
 140   /// This is just a convenience method to make client code smaller for a
 141   /// common case. It also correctly performs the comparison without the
 142   /// potential for an assertion from getZExtValue().
 143   /// @brief Determine if the value is one.
 144   bool isOne() const {
 145     return Val == 1;
 146   }
 147
 148   /// This function will return true iff every bit in this constant is set
 149   /// to true.
 150   /// @returns true iff this constant's bits are all set to true.
 151   /// @brief Determine if the value is all ones.
 152   bool isAllOnesValue() const {
 153     return Val.isAllOnesValue();
 154   }
 155
 156   /// This function will return true iff this constant represents the largest
 157   /// value that may be represented by the constant's type.
 158   /// @returns true iff this is the largest value that may be represented
 159   /// by this type.
 160   /// @brief Determine if the value is maximal.
 161   bool isMaxValue(bool isSigned) const {
 162     if (isSigned)
 163       return Val.isMaxSignedValue();
 164     else
 165       return Val.isMaxValue();
 166   }
 167
 168   /// This function will return true iff this constant represents the smallest
 169   /// value that may be represented by this constant's type.
 170   /// @returns true if this is the smallest value that may be represented by
 171   /// this type.
 172   /// @brief Determine if the value is minimal.
 173   bool isMinValue(bool isSigned) const {
 174     if (isSigned)
 175       return Val.isMinSignedValue();
 176     else
 177       return Val.isMinValue();
 178   }
 179
 180   /// This function will return true iff this constant represents a value with
 181   /// active bits bigger than 64 bits or a value greater than the given uint64_t
 182   /// value.
 183   /// @returns true iff this constant is greater or equal to the given number.
 184   /// @brief Determine if the value is greater or equal to the given number.
 185   bool uge(uint64_t Num) {
 186     return Val.getActiveBits() > 64 || Val.getZExtValue() >= Num;
 187   }
 188
 189   /// @returns the 64-bit value of this constant if its active bits number is
 190   /// not greater than 64, otherwise, just return the given uint64_t number.
 191   /// @brief Get the constant's value if possible.
 192   uint64_t getLimitedValue(uint64_t Limit = ~0ULL) const {
 193     return Val.getLimitedValue(Limit);
 194   }
 195
 196   /// @returns the value for an integer constant of the given type that has all
 197   /// its bits set to true.
 198   /// @brief Get the all ones value
 199   static ConstantInt *getAllOnesValue(const Type *Ty);
 200
 201   /// @brief Methods to support type inquiry through isa, cast, and dyn_cast.
 202   static inline bool classof(const ConstantInt *) { return true; }
 203   static bool classof(const Value *V) {
 204     return V->getValueID() == ConstantIntVal;
 205   }
 206   static void ResetTrueFalse() { TheTrueVal = TheFalseVal = 0; }
 207 private:
 208   static ConstantInt *CreateTrueFalseVals(bool WhichOne);
 209 };
 210
 211
 212 //===----------------------------------------------------------------------===//
 213 /// ConstantFP - Floating Point Values [float, double]
 214 ///
 215 class ConstantFP : public Constant {
 216   double Val;
 217   ConstantFP(const ConstantFP &);      // DO NOT IMPLEMENT
 218 protected:
 219   ConstantFP(const Type *Ty, double V);
 220 public:
 221   /// get() - Static factory methods - Return objects of the specified value
 222   static ConstantFP *get(const Type *Ty, double V);
 223
 224   /// isValueValidForType - return true if Ty is big enough to represent V.
 225   static bool isValueValidForType(const Type *Ty, double V);
 226   inline double getValue() const { return Val; }
 227
 228   /// isNullValue - Return true if this is the value that would be returned by
 229   /// getNullValue.  Don't depend on == for doubles to tell us it's zero, it
 230   /// considers -0.0 to be null as well as 0.0.  :(
 231   virtual bool isNullValue() const;
 232
 233   /// isExactlyValue - We don't rely on operator== working on double values, as
 234   /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
 235   /// As such, this method can be used to do an exact bit-for-bit comparison of
 236   /// two floating point values.
 237   bool isExactlyValue(double V) const;
 238
 239   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 240   static inline bool classof(const ConstantFP *) { return true; }
 241   static bool classof(const Value *V) {
 242     return V->getValueID() == ConstantFPVal;
 243   }
 244 };
 245
 246 //===----------------------------------------------------------------------===//
 247 /// ConstantAggregateZero - All zero aggregate value
 248 ///
 249 class ConstantAggregateZero : public Constant {
 250   friend struct ConstantCreator<ConstantAggregateZero, Type, char>;
 251   ConstantAggregateZero(const ConstantAggregateZero &);      // DO NOT IMPLEMENT
 252 protected:
 253   explicit ConstantAggregateZero(const Type *Ty)
 254     : Constant(Ty, ConstantAggregateZeroVal, 0, 0) {}
 255 public:
 256   /// get() - static factory method for creating a null aggregate.  It is
 257   /// illegal to call this method with a non-aggregate type.
 258   static Constant *get(const Type *Ty);
 259
 260   /// isNullValue - Return true if this is the value that would be returned by
 261   /// getNullValue.
 262   virtual bool isNullValue() const { return true; }
 263
 264   virtual void destroyConstant();
 265
 266   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 267   ///
 268   static bool classof(const ConstantAggregateZero *) { return true; }
 269   static bool classof(const Value *V) {
 270     return V->getValueID() == ConstantAggregateZeroVal;
 271   }
 272 };
 273
 274
 275 //===----------------------------------------------------------------------===//
 276 /// ConstantArray - Constant Array Declarations
 277 ///
 278 class ConstantArray : public Constant {
 279   friend struct ConstantCreator<ConstantArray, ArrayType,
 280                                     std::vector<Constant*> >;
 281   ConstantArray(const ConstantArray &);      // DO NOT IMPLEMENT
 282 protected:
 283   ConstantArray(const ArrayType *T, const std::vector<Constant*> &Val);
 284   ~ConstantArray();
 285 public:
 286   /// get() - Static factory methods - Return objects of the specified value
 287   static Constant *get(const ArrayType *T, const std::vector<Constant*> &);
 288   static Constant *get(const ArrayType *T,
 289                        Constant*const*Vals, unsigned NumVals) {
 290     // FIXME: make this the primary ctor method.
 291     return get(T, std::vector<Constant*>(Vals, Vals+NumVals));
 292   }
 293
 294   /// This method constructs a ConstantArray and initializes it with a text
 295   /// string. The default behavior (AddNull==true) causes a null terminator to
 296   /// be placed at the end of the array. This effectively increases the length
 297   /// of the array by one (you've been warned).  However, in some situations
 298   /// this is not desired so if AddNull==false then the string is copied without
 299   /// null termination.
 300   static Constant *get(const std::string &Initializer, bool AddNull = true);
 301
 302   /// getType - Specialize the getType() method to always return an ArrayType,
 303   /// which reduces the amount of casting needed in parts of the compiler.
 304   ///
 305   inline const ArrayType *getType() const {
 306     return reinterpret_cast<const ArrayType*>(Value::getType());
 307   }
 308
 309   /// isString - This method returns true if the array is an array of sbyte or
 310   /// ubyte, and if the elements of the array are all ConstantInt's.
 311   bool isString() const;
 312
 313   /// isCString - This method returns true if the array is a string (see
 314   /// @verbatim
 315   /// isString) and it ends in a null byte \0 and does not contains any other
 316   /// @endverbatim
 317   /// null bytes except its terminator.
 318   bool isCString() const;
 319
 320   /// getAsString - If this array is isString(), then this method converts the
 321   /// array to an std::string and returns it.  Otherwise, it asserts out.
 322   ///
 323   std::string getAsString() const;
 324
 325   /// isNullValue - Return true if this is the value that would be returned by
 326   /// getNullValue.  This always returns false because zero arrays are always
 327   /// created as ConstantAggregateZero objects.
 328   virtual bool isNullValue() const { return false; }
 329
 330   virtual void destroyConstant();
 331   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
 332
 333   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 334   static inline bool classof(const ConstantArray *) { return true; }
 335   static bool classof(const Value *V) {
 336     return V->getValueID() == ConstantArrayVal;
 337   }
 338 };
 339
 340
 341 //===----------------------------------------------------------------------===//
 342 // ConstantStruct - Constant Struct Declarations
 343 //
 344 class ConstantStruct : public Constant {
 345   friend struct ConstantCreator<ConstantStruct, StructType,
 346                                     std::vector<Constant*> >;
 347   ConstantStruct(const ConstantStruct &);      // DO NOT IMPLEMENT
 348 protected:
 349   ConstantStruct(const StructType *T, const std::vector<Constant*> &Val);
 350   ~ConstantStruct();
 351 public:
 352   /// get() - Static factory methods - Return objects of the specified value
 353   ///
 354   static Constant *get(const StructType *T, const std::vector<Constant*> &V);
 355   static Constant *get(const std::vector<Constant*> &V, bool Packed = false);
 356   static Constant *get(Constant*const* Vals, unsigned NumVals,
 357                        bool Packed = false) {
 358     // FIXME: make this the primary ctor method.
 359     return get(std::vector<Constant*>(Vals, Vals+NumVals), Packed);
 360   }
 361
 362   /// getType() specialization - Reduce amount of casting...
 363   ///
 364   inline const StructType *getType() const {
 365     return reinterpret_cast<const StructType*>(Value::getType());
 366   }
 367
 368   /// isNullValue - Return true if this is the value that would be returned by
 369   /// getNullValue.  This always returns false because zero structs are always
 370   /// created as ConstantAggregateZero objects.
 371   virtual bool isNullValue() const {
 372     return false;
 373   }
 374
 375   virtual void destroyConstant();
 376   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
 377
 378   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 379   static inline bool classof(const ConstantStruct *) { return true; }
 380   static bool classof(const Value *V) {
 381     return V->getValueID() == ConstantStructVal;
 382   }
 383 };
 384
 385 //===----------------------------------------------------------------------===//
 386 /// ConstantVector - Constant Vector Declarations
 387 ///
 388 class ConstantVector : public Constant {
 389   friend struct ConstantCreator<ConstantVector, VectorType,
 390                                     std::vector<Constant*> >;
 391   ConstantVector(const ConstantVector &);      // DO NOT IMPLEMENT
 392 protected:
 393   ConstantVector(const VectorType *T, const std::vector<Constant*> &Val);
 394   ~ConstantVector();
 395 public:
 396   /// get() - Static factory methods - Return objects of the specified value
 397   static Constant *get(const VectorType *T, const std::vector<Constant*> &);
 398   static Constant *get(const std::vector<Constant*> &V);
 399   static Constant *get(Constant*const* Vals, unsigned NumVals) {
 400     // FIXME: make this the primary ctor method.
 401     return get(std::vector<Constant*>(Vals, Vals+NumVals));
 402   }
 403
 404   /// getType - Specialize the getType() method to always return a VectorType,
 405   /// which reduces the amount of casting needed in parts of the compiler.
 406   ///
 407   inline const VectorType *getType() const {
 408     return reinterpret_cast<const VectorType*>(Value::getType());
 409   }
 410
 411   /// @returns the value for a vector integer constant of the given type that
 412   /// has all its bits set to true.
 413   /// @brief Get the all ones value
 414   static ConstantVector *getAllOnesValue(const VectorType *Ty);
 415
 416   /// isNullValue - Return true if this is the value that would be returned by
 417   /// getNullValue.  This always returns false because zero vectors are always
 418   /// created as ConstantAggregateZero objects.
 419   virtual bool isNullValue() const { return false; }
 420
 421   /// This function will return true iff every element in this vector constant
 422   /// is set to all ones.
 423   /// @returns true iff this constant's emements are all set to all ones.
 424   /// @brief Determine if the value is all ones.
 425   bool isAllOnesValue() const;
 426
 427   virtual void destroyConstant();
 428   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
 429
 430   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 431   static inline bool classof(const ConstantVector *) { return true; }
 432   static bool classof(const Value *V) {
 433     return V->getValueID() == ConstantVectorVal;
 434   }
 435 };
 436
 437 //===----------------------------------------------------------------------===//
 438 /// ConstantPointerNull - a constant pointer value that points to null
 439 ///
 440 class ConstantPointerNull : public Constant {
 441   friend struct ConstantCreator<ConstantPointerNull, PointerType, char>;
 442   ConstantPointerNull(const ConstantPointerNull &);      // DO NOT IMPLEMENT
 443 protected:
 444   explicit ConstantPointerNull(const PointerType *T)
 445     : Constant(reinterpret_cast<const Type*>(T),
 446                Value::ConstantPointerNullVal, 0, 0) {}
 447
 448 public:
 449
 450   /// get() - Static factory methods - Return objects of the specified value
 451   static ConstantPointerNull *get(const PointerType *T);
 452
 453   /// isNullValue - Return true if this is the value that would be returned by
 454   /// getNullValue.
 455   virtual bool isNullValue() const { return true; }
 456
 457   virtual void destroyConstant();
 458
 459   /// getType - Specialize the getType() method to always return an PointerType,
 460   /// which reduces the amount of casting needed in parts of the compiler.
 461   ///
 462   inline const PointerType *getType() const {
 463     return reinterpret_cast<const PointerType*>(Value::getType());
 464   }
 465
 466   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 467   static inline bool classof(const ConstantPointerNull *) { return true; }
 468   static bool classof(const Value *V) {
 469     return V->getValueID() == ConstantPointerNullVal;
 470   }
 471 };
 472
 473
 474 /// ConstantExpr - a constant value that is initialized with an expression using
 475 /// other constant values.
 476 ///
 477 /// This class uses the standard Instruction opcodes to define the various
 478 /// constant expressions.  The Opcode field for the ConstantExpr class is
 479 /// maintained in the Value::SubclassData field.
 480 class ConstantExpr : public Constant {
 481   friend struct ConstantCreator<ConstantExpr,Type,
 482                             std::pair<unsigned, std::vector<Constant*> > >;
 483   friend struct ConvertConstantType<ConstantExpr, Type>;
 484
 485 protected:
 486   ConstantExpr(const Type *Ty, unsigned Opcode, Use *Ops, unsigned NumOps)
 487     : Constant(Ty, ConstantExprVal, Ops, NumOps) {
 488     // Operation type (an Instruction opcode) is stored as the SubclassData.
 489     SubclassData = Opcode;
 490   }
 491
 492   // These private methods are used by the type resolution code to create
 493   // ConstantExprs in intermediate forms.
 494   static Constant *getTy(const Type *Ty, unsigned Opcode,
 495                          Constant *C1, Constant *C2);
 496   static Constant *getCompareTy(unsigned short pred, Constant *C1,
 497                                 Constant *C2);
 498   static Constant *getSelectTy(const Type *Ty,
 499                                Constant *C1, Constant *C2, Constant *C3);
 500   static Constant *getGetElementPtrTy(const Type *Ty, Constant *C,
 501                                       Value* const *Idxs, unsigned NumIdxs);
 502   static Constant *getExtractElementTy(const Type *Ty, Constant *Val,
 503                                        Constant *Idx);
 504   static Constant *getInsertElementTy(const Type *Ty, Constant *Val,
 505                                       Constant *Elt, Constant *Idx);
 506   static Constant *getShuffleVectorTy(const Type *Ty, Constant *V1,
 507                                       Constant *V2, Constant *Mask);
 508
 509 public:
 510   // Static methods to construct a ConstantExpr of different kinds.  Note that
 511   // these methods may return a object that is not an instance of the
 512   // ConstantExpr class, because they will attempt to fold the constant
 513   // expression into something simpler if possible.
 514
 515   /// Cast constant expr
 516   ///
 517   static Constant *getTrunc   (Constant *C, const Type *Ty);
 518   static Constant *getSExt    (Constant *C, const Type *Ty);
 519   static Constant *getZExt    (Constant *C, const Type *Ty);
 520   static Constant *getFPTrunc (Constant *C, const Type *Ty);
 521   static Constant *getFPExtend(Constant *C, const Type *Ty);
 522   static Constant *getUIToFP  (Constant *C, const Type *Ty);
 523   static Constant *getSIToFP  (Constant *C, const Type *Ty);
 524   static Constant *getFPToUI  (Constant *C, const Type *Ty);
 525   static Constant *getFPToSI  (Constant *C, const Type *Ty);
 526   static Constant *getPtrToInt(Constant *C, const Type *Ty);
 527   static Constant *getIntToPtr(Constant *C, const Type *Ty);
 528   static Constant *getBitCast (Constant *C, const Type *Ty);
 529
 530   // @brief Convenience function for getting one of the casting operations
 531   // using a CastOps opcode.
 532   static Constant *getCast(
 533     unsigned ops,  ///< The opcode for the conversion
 534     Constant *C,   ///< The constant to be converted
 535     const Type *Ty ///< The type to which the constant is converted
 536   );
 537
 538   // @brief Create a ZExt or BitCast cast constant expression
 539   static Constant *getZExtOrBitCast(
 540     Constant *C,   ///< The constant to zext or bitcast
 541     const Type *Ty ///< The type to zext or bitcast C to
 542   );
 543
 544   // @brief Create a SExt or BitCast cast constant expression
 545   static Constant *getSExtOrBitCast(
 546     Constant *C,   ///< The constant to sext or bitcast
 547     const Type *Ty ///< The type to sext or bitcast C to
 548   );
 549
 550   // @brief Create a Trunc or BitCast cast constant expression
 551   static Constant *getTruncOrBitCast(
 552     Constant *C,   ///< The constant to trunc or bitcast
 553     const Type *Ty ///< The type to trunc or bitcast C to
 554   );
 555
 556   /// @brief Create a BitCast or a PtrToInt cast constant expression
 557   static Constant *getPointerCast(
 558     Constant *C,   ///< The pointer value to be casted (operand 0)
 559     const Type *Ty ///< The type to which cast should be made
 560   );
 561
 562   /// @brief Create a ZExt, Bitcast or Trunc for integer -> integer casts
 563   static Constant *getIntegerCast(
 564     Constant *C,    ///< The integer constant to be casted
 565     const Type *Ty, ///< The integer type to cast to
 566     bool isSigned   ///< Whether C should be treated as signed or not
 567   );
 568
 569   /// @brief Create a FPExt, Bitcast or FPTrunc for fp -> fp casts
 570   static Constant *getFPCast(
 571     Constant *C,    ///< The integer constant to be casted
 572     const Type *Ty ///< The integer type to cast to
 573   );
 574
 575   /// @brief Return true if this is a convert constant expression
 576   bool isCast() const;
 577
 578   /// @brief Return true if this is a compare constant expression
 579   bool isCompare() const;
 580
 581   /// Select constant expr
 582   ///
 583   static Constant *getSelect(Constant *C, Constant *V1, Constant *V2) {
 584     return getSelectTy(V1->getType(), C, V1, V2);
 585   }
 586
 587   /// getSizeOf constant expr - computes the size of a type in a target
 588   /// independent way (Note: the return type is a ULong).
 589   ///
 590   static Constant *getSizeOf(const Type *Ty);
 591
 592   /// ConstantExpr::get - Return a binary or shift operator constant expression,
 593   /// folding if possible.
 594   ///
 595   static Constant *get(unsigned Opcode, Constant *C1, Constant *C2);
 596
 597   /// @brief Return an ICmp or FCmp comparison operator constant expression.
 598   static Constant *getCompare(unsigned short pred, Constant *C1, Constant *C2);
 599
 600   /// ConstantExpr::get* - Return some common constants without having to
 601   /// specify the full Instruction::OPCODE identifier.
 602   ///
 603   static Constant *getNeg(Constant *C);
 604   static Constant *getNot(Constant *C);
 605   static Constant *getAdd(Constant *C1, Constant *C2);
 606   static Constant *getSub(Constant *C1, Constant *C2);
 607   static Constant *getMul(Constant *C1, Constant *C2);
 608   static Constant *getUDiv(Constant *C1, Constant *C2);
 609   static Constant *getSDiv(Constant *C1, Constant *C2);
 610   static Constant *getFDiv(Constant *C1, Constant *C2);
 611   static Constant *getURem(Constant *C1, Constant *C2); // unsigned rem
 612   static Constant *getSRem(Constant *C1, Constant *C2); // signed rem
 613   static Constant *getFRem(Constant *C1, Constant *C2);
 614   static Constant *getAnd(Constant *C1, Constant *C2);
 615   static Constant *getOr(Constant *C1, Constant *C2);
 616   static Constant *getXor(Constant *C1, Constant *C2);
 617   static Constant* getICmp(unsigned short pred, Constant* LHS, Constant* RHS);
 618   static Constant* getFCmp(unsigned short pred, Constant* LHS, Constant* RHS);
 619   static Constant *getShl(Constant *C1, Constant *C2);
 620   static Constant *getLShr(Constant *C1, Constant *C2);
 621   static Constant *getAShr(Constant *C1, Constant *C2);
 622
 623   /// Getelementptr form.  std::vector<Value*> is only accepted for convenience:
 624   /// all elements must be Constant's.
 625   ///
 626   static Constant *getGetElementPtr(Constant *C,
 627                                     Constant* const *IdxList, unsigned NumIdx);
 628   static Constant *getGetElementPtr(Constant *C,
 629                                     Value* const *IdxList, unsigned NumIdx);
 630
 631   static Constant *getExtractElement(Constant *Vec, Constant *Idx);
 632   static Constant *getInsertElement(Constant *Vec, Constant *Elt,Constant *Idx);
 633   static Constant *getShuffleVector(Constant *V1, Constant *V2, Constant *Mask);
 634
 635   /// Floating point negation must be implemented with f(x) = -0.0 - x. This
 636   /// method returns the negative zero constant for floating point or vector
 637   /// floating point types; for all other types, it returns the null value.
 638   static Constant *getZeroValueForNegationExpr(const Type *Ty);
 639
 640   /// isNullValue - Return true if this is the value that would be returned by
 641   /// getNullValue.
 642   virtual bool isNullValue() const { return false; }
 643
 644   /// getOpcode - Return the opcode at the root of this constant expression
 645   unsigned getOpcode() const { return SubclassData; }
 646
 647   /// getPredicate - Return the ICMP or FCMP predicate value. Assert if this is
 648   /// not an ICMP or FCMP constant expression.
 649   unsigned getPredicate() const;
 650
 651   /// getOpcodeName - Return a string representation for an opcode.
 652   const char *getOpcodeName() const;
 653
 654   /// getWithOperandReplaced - Return a constant expression identical to this
 655   /// one, but with the specified operand set to the specified value.
 656   Constant *getWithOperandReplaced(unsigned OpNo, Constant *Op) const;
 657
 658   /// getWithOperands - This returns the current constant expression with the
 659   /// operands replaced with the specified values.  The specified operands must
 660   /// match count and type with the existing ones.
 661   Constant *getWithOperands(const std::vector<Constant*> &Ops) const;
 662
 663   virtual void destroyConstant();
 664   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
 665
 666   /// Override methods to provide more type information...
 667   inline Constant *getOperand(unsigned i) {
 668     return cast<Constant>(User::getOperand(i));
 669   }
 670   inline Constant *getOperand(unsigned i) const {
 671     return const_cast<Constant*>(cast<Constant>(User::getOperand(i)));
 672   }
 673
 674
 675   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 676   static inline bool classof(const ConstantExpr *) { return true; }
 677   static inline bool classof(const Value *V) {
 678     return V->getValueID() == ConstantExprVal;
 679   }
 680 };
 681
 682
 683 //===----------------------------------------------------------------------===//
 684 /// UndefValue - 'undef' values are things that do not have specified contents.
 685 /// These are used for a variety of purposes, including global variable
 686 /// initializers and operands to instructions.  'undef' values can occur with
 687 /// any type.
 688 ///
 689 class UndefValue : public Constant {
 690   friend struct ConstantCreator<UndefValue, Type, char>;
 691   UndefValue(const UndefValue &);      // DO NOT IMPLEMENT
 692 protected:
 693   explicit UndefValue(const Type *T) : Constant(T, UndefValueVal, 0, 0) {}
 694 public:
 695   /// get() - Static factory methods - Return an 'undef' object of the specified
 696   /// type.
 697   ///
 698   static UndefValue *get(const Type *T);
 699
 700   /// isNullValue - Return true if this is the value that would be returned by
 701   /// getNullValue.
 702   virtual bool isNullValue() const { return false; }
 703
 704   virtual void destroyConstant();
 705
 706   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 707   static inline bool classof(const UndefValue *) { return true; }
 708   static bool classof(const Value *V) {
 709     return V->getValueID() == UndefValueVal;
 710   }
 711 };
 712
 713 } // End llvm namespace
 714
 715 #endif