include/llvm/Constants.h

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