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