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 constants.
 255   bool isExactlyValue(const APFloat& V) const;
 256
 257   bool isExactlyValue(double V) const {
 258     if (&Val.getSemantics() == &APFloat::IEEEdouble)
 259       return isExactlyValue(APFloat(V));
 260     else if (&Val.getSemantics() == &APFloat::IEEEsingle)
 261       return isExactlyValue(APFloat((float)V));
 262     assert(0);
 263     return false;
 264   }
 265   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 266   static inline bool classof(const ConstantFP *) { return true; }
 267   static bool classof(const Value *V) {
 268     return V->getValueID() == ConstantFPVal;
 269   }
 270 };
 271
 272 //===----------------------------------------------------------------------===//
 273 /// ConstantAggregateZero - All zero aggregate value
 274 ///
 275 class ConstantAggregateZero : public Constant {
 276   friend struct ConstantCreator<ConstantAggregateZero, Type, char>;
 277   void *operator new(size_t, unsigned);                      // DO NOT IMPLEMENT
 278   ConstantAggregateZero(const ConstantAggregateZero &);      // DO NOT IMPLEMENT
 279 protected:
 280   explicit ConstantAggregateZero(const Type *Ty)
 281     : Constant(Ty, ConstantAggregateZeroVal, 0, 0) {}
 282 protected:
 283   // allocate space for exactly zero operands
 284   void *operator new(size_t s) {
 285     return User::operator new(s, 0);
 286   }
 287 public:
 288   /// get() - static factory method for creating a null aggregate.  It is
 289   /// illegal to call this method with a non-aggregate type.
 290   static Constant *get(const Type *Ty);
 291
 292   /// isNullValue - Return true if this is the value that would be returned by
 293   /// getNullValue.
 294   virtual bool isNullValue() const { return true; }
 295
 296   virtual void destroyConstant();
 297
 298   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 299   ///
 300   static bool classof(const ConstantAggregateZero *) { return true; }
 301   static bool classof(const Value *V) {
 302     return V->getValueID() == ConstantAggregateZeroVal;
 303   }
 304 };
 305
 306
 307 //===----------------------------------------------------------------------===//
 308 /// ConstantArray - Constant Array Declarations
 309 ///
 310 class ConstantArray : public Constant {
 311   friend struct ConstantCreator<ConstantArray, ArrayType,
 312                                     std::vector<Constant*> >;
 313   ConstantArray(const ConstantArray &);      // DO NOT IMPLEMENT
 314 protected:
 315   ConstantArray(const ArrayType *T, const std::vector<Constant*> &Val);
 316   ~ConstantArray();
 317 public:
 318   /// get() - Static factory methods - Return objects of the specified value
 319   static Constant *get(const ArrayType *T, const std::vector<Constant*> &);
 320   static Constant *get(const ArrayType *T,
 321                        Constant*const*Vals, unsigned NumVals) {
 322     // FIXME: make this the primary ctor method.
 323     return get(T, std::vector<Constant*>(Vals, Vals+NumVals));
 324   }
 325
 326   /// This method constructs a ConstantArray and initializes it with a text
 327   /// string. The default behavior (AddNull==true) causes a null terminator to
 328   /// be placed at the end of the array. This effectively increases the length
 329   /// of the array by one (you've been warned).  However, in some situations
 330   /// this is not desired so if AddNull==false then the string is copied without
 331   /// null termination.
 332   static Constant *get(const std::string &Initializer, bool AddNull = true);
 333
 334   /// getType - Specialize the getType() method to always return an ArrayType,
 335   /// which reduces the amount of casting needed in parts of the compiler.
 336   ///
 337   inline const ArrayType *getType() const {
 338     return reinterpret_cast<const ArrayType*>(Value::getType());
 339   }
 340
 341   /// isString - This method returns true if the array is an array of i8 and
 342   /// the elements of the array are all ConstantInt's.
 343   bool isString() const;
 344
 345   /// isCString - This method returns true if the array is a string (see
 346   /// @verbatim
 347   /// isString) and it ends in a null byte \0 and does not contains any other
 348   /// @endverbatim
 349   /// null bytes except its terminator.
 350   bool isCString() const;
 351
 352   /// getAsString - If this array is isString(), then this method converts the
 353   /// array to an std::string and returns it.  Otherwise, it asserts out.
 354   ///
 355   std::string getAsString() const;
 356
 357   /// isNullValue - Return true if this is the value that would be returned by
 358   /// getNullValue.  This always returns false because zero arrays are always
 359   /// created as ConstantAggregateZero objects.
 360   virtual bool isNullValue() const { return false; }
 361
 362   virtual void destroyConstant();
 363   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
 364
 365   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 366   static inline bool classof(const ConstantArray *) { return true; }
 367   static bool classof(const Value *V) {
 368     return V->getValueID() == ConstantArrayVal;
 369   }
 370 };
 371
 372
 373 //===----------------------------------------------------------------------===//
 374 // ConstantStruct - Constant Struct Declarations
 375 //
 376 class ConstantStruct : public Constant {
 377   friend struct ConstantCreator<ConstantStruct, StructType,
 378                                     std::vector<Constant*> >;
 379   ConstantStruct(const ConstantStruct &);      // DO NOT IMPLEMENT
 380 protected:
 381   ConstantStruct(const StructType *T, const std::vector<Constant*> &Val);
 382   ~ConstantStruct();
 383 public:
 384   /// get() - Static factory methods - Return objects of the specified value
 385   ///
 386   static Constant *get(const StructType *T, const std::vector<Constant*> &V);
 387   static Constant *get(const std::vector<Constant*> &V, bool Packed = false);
 388   static Constant *get(Constant*const* Vals, unsigned NumVals,
 389                        bool Packed = false) {
 390     // FIXME: make this the primary ctor method.
 391     return get(std::vector<Constant*>(Vals, Vals+NumVals), Packed);
 392   }
 393
 394   /// getType() specialization - Reduce amount of casting...
 395   ///
 396   inline const StructType *getType() const {
 397     return reinterpret_cast<const StructType*>(Value::getType());
 398   }
 399
 400   /// isNullValue - Return true if this is the value that would be returned by
 401   /// getNullValue.  This always returns false because zero structs are always
 402   /// created as ConstantAggregateZero objects.
 403   virtual bool isNullValue() const {
 404     return false;
 405   }
 406
 407   virtual void destroyConstant();
 408   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
 409
 410   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 411   static inline bool classof(const ConstantStruct *) { return true; }
 412   static bool classof(const Value *V) {
 413     return V->getValueID() == ConstantStructVal;
 414   }
 415 };
 416
 417 //===----------------------------------------------------------------------===//
 418 /// ConstantVector - Constant Vector Declarations
 419 ///
 420 class ConstantVector : public Constant {
 421   friend struct ConstantCreator<ConstantVector, VectorType,
 422                                     std::vector<Constant*> >;
 423   ConstantVector(const ConstantVector &);      // DO NOT IMPLEMENT
 424 protected:
 425   ConstantVector(const VectorType *T, const std::vector<Constant*> &Val);
 426   ~ConstantVector();
 427 public:
 428   /// get() - Static factory methods - Return objects of the specified value
 429   static Constant *get(const VectorType *T, const std::vector<Constant*> &);
 430   static Constant *get(const std::vector<Constant*> &V);
 431   static Constant *get(Constant*const* Vals, unsigned NumVals) {
 432     // FIXME: make this the primary ctor method.
 433     return get(std::vector<Constant*>(Vals, Vals+NumVals));
 434   }
 435
 436   /// getType - Specialize the getType() method to always return a VectorType,
 437   /// which reduces the amount of casting needed in parts of the compiler.
 438   ///
 439   inline const VectorType *getType() const {
 440     return reinterpret_cast<const VectorType*>(Value::getType());
 441   }
 442
 443   /// @returns the value for a vector integer constant of the given type that
 444   /// has all its bits set to true.
 445   /// @brief Get the all ones value
 446   static ConstantVector *getAllOnesValue(const VectorType *Ty);
 447
 448   /// isNullValue - Return true if this is the value that would be returned by
 449   /// getNullValue.  This always returns false because zero vectors are always
 450   /// created as ConstantAggregateZero objects.
 451   virtual bool isNullValue() const { return false; }
 452
 453   /// This function will return true iff every element in this vector constant
 454   /// is set to all ones.
 455   /// @returns true iff this constant's emements are all set to all ones.
 456   /// @brief Determine if the value is all ones.
 457   bool isAllOnesValue() const;
 458
 459   /// getSplatValue - If this is a splat constant, meaning that all of the
 460   /// elements have the same value, return that value. Otherwise return NULL.
 461   Constant *getSplatValue();
 462
 463   virtual void destroyConstant();
 464   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
 465
 466   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 467   static inline bool classof(const ConstantVector *) { return true; }
 468   static bool classof(const Value *V) {
 469     return V->getValueID() == ConstantVectorVal;
 470   }
 471 };
 472
 473 //===----------------------------------------------------------------------===//
 474 /// ConstantPointerNull - a constant pointer value that points to null
 475 ///
 476 class ConstantPointerNull : public Constant {
 477   friend struct ConstantCreator<ConstantPointerNull, PointerType, char>;
 478   void *operator new(size_t, unsigned);                  // DO NOT IMPLEMENT
 479   ConstantPointerNull(const ConstantPointerNull &);      // DO NOT IMPLEMENT
 480 protected:
 481   explicit ConstantPointerNull(const PointerType *T)
 482     : Constant(reinterpret_cast<const Type*>(T),
 483                Value::ConstantPointerNullVal, 0, 0) {}
 484
 485 protected:
 486   // allocate space for exactly zero operands
 487   void *operator new(size_t s) {
 488     return User::operator new(s, 0);
 489   }
 490 public:
 491   /// get() - Static factory methods - Return objects of the specified value
 492   static ConstantPointerNull *get(const PointerType *T);
 493
 494   /// isNullValue - Return true if this is the value that would be returned by
 495   /// getNullValue.
 496   virtual bool isNullValue() const { return true; }
 497
 498   virtual void destroyConstant();
 499
 500   /// getType - Specialize the getType() method to always return an PointerType,
 501   /// which reduces the amount of casting needed in parts of the compiler.
 502   ///
 503   inline const PointerType *getType() const {
 504     return reinterpret_cast<const PointerType*>(Value::getType());
 505   }
 506
 507   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 508   static inline bool classof(const ConstantPointerNull *) { return true; }
 509   static bool classof(const Value *V) {
 510     return V->getValueID() == ConstantPointerNullVal;
 511   }
 512 };
 513
 514
 515 /// ConstantExpr - a constant value that is initialized with an expression using
 516 /// other constant values.
 517 ///
 518 /// This class uses the standard Instruction opcodes to define the various
 519 /// constant expressions.  The Opcode field for the ConstantExpr class is
 520 /// maintained in the Value::SubclassData field.
 521 class ConstantExpr : public Constant {
 522   friend struct ConstantCreator<ConstantExpr,Type,
 523                             std::pair<unsigned, std::vector<Constant*> > >;
 524   friend struct ConvertConstantType<ConstantExpr, Type>;
 525
 526 protected:
 527   ConstantExpr(const Type *Ty, unsigned Opcode, Use *Ops, unsigned NumOps)
 528     : Constant(Ty, ConstantExprVal, Ops, NumOps) {
 529     // Operation type (an Instruction opcode) is stored as the SubclassData.
 530     SubclassData = Opcode;
 531   }
 532
 533   // These private methods are used by the type resolution code to create
 534   // ConstantExprs in intermediate forms.
 535   static Constant *getTy(const Type *Ty, unsigned Opcode,
 536                          Constant *C1, Constant *C2);
 537   static Constant *getCompareTy(unsigned short pred, Constant *C1,
 538                                 Constant *C2);
 539   static Constant *getSelectTy(const Type *Ty,
 540                                Constant *C1, Constant *C2, Constant *C3);
 541   static Constant *getGetElementPtrTy(const Type *Ty, Constant *C,
 542                                       Value* const *Idxs, unsigned NumIdxs);
 543   static Constant *getExtractElementTy(const Type *Ty, Constant *Val,
 544                                        Constant *Idx);
 545   static Constant *getInsertElementTy(const Type *Ty, Constant *Val,
 546                                       Constant *Elt, Constant *Idx);
 547   static Constant *getShuffleVectorTy(const Type *Ty, Constant *V1,
 548                                       Constant *V2, Constant *Mask);
 549
 550 public:
 551   // Static methods to construct a ConstantExpr of different kinds.  Note that
 552   // these methods may return a object that is not an instance of the
 553   // ConstantExpr class, because they will attempt to fold the constant
 554   // expression into something simpler if possible.
 555
 556   /// Cast constant expr
 557   ///
 558   static Constant *getTrunc   (Constant *C, const Type *Ty);
 559   static Constant *getSExt    (Constant *C, const Type *Ty);
 560   static Constant *getZExt    (Constant *C, const Type *Ty);
 561   static Constant *getFPTrunc (Constant *C, const Type *Ty);
 562   static Constant *getFPExtend(Constant *C, const Type *Ty);
 563   static Constant *getUIToFP  (Constant *C, const Type *Ty);
 564   static Constant *getSIToFP  (Constant *C, const Type *Ty);
 565   static Constant *getFPToUI  (Constant *C, const Type *Ty);
 566   static Constant *getFPToSI  (Constant *C, const Type *Ty);
 567   static Constant *getPtrToInt(Constant *C, const Type *Ty);
 568   static Constant *getIntToPtr(Constant *C, const Type *Ty);
 569   static Constant *getBitCast (Constant *C, const Type *Ty);
 570
 571   // @brief Convenience function for getting one of the casting operations
 572   // using a CastOps opcode.
 573   static Constant *getCast(
 574     unsigned ops,  ///< The opcode for the conversion
 575     Constant *C,   ///< The constant to be converted
 576     const Type *Ty ///< The type to which the constant is converted
 577   );
 578
 579   // @brief Create a ZExt or BitCast cast constant expression
 580   static Constant *getZExtOrBitCast(
 581     Constant *C,   ///< The constant to zext or bitcast
 582     const Type *Ty ///< The type to zext or bitcast C to
 583   );
 584
 585   // @brief Create a SExt or BitCast cast constant expression
 586   static Constant *getSExtOrBitCast(
 587     Constant *C,   ///< The constant to sext or bitcast
 588     const Type *Ty ///< The type to sext or bitcast C to
 589   );
 590
 591   // @brief Create a Trunc or BitCast cast constant expression
 592   static Constant *getTruncOrBitCast(
 593     Constant *C,   ///< The constant to trunc or bitcast
 594     const Type *Ty ///< The type to trunc or bitcast C to
 595   );
 596
 597   /// @brief Create a BitCast or a PtrToInt cast constant expression
 598   static Constant *getPointerCast(
 599     Constant *C,   ///< The pointer value to be casted (operand 0)
 600     const Type *Ty ///< The type to which cast should be made
 601   );
 602
 603   /// @brief Create a ZExt, Bitcast or Trunc for integer -> integer casts
 604   static Constant *getIntegerCast(
 605     Constant *C,    ///< The integer constant to be casted
 606     const Type *Ty, ///< The integer type to cast to
 607     bool isSigned   ///< Whether C should be treated as signed or not
 608   );
 609
 610   /// @brief Create a FPExt, Bitcast or FPTrunc for fp -> fp casts
 611   static Constant *getFPCast(
 612     Constant *C,    ///< The integer constant to be casted
 613     const Type *Ty ///< The integer type to cast to
 614   );
 615
 616   /// @brief Return true if this is a convert constant expression
 617   bool isCast() const;
 618
 619   /// @brief Return true if this is a compare constant expression
 620   bool isCompare() const;
 621
 622   /// Select constant expr
 623   ///
 624   static Constant *getSelect(Constant *C, Constant *V1, Constant *V2) {
 625     return getSelectTy(V1->getType(), C, V1, V2);
 626   }
 627
 628   /// getSizeOf constant expr - computes the size of a type in a target
 629   /// independent way (Note: the return type is an i64).
 630   ///
 631   static Constant *getSizeOf(const Type *Ty);
 632
 633   /// ConstantExpr::get - Return a binary or shift operator constant expression,
 634   /// folding if possible.
 635   ///
 636   static Constant *get(unsigned Opcode, Constant *C1, Constant *C2);
 637
 638   /// @brief Return an ICmp or FCmp comparison operator constant expression.
 639   static Constant *getCompare(unsigned short pred, Constant *C1, Constant *C2);
 640
 641   /// ConstantExpr::get* - Return some common constants without having to
 642   /// specify the full Instruction::OPCODE identifier.
 643   ///
 644   static Constant *getNeg(Constant *C);
 645   static Constant *getNot(Constant *C);
 646   static Constant *getAdd(Constant *C1, Constant *C2);
 647   static Constant *getSub(Constant *C1, Constant *C2);
 648   static Constant *getMul(Constant *C1, Constant *C2);
 649   static Constant *getUDiv(Constant *C1, Constant *C2);
 650   static Constant *getSDiv(Constant *C1, Constant *C2);
 651   static Constant *getFDiv(Constant *C1, Constant *C2);
 652   static Constant *getURem(Constant *C1, Constant *C2); // unsigned rem
 653   static Constant *getSRem(Constant *C1, Constant *C2); // signed rem
 654   static Constant *getFRem(Constant *C1, Constant *C2);
 655   static Constant *getAnd(Constant *C1, Constant *C2);
 656   static Constant *getOr(Constant *C1, Constant *C2);
 657   static Constant *getXor(Constant *C1, Constant *C2);
 658   static Constant *getICmp(unsigned short pred, Constant *LHS, Constant *RHS);
 659   static Constant *getFCmp(unsigned short pred, Constant *LHS, Constant *RHS);
 660   static Constant *getShl(Constant *C1, Constant *C2);
 661   static Constant *getLShr(Constant *C1, Constant *C2);
 662   static Constant *getAShr(Constant *C1, Constant *C2);
 663
 664   /// Getelementptr form.  std::vector<Value*> is only accepted for convenience:
 665   /// all elements must be Constant's.
 666   ///
 667   static Constant *getGetElementPtr(Constant *C,
 668                                     Constant* const *IdxList, unsigned NumIdx);
 669   static Constant *getGetElementPtr(Constant *C,
 670                                     Value* const *IdxList, unsigned NumIdx);
 671
 672   static Constant *getExtractElement(Constant *Vec, Constant *Idx);
 673   static Constant *getInsertElement(Constant *Vec, Constant *Elt,Constant *Idx);
 674   static Constant *getShuffleVector(Constant *V1, Constant *V2, Constant *Mask);
 675
 676   /// Floating point negation must be implemented with f(x) = -0.0 - x. This
 677   /// method returns the negative zero constant for floating point or vector
 678   /// floating point types; for all other types, it returns the null value.
 679   static Constant *getZeroValueForNegationExpr(const Type *Ty);
 680
 681   /// isNullValue - Return true if this is the value that would be returned by
 682   /// getNullValue.
 683   virtual bool isNullValue() const { return false; }
 684
 685   /// getOpcode - Return the opcode at the root of this constant expression
 686   unsigned getOpcode() const { return SubclassData; }
 687
 688   /// getPredicate - Return the ICMP or FCMP predicate value. Assert if this is
 689   /// not an ICMP or FCMP constant expression.
 690   unsigned getPredicate() const;
 691
 692   /// getOpcodeName - Return a string representation for an opcode.
 693   const char *getOpcodeName() const;
 694
 695   /// getWithOperandReplaced - Return a constant expression identical to this
 696   /// one, but with the specified operand set to the specified value.
 697   Constant *getWithOperandReplaced(unsigned OpNo, Constant *Op) const;
 698
 699   /// getWithOperands - This returns the current constant expression with the
 700   /// operands replaced with the specified values.  The specified operands must
 701   /// match count and type with the existing ones.
 702   Constant *getWithOperands(const std::vector<Constant*> &Ops) const;
 703
 704   virtual void destroyConstant();
 705   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
 706
 707   /// Override methods to provide more type information...
 708   inline Constant *getOperand(unsigned i) {
 709     return cast<Constant>(User::getOperand(i));
 710   }
 711   inline Constant *getOperand(unsigned i) const {
 712     return const_cast<Constant*>(cast<Constant>(User::getOperand(i)));
 713   }
 714
 715
 716   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 717   static inline bool classof(const ConstantExpr *) { return true; }
 718   static inline bool classof(const Value *V) {
 719     return V->getValueID() == ConstantExprVal;
 720   }
 721 };
 722
 723
 724 //===----------------------------------------------------------------------===//
 725 /// UndefValue - 'undef' values are things that do not have specified contents.
 726 /// These are used for a variety of purposes, including global variable
 727 /// initializers and operands to instructions.  'undef' values can occur with
 728 /// any type.
 729 ///
 730 class UndefValue : public Constant {
 731   friend struct ConstantCreator<UndefValue, Type, char>;
 732   void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
 733   UndefValue(const UndefValue &);      // DO NOT IMPLEMENT
 734 protected:
 735   explicit UndefValue(const Type *T) : Constant(T, UndefValueVal, 0, 0) {}
 736 protected:
 737   // allocate space for exactly zero operands
 738   void *operator new(size_t s) {
 739     return User::operator new(s, 0);
 740   }
 741 public:
 742   /// get() - Static factory methods - Return an 'undef' object of the specified
 743   /// type.
 744   ///
 745   static UndefValue *get(const Type *T);
 746
 747   /// isNullValue - Return true if this is the value that would be returned by
 748   /// getNullValue.
 749   virtual bool isNullValue() const { return false; }
 750
 751   virtual void destroyConstant();
 752
 753   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 754   static inline bool classof(const UndefValue *) { return true; }
 755   static bool classof(const Value *V) {
 756     return V->getValueID() == UndefValueVal;
 757   }
 758 };
 759
 760 } // End llvm namespace
 761
 762 #endif