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