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
  11 /// This file contains the declarations for the subclasses of Constant,
  12 /// which represent the different flavors of constant values that live in LLVM.
  13 /// Note that Constants are immutable (once created they never change) and are
  14 /// fully shared by structural equivalence.  This means that two structurally
  15 /// equivalent constants will always have the same address.  Constant's are
  16 /// created on demand as needed and never deleted: thus clients don't have to
  17 /// worry about the lifetime of the objects.
  18 //
  19 //===----------------------------------------------------------------------===//
  20
  21 #ifndef LLVM_CONSTANTS_H
  22 #define LLVM_CONSTANTS_H
  23
  24 #include "llvm/Constant.h"
  25 #include "llvm/OperandTraits.h"
  26 #include "llvm/ADT/APInt.h"
  27 #include "llvm/ADT/APFloat.h"
  28 #include "llvm/ADT/ArrayRef.h"
  29
  30 namespace llvm {
  31
  32 class ArrayType;
  33 class IntegerType;
  34 class StructType;
  35 class PointerType;
  36 class VectorType;
  37
  38 template<class ConstantClass, class TypeClass, class ValType>
  39 struct ConstantCreator;
  40 template<class ConstantClass, class TypeClass>
  41 struct ConvertConstantType;
  42
  43 //===----------------------------------------------------------------------===//
  44 /// This is the shared class of boolean and integer constants. This class
  45 /// represents both boolean and integral constants.
  46 /// @brief Class for constant integers.
  47 class ConstantInt : public Constant {
  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   static ConstantInt *getTrue(LLVMContext &Context);
  59   static ConstantInt *getFalse(LLVMContext &Context);
  60   static Constant *getTrue(const Type *Ty);
  61   static Constant *getFalse(const Type *Ty);
  62
  63   /// If Ty is a vector type, return a Constant with a splat of the given
  64   /// value. Otherwise return a ConstantInt for the given value.
  65   static Constant *get(const Type *Ty, uint64_t V, bool isSigned = false);
  66
  67   /// Return a ConstantInt with the specified integer value for the specified
  68   /// type. If the type is wider than 64 bits, the value will be zero-extended
  69   /// to fit the type, unless isSigned is true, in which case the value will
  70   /// be interpreted as a 64-bit signed integer and sign-extended to fit
  71   /// the type.
  72   /// @brief Get a ConstantInt for a specific value.
  73   static ConstantInt *get(const IntegerType *Ty, uint64_t V,
  74                           bool isSigned = false);
  75
  76   /// Return a ConstantInt with the specified value for the specified type. The
  77   /// value V will be canonicalized to a an unsigned APInt. Accessing it with
  78   /// either getSExtValue() or getZExtValue() will yield a correctly sized and
  79   /// signed value for the type Ty.
  80   /// @brief Get a ConstantInt for a specific signed value.
  81   static ConstantInt *getSigned(const IntegerType *Ty, int64_t V);
  82   static Constant *getSigned(const Type *Ty, int64_t V);
  83
  84   /// Return a ConstantInt with the specified value and an implied Type. The
  85   /// type is the integer type that corresponds to the bit width of the value.
  86   static ConstantInt *get(LLVMContext &Context, const APInt &V);
  87
  88   /// Return a ConstantInt constructed from the string strStart with the given
  89   /// radix.
  90   static ConstantInt *get(const IntegerType *Ty, StringRef Str,
  91                           uint8_t radix);
  92
  93   /// If Ty is a vector type, return a Constant with a splat of the given
  94   /// value. Otherwise return a ConstantInt for the given value.
  95   static Constant *get(const Type* Ty, const APInt& V);
  96
  97   /// Return the constant as an APInt value reference. This allows clients to
  98   /// obtain a copy of the value, with all its precision in tact.
  99   /// @brief Return the constant's value.
 100   inline const APInt &getValue() const {
 101     return Val;
 102   }
 103
 104   /// getBitWidth - Return the bitwidth of this constant.
 105   unsigned getBitWidth() const { return Val.getBitWidth(); }
 106
 107   /// Return the constant as a 64-bit unsigned integer value after it
 108   /// has been zero extended as appropriate for the type of this constant. Note
 109   /// that this method can assert if the value does not fit in 64 bits.
 110   /// @deprecated
 111   /// @brief Return the zero extended value.
 112   inline uint64_t getZExtValue() const {
 113     return Val.getZExtValue();
 114   }
 115
 116   /// Return the constant as a 64-bit integer value after it has been sign
 117   /// extended as appropriate for the type of this constant. Note that
 118   /// this method can assert if the value does not fit in 64 bits.
 119   /// @deprecated
 120   /// @brief Return the sign extended value.
 121   inline int64_t getSExtValue() const {
 122     return Val.getSExtValue();
 123   }
 124
 125   /// A helper method that can be used to determine if the constant contained
 126   /// within is equal to a constant.  This only works for very small values,
 127   /// because this is all that can be represented with all types.
 128   /// @brief Determine if this constant's value is same as an unsigned char.
 129   bool equalsInt(uint64_t V) const {
 130     return Val == V;
 131   }
 132
 133   /// getType - Specialize the getType() method to always return an IntegerType,
 134   /// which reduces the amount of casting needed in parts of the compiler.
 135   ///
 136   inline const IntegerType *getType() const {
 137     return reinterpret_cast<const IntegerType*>(Value::getType());
 138   }
 139
 140   /// This static method returns true if the type Ty is big enough to
 141   /// represent the value V. This can be used to avoid having the get method
 142   /// assert when V is larger than Ty can represent. Note that there are two
 143   /// versions of this method, one for unsigned and one for signed integers.
 144   /// Although ConstantInt canonicalizes everything to an unsigned integer,
 145   /// the signed version avoids callers having to convert a signed quantity
 146   /// to the appropriate unsigned type before calling the method.
 147   /// @returns true if V is a valid value for type Ty
 148   /// @brief Determine if the value is in range for the given type.
 149   static bool isValueValidForType(const Type *Ty, uint64_t V);
 150   static bool isValueValidForType(const Type *Ty, int64_t V);
 151
 152   /// This function will return true iff this constant represents the "null"
 153   /// value that would be returned by the getNullValue method.
 154   /// @returns true if this is the null integer value.
 155   /// @brief Determine if the value is null.
 156   virtual bool isNullValue() const {
 157     return Val == 0;
 158   }
 159
 160   /// This is just a convenience method to make client code smaller for a
 161   /// common code. It also correctly performs the comparison without the
 162   /// potential for an assertion from getZExtValue().
 163   bool isZero() const {
 164     return Val == 0;
 165   }
 166
 167   /// This is just a convenience method to make client code smaller for a
 168   /// common case. It also correctly performs the comparison without the
 169   /// potential for an assertion from getZExtValue().
 170   /// @brief Determine if the value is one.
 171   bool isOne() const {
 172     return Val == 1;
 173   }
 174
 175   /// This function will return true iff every bit in this constant is set
 176   /// to true.
 177   /// @returns true iff this constant's bits are all set to true.
 178   /// @brief Determine if the value is all ones.
 179   bool isAllOnesValue() const {
 180     return Val.isAllOnesValue();
 181   }
 182
 183   /// This function will return true iff this constant represents the largest
 184   /// value that may be represented by the constant's type.
 185   /// @returns true iff this is the largest value that may be represented
 186   /// by this type.
 187   /// @brief Determine if the value is maximal.
 188   bool isMaxValue(bool isSigned) const {
 189     if (isSigned)
 190       return Val.isMaxSignedValue();
 191     else
 192       return Val.isMaxValue();
 193   }
 194
 195   /// This function will return true iff this constant represents the smallest
 196   /// value that may be represented by this constant's type.
 197   /// @returns true if this is the smallest value that may be represented by
 198   /// this type.
 199   /// @brief Determine if the value is minimal.
 200   bool isMinValue(bool isSigned) const {
 201     if (isSigned)
 202       return Val.isMinSignedValue();
 203     else
 204       return Val.isMinValue();
 205   }
 206
 207   /// This function will return true iff this constant represents a value with
 208   /// active bits bigger than 64 bits or a value greater than the given uint64_t
 209   /// value.
 210   /// @returns true iff this constant is greater or equal to the given number.
 211   /// @brief Determine if the value is greater or equal to the given number.
 212   bool uge(uint64_t Num) {
 213     return Val.getActiveBits() > 64 || Val.getZExtValue() >= Num;
 214   }
 215
 216   /// getLimitedValue - If the value is smaller than the specified limit,
 217   /// return it, otherwise return the limit value.  This causes the value
 218   /// to saturate to the limit.
 219   /// @returns the min of the value of the constant and the specified value
 220   /// @brief Get the constant's value with a saturation limit
 221   uint64_t getLimitedValue(uint64_t Limit = ~0ULL) const {
 222     return Val.getLimitedValue(Limit);
 223   }
 224
 225   /// @brief Methods to support type inquiry through isa, cast, and dyn_cast.
 226   static inline bool classof(const ConstantInt *) { return true; }
 227   static bool classof(const Value *V) {
 228     return V->getValueID() == ConstantIntVal;
 229   }
 230 };
 231
 232
 233 //===----------------------------------------------------------------------===//
 234 /// ConstantFP - Floating Point Values [float, double]
 235 ///
 236 class ConstantFP : public Constant {
 237   APFloat Val;
 238   void *operator new(size_t, unsigned);// DO NOT IMPLEMENT
 239   ConstantFP(const ConstantFP &);      // DO NOT IMPLEMENT
 240   friend class LLVMContextImpl;
 241 protected:
 242   ConstantFP(const Type *Ty, const APFloat& V);
 243 protected:
 244   // allocate space for exactly zero operands
 245   void *operator new(size_t s) {
 246     return User::operator new(s, 0);
 247   }
 248 public:
 249   /// Floating point negation must be implemented with f(x) = -0.0 - x. This
 250   /// method returns the negative zero constant for floating point or vector
 251   /// floating point types; for all other types, it returns the null value.
 252   static Constant *getZeroValueForNegation(const Type *Ty);
 253
 254   /// get() - This returns a ConstantFP, or a vector containing a splat of a
 255   /// ConstantFP, for the specified value in the specified type.  This should
 256   /// only be used for simple constant values like 2.0/1.0 etc, that are
 257   /// known-valid both as host double and as the target format.
 258   static Constant *get(const Type* Ty, double V);
 259   static Constant *get(const Type* Ty, StringRef Str);
 260   static ConstantFP *get(LLVMContext &Context, const APFloat &V);
 261   static ConstantFP *getNegativeZero(const Type* Ty);
 262   static ConstantFP *getInfinity(const Type *Ty, bool Negative = false);
 263
 264   /// isValueValidForType - return true if Ty is big enough to represent V.
 265   static bool isValueValidForType(const Type *Ty, const APFloat &V);
 266   inline const APFloat& getValueAPF() const { return Val; }
 267
 268   /// isNullValue - Return true if this is the value that would be returned by
 269   /// getNullValue.  For ConstantFP, this is +0.0, but not -0.0.  To handle the
 270   /// two the same, use isZero().
 271   virtual bool isNullValue() const;
 272
 273   /// isNegativeZeroValue - Return true if the value is what would be returned
 274   /// by getZeroValueForNegation.
 275   virtual bool isNegativeZeroValue() const {
 276     return Val.isZero() && Val.isNegative();
 277   }
 278
 279   /// isZero - Return true if the value is positive or negative zero.
 280   bool isZero() const { return Val.isZero(); }
 281
 282   /// isNaN - Return true if the value is a NaN.
 283   bool isNaN() const { return Val.isNaN(); }
 284
 285   /// isExactlyValue - We don't rely on operator== working on double values, as
 286   /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
 287   /// As such, this method can be used to do an exact bit-for-bit comparison of
 288   /// two floating point values.  The version with a double operand is retained
 289   /// because it's so convenient to write isExactlyValue(2.0), but please use
 290   /// it only for simple constants.
 291   bool isExactlyValue(const APFloat &V) const;
 292
 293   bool isExactlyValue(double V) const {
 294     bool ignored;
 295     // convert is not supported on this type
 296     if (&Val.getSemantics() == &APFloat::PPCDoubleDouble)
 297       return false;
 298     APFloat FV(V);
 299     FV.convert(Val.getSemantics(), APFloat::rmNearestTiesToEven, &ignored);
 300     return isExactlyValue(FV);
 301   }
 302   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 303   static inline bool classof(const ConstantFP *) { return true; }
 304   static bool classof(const Value *V) {
 305     return V->getValueID() == ConstantFPVal;
 306   }
 307 };
 308
 309 //===----------------------------------------------------------------------===//
 310 /// ConstantAggregateZero - All zero aggregate value
 311 ///
 312 class ConstantAggregateZero : public Constant {
 313   friend struct ConstantCreator<ConstantAggregateZero, Type, char>;
 314   void *operator new(size_t, unsigned);                      // DO NOT IMPLEMENT
 315   ConstantAggregateZero(const ConstantAggregateZero &);      // DO NOT IMPLEMENT
 316 protected:
 317   explicit ConstantAggregateZero(const Type *ty)
 318     : Constant(ty, ConstantAggregateZeroVal, 0, 0) {}
 319 protected:
 320   // allocate space for exactly zero operands
 321   void *operator new(size_t s) {
 322     return User::operator new(s, 0);
 323   }
 324 public:
 325   static ConstantAggregateZero* get(const Type *Ty);
 326
 327   /// isNullValue - Return true if this is the value that would be returned by
 328   /// getNullValue.
 329   virtual bool isNullValue() const { return true; }
 330
 331   virtual void destroyConstant();
 332
 333   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 334   ///
 335   static bool classof(const ConstantAggregateZero *) { return true; }
 336   static bool classof(const Value *V) {
 337     return V->getValueID() == ConstantAggregateZeroVal;
 338   }
 339 };
 340
 341
 342 //===----------------------------------------------------------------------===//
 343 /// ConstantArray - Constant Array Declarations
 344 ///
 345 class ConstantArray : public Constant {
 346   friend struct ConstantCreator<ConstantArray, ArrayType,
 347                                     std::vector<Constant*> >;
 348   ConstantArray(const ConstantArray &);      // DO NOT IMPLEMENT
 349 protected:
 350   ConstantArray(const ArrayType *T, const std::vector<Constant*> &Val);
 351 public:
 352   // ConstantArray accessors
 353   static Constant *get(const ArrayType *T, const std::vector<Constant*> &V);
 354   static Constant *get(const ArrayType *T, Constant *const *Vals,
 355                        unsigned NumVals);
 356
 357   /// This method constructs a ConstantArray and initializes it with a text
 358   /// string. The default behavior (AddNull==true) causes a null terminator to
 359   /// be placed at the end of the array. This effectively increases the length
 360   /// of the array by one (you've been warned).  However, in some situations
 361   /// this is not desired so if AddNull==false then the string is copied without
 362   /// null termination.
 363   static Constant *get(LLVMContext &Context, StringRef Initializer,
 364                        bool AddNull = true);
 365
 366   /// Transparently provide more efficient getOperand methods.
 367   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
 368
 369   /// getType - Specialize the getType() method to always return an ArrayType,
 370   /// which reduces the amount of casting needed in parts of the compiler.
 371   ///
 372   inline const ArrayType *getType() const {
 373     return reinterpret_cast<const ArrayType*>(Value::getType());
 374   }
 375
 376   /// isString - This method returns true if the array is an array of i8 and
 377   /// the elements of the array are all ConstantInt's.
 378   bool isString() const;
 379
 380   /// isCString - This method returns true if the array is a string (see
 381   /// @verbatim
 382   /// isString) and it ends in a null byte \0 and does not contains any other
 383   /// @endverbatim
 384   /// null bytes except its terminator.
 385   bool isCString() const;
 386
 387   /// getAsString - If this array is isString(), then this method converts the
 388   /// array to an std::string and returns it.  Otherwise, it asserts out.
 389   ///
 390   std::string getAsString() const;
 391
 392   /// isNullValue - Return true if this is the value that would be returned by
 393   /// getNullValue.  This always returns false because zero arrays are always
 394   /// created as ConstantAggregateZero objects.
 395   virtual bool isNullValue() const { return false; }
 396
 397   virtual void destroyConstant();
 398   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
 399
 400   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 401   static inline bool classof(const ConstantArray *) { return true; }
 402   static bool classof(const Value *V) {
 403     return V->getValueID() == ConstantArrayVal;
 404   }
 405 };
 406
 407 template <>
 408 struct OperandTraits<ConstantArray> :
 409   public VariadicOperandTraits<ConstantArray> {
 410 };
 411
 412 DEFINE_TRANSPARENT_CASTED_OPERAND_ACCESSORS(ConstantArray, Constant)
 413
 414 //===----------------------------------------------------------------------===//
 415 // ConstantStruct - Constant Struct Declarations
 416 //
 417 class ConstantStruct : public Constant {
 418   friend struct ConstantCreator<ConstantStruct, StructType,
 419                                     std::vector<Constant*> >;
 420   ConstantStruct(const ConstantStruct &);      // DO NOT IMPLEMENT
 421 protected:
 422   ConstantStruct(const StructType *T, const std::vector<Constant*> &Val);
 423 public:
 424   // ConstantStruct accessors
 425   static Constant *get(const StructType *T, ArrayRef<Constant*> V);
 426   static Constant *get(const StructType *T, ...) END_WITH_NULL;
 427
 428   /// getAnon - Return an anonymous struct that has the specified
 429   /// elements.  If the struct is possibly empty, then you must specify a
 430   /// context.
 431   static Constant *getAnon(ArrayRef<Constant*> V, bool Packed = false) {
 432     return get(getTypeForElements(V, Packed), V);
 433   }
 434   static Constant *getAnon(LLVMContext &Ctx,
 435                            ArrayRef<Constant*> V, bool Packed = false) {
 436     return get(getTypeForElements(Ctx, V, Packed), V);
 437   }
 438
 439   /// getTypeForElements - Return an anonymous struct type to use for a constant
 440   /// with the specified set of elements.  The list must not be empty.
 441   static StructType *getTypeForElements(ArrayRef<Constant*> V,
 442                                         bool Packed = false);
 443   /// getTypeForElements - This version of the method allows an empty list.
 444   static StructType *getTypeForElements(LLVMContext &Ctx,
 445                                         ArrayRef<Constant*> V,
 446                                         bool Packed = false);
 447
 448   /// Transparently provide more efficient getOperand methods.
 449   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
 450
 451   /// getType() specialization - Reduce amount of casting...
 452   ///
 453   inline const StructType *getType() const {
 454     return reinterpret_cast<const StructType*>(Value::getType());
 455   }
 456
 457   /// isNullValue - Return true if this is the value that would be returned by
 458   /// getNullValue.  This always returns false because zero structs are always
 459   /// created as ConstantAggregateZero objects.
 460   virtual bool isNullValue() const {
 461     return false;
 462   }
 463
 464   virtual void destroyConstant();
 465   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
 466
 467   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 468   static inline bool classof(const ConstantStruct *) { return true; }
 469   static bool classof(const Value *V) {
 470     return V->getValueID() == ConstantStructVal;
 471   }
 472 };
 473
 474 template <>
 475 struct OperandTraits<ConstantStruct> :
 476   public VariadicOperandTraits<ConstantStruct> {
 477 };
 478
 479 DEFINE_TRANSPARENT_CASTED_OPERAND_ACCESSORS(ConstantStruct, Constant)
 480
 481
 482 //===----------------------------------------------------------------------===//
 483 /// ConstantVector - Constant Vector Declarations
 484 ///
 485 class ConstantVector : public Constant {
 486   friend struct ConstantCreator<ConstantVector, VectorType,
 487                                     std::vector<Constant*> >;
 488   ConstantVector(const ConstantVector &);      // DO NOT IMPLEMENT
 489 protected:
 490   ConstantVector(const VectorType *T, const std::vector<Constant*> &Val);
 491 public:
 492   // ConstantVector accessors
 493   static Constant *get(ArrayRef<Constant*> V);
 494   // FIXME: Eliminate this constructor form.
 495   static Constant *get(const VectorType *T, const std::vector<Constant*> &V);
 496
 497   /// Transparently provide more efficient getOperand methods.
 498   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
 499
 500   /// getType - Specialize the getType() method to always return a VectorType,
 501   /// which reduces the amount of casting needed in parts of the compiler.
 502   ///
 503   inline const VectorType *getType() const {
 504     return reinterpret_cast<const VectorType*>(Value::getType());
 505   }
 506
 507   /// isNullValue - Return true if this is the value that would be returned by
 508   /// getNullValue.  This always returns false because zero vectors are always
 509   /// created as ConstantAggregateZero objects.
 510   virtual bool isNullValue() const { return false; }
 511
 512   /// This function will return true iff every element in this vector constant
 513   /// is set to all ones.
 514   /// @returns true iff this constant's emements are all set to all ones.
 515   /// @brief Determine if the value is all ones.
 516   bool isAllOnesValue() const;
 517
 518   /// getSplatValue - If this is a splat constant, meaning that all of the
 519   /// elements have the same value, return that value. Otherwise return NULL.
 520   Constant *getSplatValue() const;
 521
 522   virtual void destroyConstant();
 523   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
 524
 525   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 526   static inline bool classof(const ConstantVector *) { return true; }
 527   static bool classof(const Value *V) {
 528     return V->getValueID() == ConstantVectorVal;
 529   }
 530 };
 531
 532 template <>
 533 struct OperandTraits<ConstantVector> :
 534   public VariadicOperandTraits<ConstantVector> {
 535 };
 536
 537 DEFINE_TRANSPARENT_CASTED_OPERAND_ACCESSORS(ConstantVector, Constant)
 538
 539 //===----------------------------------------------------------------------===//
 540 /// ConstantPointerNull - a constant pointer value that points to null
 541 ///
 542 class ConstantPointerNull : public Constant {
 543   friend struct ConstantCreator<ConstantPointerNull, PointerType, char>;
 544   void *operator new(size_t, unsigned);                  // DO NOT IMPLEMENT
 545   ConstantPointerNull(const ConstantPointerNull &);      // DO NOT IMPLEMENT
 546 protected:
 547   explicit ConstantPointerNull(const PointerType *T)
 548     : Constant(reinterpret_cast<const Type*>(T),
 549                Value::ConstantPointerNullVal, 0, 0) {}
 550
 551 protected:
 552   // allocate space for exactly zero operands
 553   void *operator new(size_t s) {
 554     return User::operator new(s, 0);
 555   }
 556 public:
 557   /// get() - Static factory methods - Return objects of the specified value
 558   static ConstantPointerNull *get(const PointerType *T);
 559
 560   /// isNullValue - Return true if this is the value that would be returned by
 561   /// getNullValue.
 562   virtual bool isNullValue() const { return true; }
 563
 564   virtual void destroyConstant();
 565
 566   /// getType - Specialize the getType() method to always return an PointerType,
 567   /// which reduces the amount of casting needed in parts of the compiler.
 568   ///
 569   inline const PointerType *getType() const {
 570     return reinterpret_cast<const PointerType*>(Value::getType());
 571   }
 572
 573   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 574   static inline bool classof(const ConstantPointerNull *) { return true; }
 575   static bool classof(const Value *V) {
 576     return V->getValueID() == ConstantPointerNullVal;
 577   }
 578 };
 579
 580 /// BlockAddress - The address of a basic block.
 581 ///
 582 class BlockAddress : public Constant {
 583   void *operator new(size_t, unsigned);                  // DO NOT IMPLEMENT
 584   void *operator new(size_t s) { return User::operator new(s, 2); }
 585   BlockAddress(Function *F, BasicBlock *BB);
 586 public:
 587   /// get - Return a BlockAddress for the specified function and basic block.
 588   static BlockAddress *get(Function *F, BasicBlock *BB);
 589
 590   /// get - Return a BlockAddress for the specified basic block.  The basic
 591   /// block must be embedded into a function.
 592   static BlockAddress *get(BasicBlock *BB);
 593
 594   /// Transparently provide more efficient getOperand methods.
 595   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 596
 597   Function *getFunction() const { return (Function*)Op<0>().get(); }
 598   BasicBlock *getBasicBlock() const { return (BasicBlock*)Op<1>().get(); }
 599
 600   /// isNullValue - Return true if this is the value that would be returned by
 601   /// getNullValue.
 602   virtual bool isNullValue() const { return false; }
 603
 604   virtual void destroyConstant();
 605   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
 606
 607   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 608   static inline bool classof(const BlockAddress *) { return true; }
 609   static inline bool classof(const Value *V) {
 610     return V->getValueID() == BlockAddressVal;
 611   }
 612 };
 613
 614 template <>
 615 struct OperandTraits<BlockAddress> :
 616   public FixedNumOperandTraits<BlockAddress, 2> {
 617 };
 618
 619 DEFINE_TRANSPARENT_CASTED_OPERAND_ACCESSORS(BlockAddress, Value)
 620
 621
 622 //===----------------------------------------------------------------------===//
 623 /// ConstantExpr - a constant value that is initialized with an expression using
 624 /// other constant values.
 625 ///
 626 /// This class uses the standard Instruction opcodes to define the various
 627 /// constant expressions.  The Opcode field for the ConstantExpr class is
 628 /// maintained in the Value::SubclassData field.
 629 class ConstantExpr : public Constant {
 630   friend struct ConstantCreator<ConstantExpr,Type,
 631                             std::pair<unsigned, std::vector<Constant*> > >;
 632   friend struct ConvertConstantType<ConstantExpr, Type>;
 633
 634 protected:
 635   ConstantExpr(const Type *ty, unsigned Opcode, Use *Ops, unsigned NumOps)
 636     : Constant(ty, ConstantExprVal, Ops, NumOps) {
 637     // Operation type (an Instruction opcode) is stored as the SubclassData.
 638     setValueSubclassData(Opcode);
 639   }
 640
 641   // These private methods are used by the type resolution code to create
 642   // ConstantExprs in intermediate forms.
 643   static Constant *getTy(const Type *Ty, unsigned Opcode,
 644                          Constant *C1, Constant *C2,
 645                          unsigned Flags = 0);
 646   static Constant *getCompareTy(unsigned short pred, Constant *C1,
 647                                 Constant *C2);
 648   static Constant *getSelectTy(const Type *Ty,
 649                                Constant *C1, Constant *C2, Constant *C3);
 650   template<typename IndexTy>
 651   static Constant *getGetElementPtrTy(const Type *Ty, Constant *C,
 652                                       IndexTy const *Idxs, unsigned NumIdxs,
 653                                       bool InBounds);
 654   static Constant *getExtractElementTy(const Type *Ty, Constant *Val,
 655                                        Constant *Idx);
 656   static Constant *getInsertElementTy(const Type *Ty, Constant *Val,
 657                                       Constant *Elt, Constant *Idx);
 658   static Constant *getShuffleVectorTy(const Type *Ty, Constant *V1,
 659                                       Constant *V2, Constant *Mask);
 660   static Constant *getExtractValueTy(const Type *Ty, Constant *Agg,
 661                                      const unsigned *Idxs, unsigned NumIdxs);
 662   static Constant *getInsertValueTy(const Type *Ty, Constant *Agg,
 663                                     Constant *Val,
 664                                     const unsigned *Idxs, unsigned NumIdxs);
 665   template<typename IndexTy>
 666   static Constant *getGetElementPtrImpl(Constant *C,
 667                                         IndexTy const *IdxList,
 668                                         unsigned NumIdx, bool InBounds);
 669
 670 public:
 671   // Static methods to construct a ConstantExpr of different kinds.  Note that
 672   // these methods may return a object that is not an instance of the
 673   // ConstantExpr class, because they will attempt to fold the constant
 674   // expression into something simpler if possible.
 675
 676   /// getAlignOf constant expr - computes the alignment of a type in a target
 677   /// independent way (Note: the return type is an i64).
 678   static Constant *getAlignOf(const Type *Ty);
 679
 680   /// getSizeOf constant expr - computes the (alloc) size of a type (in
 681   /// address-units, not bits) in a target independent way (Note: the return
 682   /// type is an i64).
 683   ///
 684   static Constant *getSizeOf(const Type *Ty);
 685
 686   /// getOffsetOf constant expr - computes the offset of a struct field in a
 687   /// target independent way (Note: the return type is an i64).
 688   ///
 689   static Constant *getOffsetOf(const StructType *STy, unsigned FieldNo);
 690
 691   /// getOffsetOf constant expr - This is a generalized form of getOffsetOf,
 692   /// which supports any aggregate type, and any Constant index.
 693   ///
 694   static Constant *getOffsetOf(const Type *Ty, Constant *FieldNo);
 695
 696   static Constant *getNeg(Constant *C, bool HasNUW = false, bool HasNSW =false);
 697   static Constant *getFNeg(Constant *C);
 698   static Constant *getNot(Constant *C);
 699   static Constant *getAdd(Constant *C1, Constant *C2,
 700                           bool HasNUW = false, bool HasNSW = false);
 701   static Constant *getFAdd(Constant *C1, Constant *C2);
 702   static Constant *getSub(Constant *C1, Constant *C2,
 703                           bool HasNUW = false, bool HasNSW = false);
 704   static Constant *getFSub(Constant *C1, Constant *C2);
 705   static Constant *getMul(Constant *C1, Constant *C2,
 706                           bool HasNUW = false, bool HasNSW = false);
 707   static Constant *getFMul(Constant *C1, Constant *C2);
 708   static Constant *getUDiv(Constant *C1, Constant *C2, bool isExact = false);
 709   static Constant *getSDiv(Constant *C1, Constant *C2, bool isExact = false);
 710   static Constant *getFDiv(Constant *C1, Constant *C2);
 711   static Constant *getURem(Constant *C1, Constant *C2);
 712   static Constant *getSRem(Constant *C1, Constant *C2);
 713   static Constant *getFRem(Constant *C1, Constant *C2);
 714   static Constant *getAnd(Constant *C1, Constant *C2);
 715   static Constant *getOr(Constant *C1, Constant *C2);
 716   static Constant *getXor(Constant *C1, Constant *C2);
 717   static Constant *getShl(Constant *C1, Constant *C2,
 718                           bool HasNUW = false, bool HasNSW = false);
 719   static Constant *getLShr(Constant *C1, Constant *C2, bool isExact = false);
 720   static Constant *getAShr(Constant *C1, Constant *C2, bool isExact = false);
 721   static Constant *getTrunc   (Constant *C, const Type *Ty);
 722   static Constant *getSExt    (Constant *C, const Type *Ty);
 723   static Constant *getZExt    (Constant *C, const Type *Ty);
 724   static Constant *getFPTrunc (Constant *C, const Type *Ty);
 725   static Constant *getFPExtend(Constant *C, const Type *Ty);
 726   static Constant *getUIToFP  (Constant *C, const Type *Ty);
 727   static Constant *getSIToFP  (Constant *C, const Type *Ty);
 728   static Constant *getFPToUI  (Constant *C, const Type *Ty);
 729   static Constant *getFPToSI  (Constant *C, const Type *Ty);
 730   static Constant *getPtrToInt(Constant *C, const Type *Ty);
 731   static Constant *getIntToPtr(Constant *C, const Type *Ty);
 732   static Constant *getBitCast (Constant *C, const Type *Ty);
 733
 734   static Constant *getNSWNeg(Constant *C) { return getNeg(C, false, true); }
 735   static Constant *getNUWNeg(Constant *C) { return getNeg(C, true, false); }
 736   static Constant *getNSWAdd(Constant *C1, Constant *C2) {
 737     return getAdd(C1, C2, false, true);
 738   }
 739   static Constant *getNUWAdd(Constant *C1, Constant *C2) {
 740     return getAdd(C1, C2, true, false);
 741   }
 742   static Constant *getNSWSub(Constant *C1, Constant *C2) {
 743     return getSub(C1, C2, false, true);
 744   }
 745   static Constant *getNUWSub(Constant *C1, Constant *C2) {
 746     return getSub(C1, C2, true, false);
 747   }
 748   static Constant *getNSWMul(Constant *C1, Constant *C2) {
 749     return getMul(C1, C2, false, true);
 750   }
 751   static Constant *getNUWMul(Constant *C1, Constant *C2) {
 752     return getMul(C1, C2, true, false);
 753   }
 754   static Constant *getNSWShl(Constant *C1, Constant *C2) {
 755     return getShl(C1, C2, false, true);
 756   }
 757   static Constant *getNUWShl(Constant *C1, Constant *C2) {
 758     return getShl(C1, C2, true, false);
 759   }
 760   static Constant *getExactSDiv(Constant *C1, Constant *C2) {
 761     return getSDiv(C1, C2, true);
 762   }
 763   static Constant *getExactUDiv(Constant *C1, Constant *C2) {
 764     return getUDiv(C1, C2, true);
 765   }
 766   static Constant *getExactAShr(Constant *C1, Constant *C2) {
 767     return getAShr(C1, C2, true);
 768   }
 769   static Constant *getExactLShr(Constant *C1, Constant *C2) {
 770     return getLShr(C1, C2, true);
 771   }
 772
 773   /// Transparently provide more efficient getOperand methods.
 774   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
 775
 776   // @brief Convenience function for getting one of the casting operations
 777   // using a CastOps opcode.
 778   static Constant *getCast(
 779     unsigned ops,  ///< The opcode for the conversion
 780     Constant *C,   ///< The constant to be converted
 781     const Type *Ty ///< The type to which the constant is converted
 782   );
 783
 784   // @brief Create a ZExt or BitCast cast constant expression
 785   static Constant *getZExtOrBitCast(
 786     Constant *C,   ///< The constant to zext or bitcast
 787     const Type *Ty ///< The type to zext or bitcast C to
 788   );
 789
 790   // @brief Create a SExt or BitCast cast constant expression
 791   static Constant *getSExtOrBitCast(
 792     Constant *C,   ///< The constant to sext or bitcast
 793     const Type *Ty ///< The type to sext or bitcast C to
 794   );
 795
 796   // @brief Create a Trunc or BitCast cast constant expression
 797   static Constant *getTruncOrBitCast(
 798     Constant *C,   ///< The constant to trunc or bitcast
 799     const Type *Ty ///< The type to trunc or bitcast C to
 800   );
 801
 802   /// @brief Create a BitCast or a PtrToInt cast constant expression
 803   static Constant *getPointerCast(
 804     Constant *C,   ///< The pointer value to be casted (operand 0)
 805     const Type *Ty ///< The type to which cast should be made
 806   );
 807
 808   /// @brief Create a ZExt, Bitcast or Trunc for integer -> integer casts
 809   static Constant *getIntegerCast(
 810     Constant *C,    ///< The integer constant to be casted
 811     const Type *Ty, ///< The integer type to cast to
 812     bool isSigned   ///< Whether C should be treated as signed or not
 813   );
 814
 815   /// @brief Create a FPExt, Bitcast or FPTrunc for fp -> fp casts
 816   static Constant *getFPCast(
 817     Constant *C,    ///< The integer constant to be casted
 818     const Type *Ty ///< The integer type to cast to
 819   );
 820
 821   /// @brief Return true if this is a convert constant expression
 822   bool isCast() const;
 823
 824   /// @brief Return true if this is a compare constant expression
 825   bool isCompare() const;
 826
 827   /// @brief Return true if this is an insertvalue or extractvalue expression,
 828   /// and the getIndices() method may be used.
 829   bool hasIndices() const;
 830
 831   /// @brief Return true if this is a getelementptr expression and all
 832   /// the index operands are compile-time known integers within the
 833   /// corresponding notional static array extents. Note that this is
 834   /// not equivalant to, a subset of, or a superset of the "inbounds"
 835   /// property.
 836   bool isGEPWithNoNotionalOverIndexing() const;
 837
 838   /// Select constant expr
 839   ///
 840   static Constant *getSelect(Constant *C, Constant *V1, Constant *V2) {
 841     return getSelectTy(V1->getType(), C, V1, V2);
 842   }
 843
 844   /// get - Return a binary or shift operator constant expression,
 845   /// folding if possible.
 846   ///
 847   static Constant *get(unsigned Opcode, Constant *C1, Constant *C2,
 848                        unsigned Flags = 0);
 849
 850   /// @brief Return an ICmp or FCmp comparison operator constant expression.
 851   static Constant *getCompare(unsigned short pred, Constant *C1, Constant *C2);
 852
 853   /// get* - Return some common constants without having to
 854   /// specify the full Instruction::OPCODE identifier.
 855   ///
 856   static Constant *getICmp(unsigned short pred, Constant *LHS, Constant *RHS);
 857   static Constant *getFCmp(unsigned short pred, Constant *LHS, Constant *RHS);
 858
 859   /// Getelementptr form.  Value* is only accepted for convenience;
 860   /// all elements must be Constant's.
 861   ///
 862   static Constant *getGetElementPtr(Constant *C,
 863                                     Constant *const *IdxList, unsigned NumIdx,
 864                                     bool InBounds = false);
 865   static Constant *getGetElementPtr(Constant *C,
 866                                     Value *const *IdxList, unsigned NumIdx,
 867                                     bool InBounds = false);
 868
 869   /// Create an "inbounds" getelementptr. See the documentation for the
 870   /// "inbounds" flag in LangRef.html for details.
 871   static Constant *getInBoundsGetElementPtr(Constant *C,
 872                                             Constant *const *IdxList,
 873                                             unsigned NumIdx) {
 874     return getGetElementPtr(C, IdxList, NumIdx, true);
 875   }
 876   static Constant *getInBoundsGetElementPtr(Constant *C,
 877                                             Value* const *IdxList,
 878                                             unsigned NumIdx) {
 879     return getGetElementPtr(C, IdxList, NumIdx, true);
 880   }
 881
 882   static Constant *getExtractElement(Constant *Vec, Constant *Idx);
 883   static Constant *getInsertElement(Constant *Vec, Constant *Elt,Constant *Idx);
 884   static Constant *getShuffleVector(Constant *V1, Constant *V2, Constant *Mask);
 885   static Constant *getExtractValue(Constant *Agg,
 886                                    const unsigned *IdxList, unsigned NumIdx);
 887   static Constant *getInsertValue(Constant *Agg, Constant *Val,
 888                                   const unsigned *IdxList, unsigned NumIdx);
 889
 890   /// isNullValue - Return true if this is the value that would be returned by
 891   /// getNullValue.
 892   virtual bool isNullValue() const { return false; }
 893
 894   /// getOpcode - Return the opcode at the root of this constant expression
 895   unsigned getOpcode() const { return getSubclassDataFromValue(); }
 896
 897   /// getPredicate - Return the ICMP or FCMP predicate value. Assert if this is
 898   /// not an ICMP or FCMP constant expression.
 899   unsigned getPredicate() const;
 900
 901   /// getIndices - Assert that this is an insertvalue or exactvalue
 902   /// expression and return the list of indices.
 903   ArrayRef<unsigned> getIndices() const;
 904
 905   /// getOpcodeName - Return a string representation for an opcode.
 906   const char *getOpcodeName() const;
 907
 908   /// getWithOperandReplaced - Return a constant expression identical to this
 909   /// one, but with the specified operand set to the specified value.
 910   Constant *getWithOperandReplaced(unsigned OpNo, Constant *Op) const;
 911
 912   /// getWithOperands - This returns the current constant expression with the
 913   /// operands replaced with the specified values.  The specified operands must
 914   /// match count and type with the existing ones.
 915   Constant *getWithOperands(ArrayRef<Constant*> Ops) const;
 916
 917   virtual void destroyConstant();
 918   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
 919
 920   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 921   static inline bool classof(const ConstantExpr *) { return true; }
 922   static inline bool classof(const Value *V) {
 923     return V->getValueID() == ConstantExprVal;
 924   }
 925
 926 private:
 927   // Shadow Value::setValueSubclassData with a private forwarding method so that
 928   // subclasses cannot accidentally use it.
 929   void setValueSubclassData(unsigned short D) {
 930     Value::setValueSubclassData(D);
 931   }
 932 };
 933
 934 template <>
 935 struct OperandTraits<ConstantExpr> :
 936   public VariadicOperandTraits<ConstantExpr, 1> {
 937 };
 938
 939 DEFINE_TRANSPARENT_CASTED_OPERAND_ACCESSORS(ConstantExpr, Constant)
 940
 941 //===----------------------------------------------------------------------===//
 942 /// UndefValue - 'undef' values are things that do not have specified contents.
 943 /// These are used for a variety of purposes, including global variable
 944 /// initializers and operands to instructions.  'undef' values can occur with
 945 /// any first-class type.
 946 ///
 947 /// Undef values aren't exactly constants; if they have multiple uses, they
 948 /// can appear to have different bit patterns at each use. See
 949 /// LangRef.html#undefvalues for details.
 950 ///
 951 class UndefValue : public Constant {
 952   friend struct ConstantCreator<UndefValue, Type, char>;
 953   void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
 954   UndefValue(const UndefValue &);      // DO NOT IMPLEMENT
 955 protected:
 956   explicit UndefValue(const Type *T) : Constant(T, UndefValueVal, 0, 0) {}
 957 protected:
 958   // allocate space for exactly zero operands
 959   void *operator new(size_t s) {
 960     return User::operator new(s, 0);
 961   }
 962 public:
 963   /// get() - Static factory methods - Return an 'undef' object of the specified
 964   /// type.
 965   ///
 966   static UndefValue *get(const Type *T);
 967
 968   /// isNullValue - Return true if this is the value that would be returned by
 969   /// getNullValue.
 970   virtual bool isNullValue() const { return false; }
 971
 972   virtual void destroyConstant();
 973
 974   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 975   static inline bool classof(const UndefValue *) { return true; }
 976   static bool classof(const Value *V) {
 977     return V->getValueID() == UndefValueVal;
 978   }
 979 };
 980
 981 } // End llvm namespace
 982
 983 #endif