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 class SequentialType;
  38
  39 template<class ConstantClass, class TypeClass, class ValType>
  40 struct ConstantCreator;
  41 template<class ConstantClass, class TypeClass>
  42 struct ConvertConstantType;
  43
  44 //===----------------------------------------------------------------------===//
  45 /// This is the shared class of boolean and integer constants. This class
  46 /// represents both boolean and integral constants.
  47 /// @brief Class for constant integers.
  48 class ConstantInt : public Constant {
  49   virtual void anchor();
  50   void *operator new(size_t, unsigned);  // DO NOT IMPLEMENT
  51   ConstantInt(const ConstantInt &);      // DO NOT IMPLEMENT
  52   ConstantInt(IntegerType *Ty, const APInt& V);
  53   APInt Val;
  54 protected:
  55   // allocate space for exactly zero operands
  56   void *operator new(size_t s) {
  57     return User::operator new(s, 0);
  58   }
  59 public:
  60   static ConstantInt *getTrue(LLVMContext &Context);
  61   static ConstantInt *getFalse(LLVMContext &Context);
  62   static Constant *getTrue(Type *Ty);
  63   static Constant *getFalse(Type *Ty);
  64
  65   /// If Ty is a vector type, return a Constant with a splat of the given
  66   /// value. Otherwise return a ConstantInt for the given value.
  67   static Constant *get(Type *Ty, uint64_t V, bool isSigned = false);
  68
  69   /// Return a ConstantInt with the specified integer value for the specified
  70   /// type. If the type is wider than 64 bits, the value will be zero-extended
  71   /// to fit the type, unless isSigned is true, in which case the value will
  72   /// be interpreted as a 64-bit signed integer and sign-extended to fit
  73   /// the type.
  74   /// @brief Get a ConstantInt for a specific value.
  75   static ConstantInt *get(IntegerType *Ty, uint64_t V,
  76                           bool isSigned = false);
  77
  78   /// Return a ConstantInt with the specified value for the specified type. The
  79   /// value V will be canonicalized to a an unsigned APInt. Accessing it with
  80   /// either getSExtValue() or getZExtValue() will yield a correctly sized and
  81   /// signed value for the type Ty.
  82   /// @brief Get a ConstantInt for a specific signed value.
  83   static ConstantInt *getSigned(IntegerType *Ty, int64_t V);
  84   static Constant *getSigned(Type *Ty, int64_t V);
  85
  86   /// Return a ConstantInt with the specified value and an implied Type. The
  87   /// type is the integer type that corresponds to the bit width of the value.
  88   static ConstantInt *get(LLVMContext &Context, const APInt &V);
  89
  90   /// Return a ConstantInt constructed from the string strStart with the given
  91   /// radix.
  92   static ConstantInt *get(IntegerType *Ty, StringRef Str,
  93                           uint8_t radix);
  94
  95   /// If Ty is a vector type, return a Constant with a splat of the given
  96   /// value. Otherwise return a ConstantInt for the given value.
  97   static Constant *get(Type* Ty, const APInt& V);
  98
  99   /// Return the constant as an APInt value reference. This allows clients to
 100   /// obtain a copy of the value, with all its precision in tact.
 101   /// @brief Return the constant's value.
 102   inline const APInt &getValue() const {
 103     return Val;
 104   }
 105
 106   /// getBitWidth - Return the bitwidth of this constant.
 107   unsigned getBitWidth() const { return Val.getBitWidth(); }
 108
 109   /// Return the constant as a 64-bit unsigned integer value after it
 110   /// has been zero extended as appropriate for the type of this constant. Note
 111   /// that this method can assert if the value does not fit in 64 bits.
 112   /// @deprecated
 113   /// @brief Return the zero extended value.
 114   inline uint64_t getZExtValue() const {
 115     return Val.getZExtValue();
 116   }
 117
 118   /// Return the constant as a 64-bit integer value after it has been sign
 119   /// extended as appropriate for the type of this constant. Note that
 120   /// this method can assert if the value does not fit in 64 bits.
 121   /// @deprecated
 122   /// @brief Return the sign extended value.
 123   inline int64_t getSExtValue() const {
 124     return Val.getSExtValue();
 125   }
 126
 127   /// A helper method that can be used to determine if the constant contained
 128   /// within is equal to a constant.  This only works for very small values,
 129   /// because this is all that can be represented with all types.
 130   /// @brief Determine if this constant's value is same as an unsigned char.
 131   bool equalsInt(uint64_t V) const {
 132     return Val == V;
 133   }
 134
 135   /// getType - Specialize the getType() method to always return an IntegerType,
 136   /// which reduces the amount of casting needed in parts of the compiler.
 137   ///
 138   inline IntegerType *getType() const {
 139     return reinterpret_cast<IntegerType*>(Value::getType());
 140   }
 141
 142   /// This static method returns true if the type Ty is big enough to
 143   /// represent the value V. This can be used to avoid having the get method
 144   /// assert when V is larger than Ty can represent. Note that there are two
 145   /// versions of this method, one for unsigned and one for signed integers.
 146   /// Although ConstantInt canonicalizes everything to an unsigned integer,
 147   /// the signed version avoids callers having to convert a signed quantity
 148   /// to the appropriate unsigned type before calling the method.
 149   /// @returns true if V is a valid value for type Ty
 150   /// @brief Determine if the value is in range for the given type.
 151   static bool isValueValidForType(Type *Ty, uint64_t V);
 152   static bool isValueValidForType(Type *Ty, int64_t V);
 153
 154   bool isNegative() const { return Val.isNegative(); }
 155
 156   /// This is just a convenience method to make client code smaller for a
 157   /// common code. It also correctly performs the comparison without the
 158   /// potential for an assertion from getZExtValue().
 159   bool isZero() const {
 160     return Val == 0;
 161   }
 162
 163   /// This is just a convenience method to make client code smaller for a
 164   /// common case. It also correctly performs the comparison without the
 165   /// potential for an assertion from getZExtValue().
 166   /// @brief Determine if the value is one.
 167   bool isOne() const {
 168     return Val == 1;
 169   }
 170
 171   /// This function will return true iff every bit in this constant is set
 172   /// to true.
 173   /// @returns true iff this constant's bits are all set to true.
 174   /// @brief Determine if the value is all ones.
 175   bool isMinusOne() const {
 176     return Val.isAllOnesValue();
 177   }
 178
 179   /// This function will return true iff this constant represents the largest
 180   /// value that may be represented by the constant's type.
 181   /// @returns true iff this is the largest value that may be represented
 182   /// by this type.
 183   /// @brief Determine if the value is maximal.
 184   bool isMaxValue(bool isSigned) const {
 185     if (isSigned)
 186       return Val.isMaxSignedValue();
 187     else
 188       return Val.isMaxValue();
 189   }
 190
 191   /// This function will return true iff this constant represents the smallest
 192   /// value that may be represented by this constant's type.
 193   /// @returns true if this is the smallest value that may be represented by
 194   /// this type.
 195   /// @brief Determine if the value is minimal.
 196   bool isMinValue(bool isSigned) const {
 197     if (isSigned)
 198       return Val.isMinSignedValue();
 199     else
 200       return Val.isMinValue();
 201   }
 202
 203   /// This function will return true iff this constant represents a value with
 204   /// active bits bigger than 64 bits or a value greater than the given uint64_t
 205   /// value.
 206   /// @returns true iff this constant is greater or equal to the given number.
 207   /// @brief Determine if the value is greater or equal to the given number.
 208   bool uge(uint64_t Num) const {
 209     return Val.getActiveBits() > 64 || Val.getZExtValue() >= Num;
 210   }
 211
 212   /// getLimitedValue - If the value is smaller than the specified limit,
 213   /// return it, otherwise return the limit value.  This causes the value
 214   /// to saturate to the limit.
 215   /// @returns the min of the value of the constant and the specified value
 216   /// @brief Get the constant's value with a saturation limit
 217   uint64_t getLimitedValue(uint64_t Limit = ~0ULL) const {
 218     return Val.getLimitedValue(Limit);
 219   }
 220
 221   /// @brief Methods to support type inquiry through isa, cast, and dyn_cast.
 222   static inline bool classof(const ConstantInt *) { return true; }
 223   static bool classof(const Value *V) {
 224     return V->getValueID() == ConstantIntVal;
 225   }
 226 };
 227
 228
 229 //===----------------------------------------------------------------------===//
 230 /// ConstantFP - Floating Point Values [float, double]
 231 ///
 232 class ConstantFP : public Constant {
 233   APFloat Val;
 234   virtual void anchor();
 235   void *operator new(size_t, unsigned);// DO NOT IMPLEMENT
 236   ConstantFP(const ConstantFP &);      // DO NOT IMPLEMENT
 237   friend class LLVMContextImpl;
 238 protected:
 239   ConstantFP(Type *Ty, const APFloat& V);
 240 protected:
 241   // allocate space for exactly zero operands
 242   void *operator new(size_t s) {
 243     return User::operator new(s, 0);
 244   }
 245 public:
 246   /// Floating point negation must be implemented with f(x) = -0.0 - x. This
 247   /// method returns the negative zero constant for floating point or vector
 248   /// floating point types; for all other types, it returns the null value.
 249   static Constant *getZeroValueForNegation(Type *Ty);
 250
 251   /// get() - This returns a ConstantFP, or a vector containing a splat of a
 252   /// ConstantFP, for the specified value in the specified type.  This should
 253   /// only be used for simple constant values like 2.0/1.0 etc, that are
 254   /// known-valid both as host double and as the target format.
 255   static Constant *get(Type* Ty, double V);
 256   static Constant *get(Type* Ty, StringRef Str);
 257   static ConstantFP *get(LLVMContext &Context, const APFloat &V);
 258   static ConstantFP *getNegativeZero(Type* Ty);
 259   static ConstantFP *getInfinity(Type *Ty, bool Negative = false);
 260
 261   /// isValueValidForType - return true if Ty is big enough to represent V.
 262   static bool isValueValidForType(Type *Ty, const APFloat &V);
 263   inline const APFloat &getValueAPF() const { return Val; }
 264
 265   /// isZero - Return true if the value is positive or negative zero.
 266   bool isZero() const { return Val.isZero(); }
 267
 268   /// isNegative - Return true if the sign bit is set.
 269   bool isNegative() const { return Val.isNegative(); }
 270
 271   /// isNaN - Return true if the value is a NaN.
 272   bool isNaN() const { return Val.isNaN(); }
 273
 274   /// isExactlyValue - We don't rely on operator== working on double values, as
 275   /// it returns true for things that are clearly not equal, like -0.0 and 0.0.
 276   /// As such, this method can be used to do an exact bit-for-bit comparison of
 277   /// two floating point values.  The version with a double operand is retained
 278   /// because it's so convenient to write isExactlyValue(2.0), but please use
 279   /// it only for simple constants.
 280   bool isExactlyValue(const APFloat &V) const;
 281
 282   bool isExactlyValue(double V) const {
 283     bool ignored;
 284     // convert is not supported on this type
 285     if (&Val.getSemantics() == &APFloat::PPCDoubleDouble)
 286       return false;
 287     APFloat FV(V);
 288     FV.convert(Val.getSemantics(), APFloat::rmNearestTiesToEven, &ignored);
 289     return isExactlyValue(FV);
 290   }
 291   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 292   static inline bool classof(const ConstantFP *) { return true; }
 293   static bool classof(const Value *V) {
 294     return V->getValueID() == ConstantFPVal;
 295   }
 296 };
 297
 298 //===----------------------------------------------------------------------===//
 299 /// ConstantAggregateZero - All zero aggregate value
 300 ///
 301 class ConstantAggregateZero : public Constant {
 302   void *operator new(size_t, unsigned);                      // DO NOT IMPLEMENT
 303   ConstantAggregateZero(const ConstantAggregateZero &);      // DO NOT IMPLEMENT
 304 protected:
 305   explicit ConstantAggregateZero(Type *ty)
 306     : Constant(ty, ConstantAggregateZeroVal, 0, 0) {}
 307 protected:
 308   // allocate space for exactly zero operands
 309   void *operator new(size_t s) {
 310     return User::operator new(s, 0);
 311   }
 312 public:
 313   static ConstantAggregateZero *get(Type *Ty);
 314
 315   virtual void destroyConstant();
 316
 317   /// getSequentialElement - If this CAZ has array or vector type, return a zero
 318   /// with the right element type.
 319   Constant *getSequentialElement();
 320
 321   /// getStructElement - If this CAZ has struct type, return a zero with the
 322   /// right element type for the specified element.
 323   Constant *getStructElement(unsigned Elt);
 324
 325   /// getElementValue - Return a zero of the right value for the specified GEP
 326   /// index.
 327   Constant *getElementValue(Constant *C);
 328
 329   /// getElementValue - Return a zero of the right value for the specified GEP
 330   /// index.
 331   Constant *getElementValue(unsigned Idx);
 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(ArrayType *T, ArrayRef<Constant *> Val);
 351 public:
 352   // ConstantArray accessors
 353   static Constant *get(ArrayType *T, ArrayRef<Constant*> V);
 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 ArrayType *getType() const {
 371     return reinterpret_cast<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   /// getAsCString - If this array is isCString(), then this method converts the
 391   /// array (without the trailing null byte) to an std::string and returns it.
 392   /// Otherwise, it asserts out.
 393   ///
 394   std::string getAsCString() const;
 395
 396   virtual void destroyConstant();
 397   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
 398
 399   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 400   static inline bool classof(const ConstantArray *) { return true; }
 401   static bool classof(const Value *V) {
 402     return V->getValueID() == ConstantArrayVal;
 403   }
 404 };
 405
 406 template <>
 407 struct OperandTraits<ConstantArray> :
 408   public VariadicOperandTraits<ConstantArray> {
 409 };
 410
 411 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ConstantArray, Constant)
 412
 413 //===----------------------------------------------------------------------===//
 414 // ConstantStruct - Constant Struct Declarations
 415 //
 416 class ConstantStruct : public Constant {
 417   friend struct ConstantCreator<ConstantStruct, StructType,
 418                                     std::vector<Constant*> >;
 419   ConstantStruct(const ConstantStruct &);      // DO NOT IMPLEMENT
 420 protected:
 421   ConstantStruct(StructType *T, ArrayRef<Constant *> Val);
 422 public:
 423   // ConstantStruct accessors
 424   static Constant *get(StructType *T, ArrayRef<Constant*> V);
 425   static Constant *get(StructType *T, ...) END_WITH_NULL;
 426
 427   /// getAnon - Return an anonymous struct that has the specified
 428   /// elements.  If the struct is possibly empty, then you must specify a
 429   /// context.
 430   static Constant *getAnon(ArrayRef<Constant*> V, bool Packed = false) {
 431     return get(getTypeForElements(V, Packed), V);
 432   }
 433   static Constant *getAnon(LLVMContext &Ctx,
 434                            ArrayRef<Constant*> V, bool Packed = false) {
 435     return get(getTypeForElements(Ctx, V, Packed), V);
 436   }
 437
 438   /// getTypeForElements - Return an anonymous struct type to use for a constant
 439   /// with the specified set of elements.  The list must not be empty.
 440   static StructType *getTypeForElements(ArrayRef<Constant*> V,
 441                                         bool Packed = false);
 442   /// getTypeForElements - This version of the method allows an empty list.
 443   static StructType *getTypeForElements(LLVMContext &Ctx,
 444                                         ArrayRef<Constant*> V,
 445                                         bool Packed = false);
 446
 447   /// Transparently provide more efficient getOperand methods.
 448   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
 449
 450   /// getType() specialization - Reduce amount of casting...
 451   ///
 452   inline StructType *getType() const {
 453     return reinterpret_cast<StructType*>(Value::getType());
 454   }
 455
 456   virtual void destroyConstant();
 457   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
 458
 459   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 460   static inline bool classof(const ConstantStruct *) { return true; }
 461   static bool classof(const Value *V) {
 462     return V->getValueID() == ConstantStructVal;
 463   }
 464 };
 465
 466 template <>
 467 struct OperandTraits<ConstantStruct> :
 468   public VariadicOperandTraits<ConstantStruct> {
 469 };
 470
 471 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ConstantStruct, Constant)
 472
 473
 474 //===----------------------------------------------------------------------===//
 475 /// ConstantVector - Constant Vector Declarations
 476 ///
 477 class ConstantVector : public Constant {
 478   friend struct ConstantCreator<ConstantVector, VectorType,
 479                                     std::vector<Constant*> >;
 480   ConstantVector(const ConstantVector &);      // DO NOT IMPLEMENT
 481 protected:
 482   ConstantVector(VectorType *T, ArrayRef<Constant *> Val);
 483 public:
 484   // ConstantVector accessors
 485   static Constant *get(ArrayRef<Constant*> V);
 486
 487   /// Transparently provide more efficient getOperand methods.
 488   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
 489
 490   /// getType - Specialize the getType() method to always return a VectorType,
 491   /// which reduces the amount of casting needed in parts of the compiler.
 492   ///
 493   inline VectorType *getType() const {
 494     return reinterpret_cast<VectorType*>(Value::getType());
 495   }
 496
 497   /// getSplatValue - If this is a splat constant, meaning that all of the
 498   /// elements have the same value, return that value. Otherwise return NULL.
 499   Constant *getSplatValue() const;
 500
 501   virtual void destroyConstant();
 502   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
 503
 504   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 505   static inline bool classof(const ConstantVector *) { return true; }
 506   static bool classof(const Value *V) {
 507     return V->getValueID() == ConstantVectorVal;
 508   }
 509 };
 510
 511 template <>
 512 struct OperandTraits<ConstantVector> :
 513   public VariadicOperandTraits<ConstantVector> {
 514 };
 515
 516 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ConstantVector, Constant)
 517
 518 //===----------------------------------------------------------------------===//
 519 /// ConstantPointerNull - a constant pointer value that points to null
 520 ///
 521 class ConstantPointerNull : public Constant {
 522   void *operator new(size_t, unsigned);                  // DO NOT IMPLEMENT
 523   ConstantPointerNull(const ConstantPointerNull &);      // DO NOT IMPLEMENT
 524 protected:
 525   explicit ConstantPointerNull(PointerType *T)
 526     : Constant(reinterpret_cast<Type*>(T),
 527                Value::ConstantPointerNullVal, 0, 0) {}
 528
 529 protected:
 530   // allocate space for exactly zero operands
 531   void *operator new(size_t s) {
 532     return User::operator new(s, 0);
 533   }
 534 public:
 535   /// get() - Static factory methods - Return objects of the specified value
 536   static ConstantPointerNull *get(PointerType *T);
 537
 538   virtual void destroyConstant();
 539
 540   /// getType - Specialize the getType() method to always return an PointerType,
 541   /// which reduces the amount of casting needed in parts of the compiler.
 542   ///
 543   inline PointerType *getType() const {
 544     return reinterpret_cast<PointerType*>(Value::getType());
 545   }
 546
 547   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 548   static inline bool classof(const ConstantPointerNull *) { return true; }
 549   static bool classof(const Value *V) {
 550     return V->getValueID() == ConstantPointerNullVal;
 551   }
 552 };
 553
 554 //===----------------------------------------------------------------------===//
 555 /// ConstantDataSequential - A vector or array of data that contains no
 556 /// relocations, and whose element type is a simple 1/2/4/8-byte integer or
 557 /// float/double.  This is the common base class of ConstantDataArray and
 558 /// ConstantDataVector.
 559 ///
 560 class ConstantDataSequential : public Constant {
 561   friend class LLVMContextImpl;
 562   /// DataElements - A pointer to the bytes underlying this constant (which is
 563   /// owned by the uniquing StringMap).
 564   const char *DataElements;
 565
 566   /// Next - This forms a link list of ConstantDataSequential nodes that have
 567   /// the same value but different type.  For example, 0,0,0,1 could be a 4
 568   /// element array of i8, or a 1-element array of i32.  They'll both end up in
 569   /// the same StringMap bucket, linked up.
 570   ConstantDataSequential *Next;
 571   void *operator new(size_t, unsigned);                      // DO NOT IMPLEMENT
 572   ConstantDataSequential(const ConstantDataSequential &);    // DO NOT IMPLEMENT
 573 protected:
 574   explicit ConstantDataSequential(Type *ty, ValueTy VT, const char *Data)
 575     : Constant(ty, VT, 0, 0), DataElements(Data) {}
 576   ~ConstantDataSequential() { delete Next; }
 577
 578   static Constant *getImpl(StringRef Bytes, Type *Ty);
 579
 580 protected:
 581   // allocate space for exactly zero operands.
 582   void *operator new(size_t s) {
 583     return User::operator new(s, 0);
 584   }
 585 public:
 586
 587   /// isElementTypeCompatible - Return true if a ConstantDataSequential can be
 588   /// formed with a vector or array of the specified element type.
 589   /// ConstantDataArray only works with normal float and int types that are
 590   /// stored densely in memory, not with things like i42 or x86_f80.
 591   static bool isElementTypeCompatible(const Type *Ty);
 592
 593   /// getElementAsInteger - If this is a sequential container of integers (of
 594   /// any size), return the specified element in the low bits of a uint64_t.
 595   uint64_t getElementAsInteger(unsigned i) const;
 596
 597   /// getElementAsAPFloat - If this is a sequential container of floating point
 598   /// type, return the specified element as an APFloat.
 599   APFloat getElementAsAPFloat(unsigned i) const;
 600
 601   /// getElementAsFloat - If this is an sequential container of floats, return
 602   /// the specified element as a float.
 603   float getElementAsFloat(unsigned i) const;
 604
 605   /// getElementAsDouble - If this is an sequential container of doubles, return
 606   /// the specified element as a float.
 607   double getElementAsDouble(unsigned i) const;
 608
 609   /// getElementAsConstant - Return a Constant for a specified index's element.
 610   /// Note that this has to compute a new constant to return, so it isn't as
 611   /// efficient as getElementAsInteger/Float/Double.
 612   Constant *getElementAsConstant(unsigned i) const;
 613
 614   /// getType - Specialize the getType() method to always return a
 615   /// SequentialType, which reduces the amount of casting needed in parts of the
 616   /// compiler.
 617   inline SequentialType *getType() const {
 618     return reinterpret_cast<SequentialType*>(Value::getType());
 619   }
 620
 621   /// getElementType - Return the element type of the array/vector.
 622   Type *getElementType() const;
 623
 624   /// getElementByteSize - Return the size (in bytes) of each element in the
 625   /// array/vector.  The size of the elements is known to be a multiple of one
 626   /// byte.
 627   uint64_t getElementByteSize() const;
 628
 629   virtual void destroyConstant();
 630
 631   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 632   ///
 633   static bool classof(const ConstantDataSequential *) { return true; }
 634   static bool classof(const Value *V) {
 635     return V->getValueID() == ConstantDataArrayVal ||
 636            V->getValueID() == ConstantDataVectorVal;
 637   }
 638 private:
 639   const char *getElementPointer(unsigned Elt) const;
 640 };
 641
 642 //===----------------------------------------------------------------------===//
 643 /// ConstantDataArray - An array of data that contains no relocations, and whose
 644 /// element type is a simple 1/2/4/8-byte integer or float/double.
 645 ///
 646 class ConstantDataArray : public ConstantDataSequential {
 647   void *operator new(size_t, unsigned);            // DO NOT IMPLEMENT
 648   ConstantDataArray(const ConstantDataArray &);    // DO NOT IMPLEMENT
 649   virtual void anchor();
 650   friend class ConstantDataSequential;
 651   explicit ConstantDataArray(Type *ty, const char *Data)
 652     : ConstantDataSequential(ty, ConstantDataArrayVal, Data) {}
 653 protected:
 654   // allocate space for exactly zero operands.
 655   void *operator new(size_t s) {
 656     return User::operator new(s, 0);
 657   }
 658 public:
 659
 660   /// get() constructors - Return a constant with array type with an element
 661   /// count and element type matching the ArrayRef passed in.  Note that this
 662   /// can return a ConstantAggregateZero object.
 663   static Constant *get(ArrayRef<uint8_t> Elts, LLVMContext &Context);
 664   static Constant *get(ArrayRef<uint16_t> Elts, LLVMContext &Context);
 665   static Constant *get(ArrayRef<uint32_t> Elts, LLVMContext &Context);
 666   static Constant *get(ArrayRef<uint64_t> Elts, LLVMContext &Context);
 667   static Constant *get(ArrayRef<float> Elts, LLVMContext &Context);
 668   static Constant *get(ArrayRef<double> Elts, LLVMContext &Context);
 669
 670   /// getType - Specialize the getType() method to always return an ArrayType,
 671   /// which reduces the amount of casting needed in parts of the compiler.
 672   ///
 673   inline ArrayType *getType() const {
 674     return reinterpret_cast<ArrayType*>(Value::getType());
 675   }
 676
 677   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 678   ///
 679   static bool classof(const ConstantDataArray *) { return true; }
 680   static bool classof(const Value *V) {
 681     return V->getValueID() == ConstantDataArrayVal;
 682   }
 683 };
 684
 685 //===----------------------------------------------------------------------===//
 686 /// ConstantDataVector - A vector of data that contains no relocations, and
 687 /// whose element type is a simple 1/2/4/8-byte integer or float/double.
 688 ///
 689 class ConstantDataVector : public ConstantDataSequential {
 690   void *operator new(size_t, unsigned);              // DO NOT IMPLEMENT
 691   ConstantDataVector(const ConstantDataVector &);    // DO NOT IMPLEMENT
 692   virtual void anchor();
 693   friend class ConstantDataSequential;
 694   explicit ConstantDataVector(Type *ty, const char *Data)
 695   : ConstantDataSequential(ty, ConstantDataVectorVal, Data) {}
 696 protected:
 697   // allocate space for exactly zero operands.
 698   void *operator new(size_t s) {
 699     return User::operator new(s, 0);
 700   }
 701 public:
 702
 703   /// get() constructors - Return a constant with vector type with an element
 704   /// count and element type matching the ArrayRef passed in.  Note that this
 705   /// can return a ConstantAggregateZero object.
 706   static Constant *get(ArrayRef<uint8_t> Elts, LLVMContext &Context);
 707   static Constant *get(ArrayRef<uint16_t> Elts, LLVMContext &Context);
 708   static Constant *get(ArrayRef<uint32_t> Elts, LLVMContext &Context);
 709   static Constant *get(ArrayRef<uint64_t> Elts, LLVMContext &Context);
 710   static Constant *get(ArrayRef<float> Elts, LLVMContext &Context);
 711   static Constant *get(ArrayRef<double> Elts, LLVMContext &Context);
 712
 713   /// getType - Specialize the getType() method to always return a VectorType,
 714   /// which reduces the amount of casting needed in parts of the compiler.
 715   ///
 716   inline VectorType *getType() const {
 717     return reinterpret_cast<VectorType*>(Value::getType());
 718   }
 719
 720   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 721   ///
 722   static bool classof(const ConstantDataVector *) { return true; }
 723   static bool classof(const Value *V) {
 724     return V->getValueID() == ConstantDataVectorVal;
 725   }
 726 };
 727
 728
 729
 730 /// BlockAddress - The address of a basic block.
 731 ///
 732 class BlockAddress : public Constant {
 733   void *operator new(size_t, unsigned);                  // DO NOT IMPLEMENT
 734   void *operator new(size_t s) { return User::operator new(s, 2); }
 735   BlockAddress(Function *F, BasicBlock *BB);
 736 public:
 737   /// get - Return a BlockAddress for the specified function and basic block.
 738   static BlockAddress *get(Function *F, BasicBlock *BB);
 739
 740   /// get - Return a BlockAddress for the specified basic block.  The basic
 741   /// block must be embedded into a function.
 742   static BlockAddress *get(BasicBlock *BB);
 743
 744   /// Transparently provide more efficient getOperand methods.
 745   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 746
 747   Function *getFunction() const { return (Function*)Op<0>().get(); }
 748   BasicBlock *getBasicBlock() const { return (BasicBlock*)Op<1>().get(); }
 749
 750   virtual void destroyConstant();
 751   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
 752
 753   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 754   static inline bool classof(const BlockAddress *) { return true; }
 755   static inline bool classof(const Value *V) {
 756     return V->getValueID() == BlockAddressVal;
 757   }
 758 };
 759
 760 template <>
 761 struct OperandTraits<BlockAddress> :
 762   public FixedNumOperandTraits<BlockAddress, 2> {
 763 };
 764
 765 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BlockAddress, Value)
 766
 767
 768 //===----------------------------------------------------------------------===//
 769 /// ConstantExpr - a constant value that is initialized with an expression using
 770 /// other constant values.
 771 ///
 772 /// This class uses the standard Instruction opcodes to define the various
 773 /// constant expressions.  The Opcode field for the ConstantExpr class is
 774 /// maintained in the Value::SubclassData field.
 775 class ConstantExpr : public Constant {
 776   friend struct ConstantCreator<ConstantExpr,Type,
 777                             std::pair<unsigned, std::vector<Constant*> > >;
 778   friend struct ConvertConstantType<ConstantExpr, Type>;
 779
 780 protected:
 781   ConstantExpr(Type *ty, unsigned Opcode, Use *Ops, unsigned NumOps)
 782     : Constant(ty, ConstantExprVal, Ops, NumOps) {
 783     // Operation type (an Instruction opcode) is stored as the SubclassData.
 784     setValueSubclassData(Opcode);
 785   }
 786
 787 public:
 788   // Static methods to construct a ConstantExpr of different kinds.  Note that
 789   // these methods may return a object that is not an instance of the
 790   // ConstantExpr class, because they will attempt to fold the constant
 791   // expression into something simpler if possible.
 792
 793   /// getAlignOf constant expr - computes the alignment of a type in a target
 794   /// independent way (Note: the return type is an i64).
 795   static Constant *getAlignOf(Type *Ty);
 796
 797   /// getSizeOf constant expr - computes the (alloc) size of a type (in
 798   /// address-units, not bits) in a target independent way (Note: the return
 799   /// type is an i64).
 800   ///
 801   static Constant *getSizeOf(Type *Ty);
 802
 803   /// getOffsetOf constant expr - computes the offset of a struct field in a
 804   /// target independent way (Note: the return type is an i64).
 805   ///
 806   static Constant *getOffsetOf(StructType *STy, unsigned FieldNo);
 807
 808   /// getOffsetOf constant expr - This is a generalized form of getOffsetOf,
 809   /// which supports any aggregate type, and any Constant index.
 810   ///
 811   static Constant *getOffsetOf(Type *Ty, Constant *FieldNo);
 812
 813   static Constant *getNeg(Constant *C, bool HasNUW = false, bool HasNSW =false);
 814   static Constant *getFNeg(Constant *C);
 815   static Constant *getNot(Constant *C);
 816   static Constant *getAdd(Constant *C1, Constant *C2,
 817                           bool HasNUW = false, bool HasNSW = false);
 818   static Constant *getFAdd(Constant *C1, Constant *C2);
 819   static Constant *getSub(Constant *C1, Constant *C2,
 820                           bool HasNUW = false, bool HasNSW = false);
 821   static Constant *getFSub(Constant *C1, Constant *C2);
 822   static Constant *getMul(Constant *C1, Constant *C2,
 823                           bool HasNUW = false, bool HasNSW = false);
 824   static Constant *getFMul(Constant *C1, Constant *C2);
 825   static Constant *getUDiv(Constant *C1, Constant *C2, bool isExact = false);
 826   static Constant *getSDiv(Constant *C1, Constant *C2, bool isExact = false);
 827   static Constant *getFDiv(Constant *C1, Constant *C2);
 828   static Constant *getURem(Constant *C1, Constant *C2);
 829   static Constant *getSRem(Constant *C1, Constant *C2);
 830   static Constant *getFRem(Constant *C1, Constant *C2);
 831   static Constant *getAnd(Constant *C1, Constant *C2);
 832   static Constant *getOr(Constant *C1, Constant *C2);
 833   static Constant *getXor(Constant *C1, Constant *C2);
 834   static Constant *getShl(Constant *C1, Constant *C2,
 835                           bool HasNUW = false, bool HasNSW = false);
 836   static Constant *getLShr(Constant *C1, Constant *C2, bool isExact = false);
 837   static Constant *getAShr(Constant *C1, Constant *C2, bool isExact = false);
 838   static Constant *getTrunc   (Constant *C, Type *Ty);
 839   static Constant *getSExt    (Constant *C, Type *Ty);
 840   static Constant *getZExt    (Constant *C, Type *Ty);
 841   static Constant *getFPTrunc (Constant *C, Type *Ty);
 842   static Constant *getFPExtend(Constant *C, Type *Ty);
 843   static Constant *getUIToFP  (Constant *C, Type *Ty);
 844   static Constant *getSIToFP  (Constant *C, Type *Ty);
 845   static Constant *getFPToUI  (Constant *C, Type *Ty);
 846   static Constant *getFPToSI  (Constant *C, Type *Ty);
 847   static Constant *getPtrToInt(Constant *C, Type *Ty);
 848   static Constant *getIntToPtr(Constant *C, Type *Ty);
 849   static Constant *getBitCast (Constant *C, Type *Ty);
 850
 851   static Constant *getNSWNeg(Constant *C) { return getNeg(C, false, true); }
 852   static Constant *getNUWNeg(Constant *C) { return getNeg(C, true, false); }
 853   static Constant *getNSWAdd(Constant *C1, Constant *C2) {
 854     return getAdd(C1, C2, false, true);
 855   }
 856   static Constant *getNUWAdd(Constant *C1, Constant *C2) {
 857     return getAdd(C1, C2, true, false);
 858   }
 859   static Constant *getNSWSub(Constant *C1, Constant *C2) {
 860     return getSub(C1, C2, false, true);
 861   }
 862   static Constant *getNUWSub(Constant *C1, Constant *C2) {
 863     return getSub(C1, C2, true, false);
 864   }
 865   static Constant *getNSWMul(Constant *C1, Constant *C2) {
 866     return getMul(C1, C2, false, true);
 867   }
 868   static Constant *getNUWMul(Constant *C1, Constant *C2) {
 869     return getMul(C1, C2, true, false);
 870   }
 871   static Constant *getNSWShl(Constant *C1, Constant *C2) {
 872     return getShl(C1, C2, false, true);
 873   }
 874   static Constant *getNUWShl(Constant *C1, Constant *C2) {
 875     return getShl(C1, C2, true, false);
 876   }
 877   static Constant *getExactSDiv(Constant *C1, Constant *C2) {
 878     return getSDiv(C1, C2, true);
 879   }
 880   static Constant *getExactUDiv(Constant *C1, Constant *C2) {
 881     return getUDiv(C1, C2, true);
 882   }
 883   static Constant *getExactAShr(Constant *C1, Constant *C2) {
 884     return getAShr(C1, C2, true);
 885   }
 886   static Constant *getExactLShr(Constant *C1, Constant *C2) {
 887     return getLShr(C1, C2, true);
 888   }
 889
 890   /// Transparently provide more efficient getOperand methods.
 891   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
 892
 893   // @brief Convenience function for getting one of the casting operations
 894   // using a CastOps opcode.
 895   static Constant *getCast(
 896     unsigned ops,  ///< The opcode for the conversion
 897     Constant *C,   ///< The constant to be converted
 898     Type *Ty ///< The type to which the constant is converted
 899   );
 900
 901   // @brief Create a ZExt or BitCast cast constant expression
 902   static Constant *getZExtOrBitCast(
 903     Constant *C,   ///< The constant to zext or bitcast
 904     Type *Ty ///< The type to zext or bitcast C to
 905   );
 906
 907   // @brief Create a SExt or BitCast cast constant expression
 908   static Constant *getSExtOrBitCast(
 909     Constant *C,   ///< The constant to sext or bitcast
 910     Type *Ty ///< The type to sext or bitcast C to
 911   );
 912
 913   // @brief Create a Trunc or BitCast cast constant expression
 914   static Constant *getTruncOrBitCast(
 915     Constant *C,   ///< The constant to trunc or bitcast
 916     Type *Ty ///< The type to trunc or bitcast C to
 917   );
 918
 919   /// @brief Create a BitCast or a PtrToInt cast constant expression
 920   static Constant *getPointerCast(
 921     Constant *C,   ///< The pointer value to be casted (operand 0)
 922     Type *Ty ///< The type to which cast should be made
 923   );
 924
 925   /// @brief Create a ZExt, Bitcast or Trunc for integer -> integer casts
 926   static Constant *getIntegerCast(
 927     Constant *C,    ///< The integer constant to be casted
 928     Type *Ty, ///< The integer type to cast to
 929     bool isSigned   ///< Whether C should be treated as signed or not
 930   );
 931
 932   /// @brief Create a FPExt, Bitcast or FPTrunc for fp -> fp casts
 933   static Constant *getFPCast(
 934     Constant *C,    ///< The integer constant to be casted
 935     Type *Ty ///< The integer type to cast to
 936   );
 937
 938   /// @brief Return true if this is a convert constant expression
 939   bool isCast() const;
 940
 941   /// @brief Return true if this is a compare constant expression
 942   bool isCompare() const;
 943
 944   /// @brief Return true if this is an insertvalue or extractvalue expression,
 945   /// and the getIndices() method may be used.
 946   bool hasIndices() const;
 947
 948   /// @brief Return true if this is a getelementptr expression and all
 949   /// the index operands are compile-time known integers within the
 950   /// corresponding notional static array extents. Note that this is
 951   /// not equivalant to, a subset of, or a superset of the "inbounds"
 952   /// property.
 953   bool isGEPWithNoNotionalOverIndexing() const;
 954
 955   /// Select constant expr
 956   ///
 957   static Constant *getSelect(Constant *C, Constant *V1, Constant *V2);
 958
 959   /// get - Return a binary or shift operator constant expression,
 960   /// folding if possible.
 961   ///
 962   static Constant *get(unsigned Opcode, Constant *C1, Constant *C2,
 963                        unsigned Flags = 0);
 964
 965   /// @brief Return an ICmp or FCmp comparison operator constant expression.
 966   static Constant *getCompare(unsigned short pred, Constant *C1, Constant *C2);
 967
 968   /// get* - Return some common constants without having to
 969   /// specify the full Instruction::OPCODE identifier.
 970   ///
 971   static Constant *getICmp(unsigned short pred, Constant *LHS, Constant *RHS);
 972   static Constant *getFCmp(unsigned short pred, Constant *LHS, Constant *RHS);
 973
 974   /// Getelementptr form.  Value* is only accepted for convenience;
 975   /// all elements must be Constant's.
 976   ///
 977   static Constant *getGetElementPtr(Constant *C,
 978                                     ArrayRef<Constant *> IdxList,
 979                                     bool InBounds = false) {
 980     return getGetElementPtr(C, makeArrayRef((Value * const *)IdxList.data(),
 981                                             IdxList.size()),
 982                             InBounds);
 983   }
 984   static Constant *getGetElementPtr(Constant *C,
 985                                     Constant *Idx,
 986                                     bool InBounds = false) {
 987     // This form of the function only exists to avoid ambiguous overload
 988     // warnings about whether to convert Idx to ArrayRef<Constant *> or
 989     // ArrayRef<Value *>.
 990     return getGetElementPtr(C, cast<Value>(Idx), InBounds);
 991   }
 992   static Constant *getGetElementPtr(Constant *C,
 993                                     ArrayRef<Value *> IdxList,
 994                                     bool InBounds = false);
 995
 996   /// Create an "inbounds" getelementptr. See the documentation for the
 997   /// "inbounds" flag in LangRef.html for details.
 998   static Constant *getInBoundsGetElementPtr(Constant *C,
 999                                             ArrayRef<Constant *> IdxList) {
1000     return getGetElementPtr(C, IdxList, true);
1001   }
1002   static Constant *getInBoundsGetElementPtr(Constant *C,
1003                                             Constant *Idx) {
1004     // This form of the function only exists to avoid ambiguous overload
1005     // warnings about whether to convert Idx to ArrayRef<Constant *> or
1006     // ArrayRef<Value *>.
1007     return getGetElementPtr(C, Idx, true);
1008   }
1009   static Constant *getInBoundsGetElementPtr(Constant *C,
1010                                             ArrayRef<Value *> IdxList) {
1011     return getGetElementPtr(C, IdxList, true);
1012   }
1013
1014   static Constant *getExtractElement(Constant *Vec, Constant *Idx);
1015   static Constant *getInsertElement(Constant *Vec, Constant *Elt,Constant *Idx);
1016   static Constant *getShuffleVector(Constant *V1, Constant *V2, Constant *Mask);
1017   static Constant *getExtractValue(Constant *Agg, ArrayRef<unsigned> Idxs);
1018   static Constant *getInsertValue(Constant *Agg, Constant *Val,
1019                                   ArrayRef<unsigned> Idxs);
1020
1021   /// getOpcode - Return the opcode at the root of this constant expression
1022   unsigned getOpcode() const { return getSubclassDataFromValue(); }
1023
1024   /// getPredicate - Return the ICMP or FCMP predicate value. Assert if this is
1025   /// not an ICMP or FCMP constant expression.
1026   unsigned getPredicate() const;
1027
1028   /// getIndices - Assert that this is an insertvalue or exactvalue
1029   /// expression and return the list of indices.
1030   ArrayRef<unsigned> getIndices() const;
1031
1032   /// getOpcodeName - Return a string representation for an opcode.
1033   const char *getOpcodeName() const;
1034
1035   /// getWithOperandReplaced - Return a constant expression identical to this
1036   /// one, but with the specified operand set to the specified value.
1037   Constant *getWithOperandReplaced(unsigned OpNo, Constant *Op) const;
1038
1039   /// getWithOperands - This returns the current constant expression with the
1040   /// operands replaced with the specified values.  The specified array must
1041   /// have the same number of operands as our current one.
1042   Constant *getWithOperands(ArrayRef<Constant*> Ops) const {
1043     return getWithOperands(Ops, getType());
1044   }
1045
1046   /// getWithOperands - This returns the current constant expression with the
1047   /// operands replaced with the specified values and with the specified result
1048   /// type.  The specified array must have the same number of operands as our
1049   /// current one.
1050   Constant *getWithOperands(ArrayRef<Constant*> Ops, Type *Ty) const;
1051
1052   virtual void destroyConstant();
1053   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
1054
1055   /// Methods for support type inquiry through isa, cast, and dyn_cast:
1056   static inline bool classof(const ConstantExpr *) { return true; }
1057   static inline bool classof(const Value *V) {
1058     return V->getValueID() == ConstantExprVal;
1059   }
1060
1061 private:
1062   // Shadow Value::setValueSubclassData with a private forwarding method so that
1063   // subclasses cannot accidentally use it.
1064   void setValueSubclassData(unsigned short D) {
1065     Value::setValueSubclassData(D);
1066   }
1067 };
1068
1069 template <>
1070 struct OperandTraits<ConstantExpr> :
1071   public VariadicOperandTraits<ConstantExpr, 1> {
1072 };
1073
1074 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ConstantExpr, Constant)
1075
1076 //===----------------------------------------------------------------------===//
1077 /// UndefValue - 'undef' values are things that do not have specified contents.
1078 /// These are used for a variety of purposes, including global variable
1079 /// initializers and operands to instructions.  'undef' values can occur with
1080 /// any first-class type.
1081 ///
1082 /// Undef values aren't exactly constants; if they have multiple uses, they
1083 /// can appear to have different bit patterns at each use. See
1084 /// LangRef.html#undefvalues for details.
1085 ///
1086 class UndefValue : public Constant {
1087   void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
1088   UndefValue(const UndefValue &);      // DO NOT IMPLEMENT
1089 protected:
1090   explicit UndefValue(Type *T) : Constant(T, UndefValueVal, 0, 0) {}
1091 protected:
1092   // allocate space for exactly zero operands
1093   void *operator new(size_t s) {
1094     return User::operator new(s, 0);
1095   }
1096 public:
1097   /// get() - Static factory methods - Return an 'undef' object of the specified
1098   /// type.
1099   ///
1100   static UndefValue *get(Type *T);
1101
1102   /// getSequentialElement - If this Undef has array or vector type, return a
1103   /// undef with the right element type.
1104   UndefValue *getSequentialElement();
1105
1106   /// getStructElement - If this undef has struct type, return a undef with the
1107   /// right element type for the specified element.
1108   UndefValue *getStructElement(unsigned Elt);
1109
1110   /// getElementValue - Return an undef of the right value for the specified GEP
1111   /// index.
1112   UndefValue *getElementValue(Constant *C);
1113
1114   /// getElementValue - Return an undef of the right value for the specified GEP
1115   /// index.
1116   UndefValue *getElementValue(unsigned Idx);
1117
1118   virtual void destroyConstant();
1119
1120   /// Methods for support type inquiry through isa, cast, and dyn_cast:
1121   static inline bool classof(const UndefValue *) { return true; }
1122   static bool classof(const Value *V) {
1123     return V->getValueID() == UndefValueVal;
1124   }
1125 };
1126
1127 } // End llvm namespace
1128
1129 #endif