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