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() const;
 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) const;
 324
 325   /// getElementValue - Return a zero of the right value for the specified GEP
 326   /// index.
 327   Constant *getElementValue(Constant *C) const;
 328
 329   /// getElementValue - Return a zero of the right value for the specified GEP
 330   /// index.
 331   Constant *getElementValue(unsigned Idx) const;
 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   /// Transparently provide more efficient getOperand methods.
 356   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
 357
 358   /// getType - Specialize the getType() method to always return an ArrayType,
 359   /// which reduces the amount of casting needed in parts of the compiler.
 360   ///
 361   inline ArrayType *getType() const {
 362     return reinterpret_cast<ArrayType*>(Value::getType());
 363   }
 364
 365   virtual void destroyConstant();
 366   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
 367
 368   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 369   static inline bool classof(const ConstantArray *) { return true; }
 370   static bool classof(const Value *V) {
 371     return V->getValueID() == ConstantArrayVal;
 372   }
 373 };
 374
 375 template <>
 376 struct OperandTraits<ConstantArray> :
 377   public VariadicOperandTraits<ConstantArray> {
 378 };
 379
 380 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ConstantArray, Constant)
 381
 382 //===----------------------------------------------------------------------===//
 383 // ConstantStruct - Constant Struct Declarations
 384 //
 385 class ConstantStruct : public Constant {
 386   friend struct ConstantCreator<ConstantStruct, StructType,
 387                                     std::vector<Constant*> >;
 388   ConstantStruct(const ConstantStruct &);      // DO NOT IMPLEMENT
 389 protected:
 390   ConstantStruct(StructType *T, ArrayRef<Constant *> Val);
 391 public:
 392   // ConstantStruct accessors
 393   static Constant *get(StructType *T, ArrayRef<Constant*> V);
 394   static Constant *get(StructType *T, ...) END_WITH_NULL;
 395
 396   /// getAnon - Return an anonymous struct that has the specified
 397   /// elements.  If the struct is possibly empty, then you must specify a
 398   /// context.
 399   static Constant *getAnon(ArrayRef<Constant*> V, bool Packed = false) {
 400     return get(getTypeForElements(V, Packed), V);
 401   }
 402   static Constant *getAnon(LLVMContext &Ctx,
 403                            ArrayRef<Constant*> V, bool Packed = false) {
 404     return get(getTypeForElements(Ctx, V, Packed), V);
 405   }
 406
 407   /// getTypeForElements - Return an anonymous struct type to use for a constant
 408   /// with the specified set of elements.  The list must not be empty.
 409   static StructType *getTypeForElements(ArrayRef<Constant*> V,
 410                                         bool Packed = false);
 411   /// getTypeForElements - This version of the method allows an empty list.
 412   static StructType *getTypeForElements(LLVMContext &Ctx,
 413                                         ArrayRef<Constant*> V,
 414                                         bool Packed = false);
 415
 416   /// Transparently provide more efficient getOperand methods.
 417   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
 418
 419   /// getType() specialization - Reduce amount of casting...
 420   ///
 421   inline StructType *getType() const {
 422     return reinterpret_cast<StructType*>(Value::getType());
 423   }
 424
 425   virtual void destroyConstant();
 426   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
 427
 428   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 429   static inline bool classof(const ConstantStruct *) { return true; }
 430   static bool classof(const Value *V) {
 431     return V->getValueID() == ConstantStructVal;
 432   }
 433 };
 434
 435 template <>
 436 struct OperandTraits<ConstantStruct> :
 437   public VariadicOperandTraits<ConstantStruct> {
 438 };
 439
 440 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ConstantStruct, Constant)
 441
 442
 443 //===----------------------------------------------------------------------===//
 444 /// ConstantVector - Constant Vector Declarations
 445 ///
 446 class ConstantVector : public Constant {
 447   friend struct ConstantCreator<ConstantVector, VectorType,
 448                                     std::vector<Constant*> >;
 449   ConstantVector(const ConstantVector &);      // DO NOT IMPLEMENT
 450 protected:
 451   ConstantVector(VectorType *T, ArrayRef<Constant *> Val);
 452 public:
 453   // ConstantVector accessors
 454   static Constant *get(ArrayRef<Constant*> V);
 455
 456   /// getSplat - Return a ConstantVector with the specified constant in each
 457   /// element.
 458   static Constant *getSplat(unsigned NumElts, Constant *Elt);
 459
 460   /// Transparently provide more efficient getOperand methods.
 461   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
 462
 463   /// getType - Specialize the getType() method to always return a VectorType,
 464   /// which reduces the amount of casting needed in parts of the compiler.
 465   ///
 466   inline VectorType *getType() const {
 467     return reinterpret_cast<VectorType*>(Value::getType());
 468   }
 469
 470   /// getSplatValue - If this is a splat constant, meaning that all of the
 471   /// elements have the same value, return that value. Otherwise return NULL.
 472   Constant *getSplatValue() const;
 473
 474   virtual void destroyConstant();
 475   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
 476
 477   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 478   static inline bool classof(const ConstantVector *) { return true; }
 479   static bool classof(const Value *V) {
 480     return V->getValueID() == ConstantVectorVal;
 481   }
 482 };
 483
 484 template <>
 485 struct OperandTraits<ConstantVector> :
 486   public VariadicOperandTraits<ConstantVector> {
 487 };
 488
 489 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ConstantVector, Constant)
 490
 491 //===----------------------------------------------------------------------===//
 492 /// ConstantPointerNull - a constant pointer value that points to null
 493 ///
 494 class ConstantPointerNull : public Constant {
 495   void *operator new(size_t, unsigned);                  // DO NOT IMPLEMENT
 496   ConstantPointerNull(const ConstantPointerNull &);      // DO NOT IMPLEMENT
 497 protected:
 498   explicit ConstantPointerNull(PointerType *T)
 499     : Constant(reinterpret_cast<Type*>(T),
 500                Value::ConstantPointerNullVal, 0, 0) {}
 501
 502 protected:
 503   // allocate space for exactly zero operands
 504   void *operator new(size_t s) {
 505     return User::operator new(s, 0);
 506   }
 507 public:
 508   /// get() - Static factory methods - Return objects of the specified value
 509   static ConstantPointerNull *get(PointerType *T);
 510
 511   virtual void destroyConstant();
 512
 513   /// getType - Specialize the getType() method to always return an PointerType,
 514   /// which reduces the amount of casting needed in parts of the compiler.
 515   ///
 516   inline PointerType *getType() const {
 517     return reinterpret_cast<PointerType*>(Value::getType());
 518   }
 519
 520   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 521   static inline bool classof(const ConstantPointerNull *) { return true; }
 522   static bool classof(const Value *V) {
 523     return V->getValueID() == ConstantPointerNullVal;
 524   }
 525 };
 526
 527 //===----------------------------------------------------------------------===//
 528 /// ConstantDataSequential - A vector or array constant whose element type is a
 529 /// simple 1/2/4/8-byte integer or float/double, and whose elements are just
 530 /// simple data values (i.e. ConstantInt/ConstantFP).  This Constant node has no
 531 /// operands because it stores all of the elements of the constant as densely
 532 /// packed data, instead of as Value*'s.
 533 ///
 534 /// This is the common base class of ConstantDataArray and ConstantDataVector.
 535 ///
 536 class ConstantDataSequential : public Constant {
 537   friend class LLVMContextImpl;
 538   /// DataElements - A pointer to the bytes underlying this constant (which is
 539   /// owned by the uniquing StringMap).
 540   const char *DataElements;
 541
 542   /// Next - This forms a link list of ConstantDataSequential nodes that have
 543   /// the same value but different type.  For example, 0,0,0,1 could be a 4
 544   /// element array of i8, or a 1-element array of i32.  They'll both end up in
 545   /// the same StringMap bucket, linked up.
 546   ConstantDataSequential *Next;
 547   void *operator new(size_t, unsigned);                      // DO NOT IMPLEMENT
 548   ConstantDataSequential(const ConstantDataSequential &);    // DO NOT IMPLEMENT
 549 protected:
 550   explicit ConstantDataSequential(Type *ty, ValueTy VT, const char *Data)
 551     : Constant(ty, VT, 0, 0), DataElements(Data), Next(0) {}
 552   ~ConstantDataSequential() { delete Next; }
 553
 554   static Constant *getImpl(StringRef Bytes, Type *Ty);
 555
 556 protected:
 557   // allocate space for exactly zero operands.
 558   void *operator new(size_t s) {
 559     return User::operator new(s, 0);
 560   }
 561 public:
 562
 563   /// isElementTypeCompatible - Return true if a ConstantDataSequential can be
 564   /// formed with a vector or array of the specified element type.
 565   /// ConstantDataArray only works with normal float and int types that are
 566   /// stored densely in memory, not with things like i42 or x86_f80.
 567   static bool isElementTypeCompatible(const Type *Ty);
 568
 569   /// getElementAsInteger - If this is a sequential container of integers (of
 570   /// any size), return the specified element in the low bits of a uint64_t.
 571   uint64_t getElementAsInteger(unsigned i) const;
 572
 573   /// getElementAsAPFloat - If this is a sequential container of floating point
 574   /// type, return the specified element as an APFloat.
 575   APFloat getElementAsAPFloat(unsigned i) const;
 576
 577   /// getElementAsFloat - If this is an sequential container of floats, return
 578   /// the specified element as a float.
 579   float getElementAsFloat(unsigned i) const;
 580
 581   /// getElementAsDouble - If this is an sequential container of doubles, return
 582   /// the specified element as a double.
 583   double getElementAsDouble(unsigned i) const;
 584
 585   /// getElementAsConstant - Return a Constant for a specified index's element.
 586   /// Note that this has to compute a new constant to return, so it isn't as
 587   /// efficient as getElementAsInteger/Float/Double.
 588   Constant *getElementAsConstant(unsigned i) const;
 589
 590   /// getType - Specialize the getType() method to always return a
 591   /// SequentialType, which reduces the amount of casting needed in parts of the
 592   /// compiler.
 593   inline SequentialType *getType() const {
 594     return reinterpret_cast<SequentialType*>(Value::getType());
 595   }
 596
 597   /// getElementType - Return the element type of the array/vector.
 598   Type *getElementType() const;
 599
 600   /// getNumElements - Return the number of elements in the array or vector.
 601   unsigned getNumElements() const;
 602
 603   /// getElementByteSize - Return the size (in bytes) of each element in the
 604   /// array/vector.  The size of the elements is known to be a multiple of one
 605   /// byte.
 606   uint64_t getElementByteSize() const;
 607
 608
 609   /// isString - This method returns true if this is an array of i8.
 610   bool isString() const;
 611
 612   /// isCString - This method returns true if the array "isString", ends with a
 613   /// nul byte, and does not contains any other nul bytes.
 614   bool isCString() const;
 615
 616   /// getAsString - If this array is isString(), then this method returns the
 617   /// array as a StringRef.  Otherwise, it asserts out.
 618   ///
 619   StringRef getAsString() const {
 620     assert(isString() && "Not a string");
 621     return getRawDataValues();
 622   }
 623
 624   /// getAsCString - If this array is isCString(), then this method returns the
 625   /// array (without the trailing null byte) as a StringRef. Otherwise, it
 626   /// asserts out.
 627   ///
 628   StringRef getAsCString() const {
 629     assert(isCString() && "Isn't a C string");
 630     StringRef Str = getAsString();
 631     return Str.substr(0, Str.size()-1);
 632   }
 633
 634   /// getRawDataValues - Return the raw, underlying, bytes of this data.  Note
 635   /// that this is an extremely tricky thing to work with, as it exposes the
 636   /// host endianness of the data elements.
 637   StringRef getRawDataValues() const;
 638
 639   virtual void destroyConstant();
 640
 641   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 642   ///
 643   static bool classof(const ConstantDataSequential *) { return true; }
 644   static bool classof(const Value *V) {
 645     return V->getValueID() == ConstantDataArrayVal ||
 646            V->getValueID() == ConstantDataVectorVal;
 647   }
 648 private:
 649   const char *getElementPointer(unsigned Elt) const;
 650 };
 651
 652 //===----------------------------------------------------------------------===//
 653 /// ConstantDataArray - An array constant whose element type is a simple
 654 /// 1/2/4/8-byte integer or float/double, and whose elements are just simple
 655 /// data values (i.e. ConstantInt/ConstantFP).  This Constant node has no
 656 /// operands because it stores all of the elements of the constant as densely
 657 /// packed data, instead of as Value*'s.
 658 class ConstantDataArray : public ConstantDataSequential {
 659   void *operator new(size_t, unsigned);            // DO NOT IMPLEMENT
 660   ConstantDataArray(const ConstantDataArray &);    // DO NOT IMPLEMENT
 661   virtual void anchor();
 662   friend class ConstantDataSequential;
 663   explicit ConstantDataArray(Type *ty, const char *Data)
 664     : ConstantDataSequential(ty, ConstantDataArrayVal, Data) {}
 665 protected:
 666   // allocate space for exactly zero operands.
 667   void *operator new(size_t s) {
 668     return User::operator new(s, 0);
 669   }
 670 public:
 671
 672   /// get() constructors - Return a constant with array type with an element
 673   /// count and element type matching the ArrayRef passed in.  Note that this
 674   /// can return a ConstantAggregateZero object.
 675   static Constant *get(LLVMContext &Context, ArrayRef<uint8_t> Elts);
 676   static Constant *get(LLVMContext &Context, ArrayRef<uint16_t> Elts);
 677   static Constant *get(LLVMContext &Context, ArrayRef<uint32_t> Elts);
 678   static Constant *get(LLVMContext &Context, ArrayRef<uint64_t> Elts);
 679   static Constant *get(LLVMContext &Context, ArrayRef<float> Elts);
 680   static Constant *get(LLVMContext &Context, ArrayRef<double> Elts);
 681
 682   /// getString - This method constructs a CDS and initializes it with a text
 683   /// string. The default behavior (AddNull==true) causes a null terminator to
 684   /// be placed at the end of the array (increasing the length of the string by
 685   /// one more than the StringRef would normally indicate.  Pass AddNull=false
 686   /// to disable this behavior.
 687   static Constant *getString(LLVMContext &Context, StringRef Initializer,
 688                              bool AddNull = true);
 689
 690   /// getType - Specialize the getType() method to always return an ArrayType,
 691   /// which reduces the amount of casting needed in parts of the compiler.
 692   ///
 693   inline ArrayType *getType() const {
 694     return reinterpret_cast<ArrayType*>(Value::getType());
 695   }
 696
 697   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 698   ///
 699   static bool classof(const ConstantDataArray *) { return true; }
 700   static bool classof(const Value *V) {
 701     return V->getValueID() == ConstantDataArrayVal;
 702   }
 703 };
 704
 705 //===----------------------------------------------------------------------===//
 706 /// ConstantDataVector - A vector constant whose element type is a simple
 707 /// 1/2/4/8-byte integer or float/double, and whose elements are just simple
 708 /// data values (i.e. ConstantInt/ConstantFP).  This Constant node has no
 709 /// operands because it stores all of the elements of the constant as densely
 710 /// packed data, instead of as Value*'s.
 711 class ConstantDataVector : public ConstantDataSequential {
 712   void *operator new(size_t, unsigned);              // DO NOT IMPLEMENT
 713   ConstantDataVector(const ConstantDataVector &);    // DO NOT IMPLEMENT
 714   virtual void anchor();
 715   friend class ConstantDataSequential;
 716   explicit ConstantDataVector(Type *ty, const char *Data)
 717   : ConstantDataSequential(ty, ConstantDataVectorVal, Data) {}
 718 protected:
 719   // allocate space for exactly zero operands.
 720   void *operator new(size_t s) {
 721     return User::operator new(s, 0);
 722   }
 723 public:
 724
 725   /// get() constructors - Return a constant with vector type with an element
 726   /// count and element type matching the ArrayRef passed in.  Note that this
 727   /// can return a ConstantAggregateZero object.
 728   static Constant *get(LLVMContext &Context, ArrayRef<uint8_t> Elts);
 729   static Constant *get(LLVMContext &Context, ArrayRef<uint16_t> Elts);
 730   static Constant *get(LLVMContext &Context, ArrayRef<uint32_t> Elts);
 731   static Constant *get(LLVMContext &Context, ArrayRef<uint64_t> Elts);
 732   static Constant *get(LLVMContext &Context, ArrayRef<float> Elts);
 733   static Constant *get(LLVMContext &Context, ArrayRef<double> Elts);
 734
 735   /// getSplat - Return a ConstantVector with the specified constant in each
 736   /// element.  The specified constant has to be a of a compatible type (i8/i16/
 737   /// i32/i64/float/double) and must be a ConstantFP or ConstantInt.
 738   static Constant *getSplat(unsigned NumElts, Constant *Elt);
 739
 740   /// getSplatValue - If this is a splat constant, meaning that all of the
 741   /// elements have the same value, return that value. Otherwise return NULL.
 742   Constant *getSplatValue() const;
 743
 744   /// getType - Specialize the getType() method to always return a VectorType,
 745   /// which reduces the amount of casting needed in parts of the compiler.
 746   ///
 747   inline VectorType *getType() const {
 748     return reinterpret_cast<VectorType*>(Value::getType());
 749   }
 750
 751   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 752   ///
 753   static bool classof(const ConstantDataVector *) { return true; }
 754   static bool classof(const Value *V) {
 755     return V->getValueID() == ConstantDataVectorVal;
 756   }
 757 };
 758
 759
 760
 761 /// BlockAddress - The address of a basic block.
 762 ///
 763 class BlockAddress : public Constant {
 764   void *operator new(size_t, unsigned);                  // DO NOT IMPLEMENT
 765   void *operator new(size_t s) { return User::operator new(s, 2); }
 766   BlockAddress(Function *F, BasicBlock *BB);
 767 public:
 768   /// get - Return a BlockAddress for the specified function and basic block.
 769   static BlockAddress *get(Function *F, BasicBlock *BB);
 770
 771   /// get - Return a BlockAddress for the specified basic block.  The basic
 772   /// block must be embedded into a function.
 773   static BlockAddress *get(BasicBlock *BB);
 774
 775   /// Transparently provide more efficient getOperand methods.
 776   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Value);
 777
 778   Function *getFunction() const { return (Function*)Op<0>().get(); }
 779   BasicBlock *getBasicBlock() const { return (BasicBlock*)Op<1>().get(); }
 780
 781   virtual void destroyConstant();
 782   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
 783
 784   /// Methods for support type inquiry through isa, cast, and dyn_cast:
 785   static inline bool classof(const BlockAddress *) { return true; }
 786   static inline bool classof(const Value *V) {
 787     return V->getValueID() == BlockAddressVal;
 788   }
 789 };
 790
 791 template <>
 792 struct OperandTraits<BlockAddress> :
 793   public FixedNumOperandTraits<BlockAddress, 2> {
 794 };
 795
 796 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(BlockAddress, Value)
 797
 798
 799 //===----------------------------------------------------------------------===//
 800 /// ConstantExpr - a constant value that is initialized with an expression using
 801 /// other constant values.
 802 ///
 803 /// This class uses the standard Instruction opcodes to define the various
 804 /// constant expressions.  The Opcode field for the ConstantExpr class is
 805 /// maintained in the Value::SubclassData field.
 806 class ConstantExpr : public Constant {
 807   friend struct ConstantCreator<ConstantExpr,Type,
 808                             std::pair<unsigned, std::vector<Constant*> > >;
 809   friend struct ConvertConstantType<ConstantExpr, Type>;
 810
 811 protected:
 812   ConstantExpr(Type *ty, unsigned Opcode, Use *Ops, unsigned NumOps)
 813     : Constant(ty, ConstantExprVal, Ops, NumOps) {
 814     // Operation type (an Instruction opcode) is stored as the SubclassData.
 815     setValueSubclassData(Opcode);
 816   }
 817
 818 public:
 819   // Static methods to construct a ConstantExpr of different kinds.  Note that
 820   // these methods may return a object that is not an instance of the
 821   // ConstantExpr class, because they will attempt to fold the constant
 822   // expression into something simpler if possible.
 823
 824   /// getAlignOf constant expr - computes the alignment of a type in a target
 825   /// independent way (Note: the return type is an i64).
 826   static Constant *getAlignOf(Type *Ty);
 827
 828   /// getSizeOf constant expr - computes the (alloc) size of a type (in
 829   /// address-units, not bits) in a target independent way (Note: the return
 830   /// type is an i64).
 831   ///
 832   static Constant *getSizeOf(Type *Ty);
 833
 834   /// getOffsetOf constant expr - computes the offset of a struct field in a
 835   /// target independent way (Note: the return type is an i64).
 836   ///
 837   static Constant *getOffsetOf(StructType *STy, unsigned FieldNo);
 838
 839   /// getOffsetOf constant expr - This is a generalized form of getOffsetOf,
 840   /// which supports any aggregate type, and any Constant index.
 841   ///
 842   static Constant *getOffsetOf(Type *Ty, Constant *FieldNo);
 843
 844   static Constant *getNeg(Constant *C, bool HasNUW = false, bool HasNSW =false);
 845   static Constant *getFNeg(Constant *C);
 846   static Constant *getNot(Constant *C);
 847   static Constant *getAdd(Constant *C1, Constant *C2,
 848                           bool HasNUW = false, bool HasNSW = false);
 849   static Constant *getFAdd(Constant *C1, Constant *C2);
 850   static Constant *getSub(Constant *C1, Constant *C2,
 851                           bool HasNUW = false, bool HasNSW = false);
 852   static Constant *getFSub(Constant *C1, Constant *C2);
 853   static Constant *getMul(Constant *C1, Constant *C2,
 854                           bool HasNUW = false, bool HasNSW = false);
 855   static Constant *getFMul(Constant *C1, Constant *C2);
 856   static Constant *getUDiv(Constant *C1, Constant *C2, bool isExact = false);
 857   static Constant *getSDiv(Constant *C1, Constant *C2, bool isExact = false);
 858   static Constant *getFDiv(Constant *C1, Constant *C2);
 859   static Constant *getURem(Constant *C1, Constant *C2);
 860   static Constant *getSRem(Constant *C1, Constant *C2);
 861   static Constant *getFRem(Constant *C1, Constant *C2);
 862   static Constant *getAnd(Constant *C1, Constant *C2);
 863   static Constant *getOr(Constant *C1, Constant *C2);
 864   static Constant *getXor(Constant *C1, Constant *C2);
 865   static Constant *getShl(Constant *C1, Constant *C2,
 866                           bool HasNUW = false, bool HasNSW = false);
 867   static Constant *getLShr(Constant *C1, Constant *C2, bool isExact = false);
 868   static Constant *getAShr(Constant *C1, Constant *C2, bool isExact = false);
 869   static Constant *getTrunc   (Constant *C, Type *Ty);
 870   static Constant *getSExt    (Constant *C, Type *Ty);
 871   static Constant *getZExt    (Constant *C, Type *Ty);
 872   static Constant *getFPTrunc (Constant *C, Type *Ty);
 873   static Constant *getFPExtend(Constant *C, Type *Ty);
 874   static Constant *getUIToFP  (Constant *C, Type *Ty);
 875   static Constant *getSIToFP  (Constant *C, Type *Ty);
 876   static Constant *getFPToUI  (Constant *C, Type *Ty);
 877   static Constant *getFPToSI  (Constant *C, Type *Ty);
 878   static Constant *getPtrToInt(Constant *C, Type *Ty);
 879   static Constant *getIntToPtr(Constant *C, Type *Ty);
 880   static Constant *getBitCast (Constant *C, Type *Ty);
 881
 882   static Constant *getNSWNeg(Constant *C) { return getNeg(C, false, true); }
 883   static Constant *getNUWNeg(Constant *C) { return getNeg(C, true, false); }
 884   static Constant *getNSWAdd(Constant *C1, Constant *C2) {
 885     return getAdd(C1, C2, false, true);
 886   }
 887   static Constant *getNUWAdd(Constant *C1, Constant *C2) {
 888     return getAdd(C1, C2, true, false);
 889   }
 890   static Constant *getNSWSub(Constant *C1, Constant *C2) {
 891     return getSub(C1, C2, false, true);
 892   }
 893   static Constant *getNUWSub(Constant *C1, Constant *C2) {
 894     return getSub(C1, C2, true, false);
 895   }
 896   static Constant *getNSWMul(Constant *C1, Constant *C2) {
 897     return getMul(C1, C2, false, true);
 898   }
 899   static Constant *getNUWMul(Constant *C1, Constant *C2) {
 900     return getMul(C1, C2, true, false);
 901   }
 902   static Constant *getNSWShl(Constant *C1, Constant *C2) {
 903     return getShl(C1, C2, false, true);
 904   }
 905   static Constant *getNUWShl(Constant *C1, Constant *C2) {
 906     return getShl(C1, C2, true, false);
 907   }
 908   static Constant *getExactSDiv(Constant *C1, Constant *C2) {
 909     return getSDiv(C1, C2, true);
 910   }
 911   static Constant *getExactUDiv(Constant *C1, Constant *C2) {
 912     return getUDiv(C1, C2, true);
 913   }
 914   static Constant *getExactAShr(Constant *C1, Constant *C2) {
 915     return getAShr(C1, C2, true);
 916   }
 917   static Constant *getExactLShr(Constant *C1, Constant *C2) {
 918     return getLShr(C1, C2, true);
 919   }
 920
 921   /// Transparently provide more efficient getOperand methods.
 922   DECLARE_TRANSPARENT_OPERAND_ACCESSORS(Constant);
 923
 924   // @brief Convenience function for getting one of the casting operations
 925   // using a CastOps opcode.
 926   static Constant *getCast(
 927     unsigned ops,  ///< The opcode for the conversion
 928     Constant *C,   ///< The constant to be converted
 929     Type *Ty ///< The type to which the constant is converted
 930   );
 931
 932   // @brief Create a ZExt or BitCast cast constant expression
 933   static Constant *getZExtOrBitCast(
 934     Constant *C,   ///< The constant to zext or bitcast
 935     Type *Ty ///< The type to zext or bitcast C to
 936   );
 937
 938   // @brief Create a SExt or BitCast cast constant expression
 939   static Constant *getSExtOrBitCast(
 940     Constant *C,   ///< The constant to sext or bitcast
 941     Type *Ty ///< The type to sext or bitcast C to
 942   );
 943
 944   // @brief Create a Trunc or BitCast cast constant expression
 945   static Constant *getTruncOrBitCast(
 946     Constant *C,   ///< The constant to trunc or bitcast
 947     Type *Ty ///< The type to trunc or bitcast C to
 948   );
 949
 950   /// @brief Create a BitCast or a PtrToInt cast constant expression
 951   static Constant *getPointerCast(
 952     Constant *C,   ///< The pointer value to be casted (operand 0)
 953     Type *Ty ///< The type to which cast should be made
 954   );
 955
 956   /// @brief Create a ZExt, Bitcast or Trunc for integer -> integer casts
 957   static Constant *getIntegerCast(
 958     Constant *C,    ///< The integer constant to be casted
 959     Type *Ty, ///< The integer type to cast to
 960     bool isSigned   ///< Whether C should be treated as signed or not
 961   );
 962
 963   /// @brief Create a FPExt, Bitcast or FPTrunc for fp -> fp casts
 964   static Constant *getFPCast(
 965     Constant *C,    ///< The integer constant to be casted
 966     Type *Ty ///< The integer type to cast to
 967   );
 968
 969   /// @brief Return true if this is a convert constant expression
 970   bool isCast() const;
 971
 972   /// @brief Return true if this is a compare constant expression
 973   bool isCompare() const;
 974
 975   /// @brief Return true if this is an insertvalue or extractvalue expression,
 976   /// and the getIndices() method may be used.
 977   bool hasIndices() const;
 978
 979   /// @brief Return true if this is a getelementptr expression and all
 980   /// the index operands are compile-time known integers within the
 981   /// corresponding notional static array extents. Note that this is
 982   /// not equivalant to, a subset of, or a superset of the "inbounds"
 983   /// property.
 984   bool isGEPWithNoNotionalOverIndexing() const;
 985
 986   /// Select constant expr
 987   ///
 988   static Constant *getSelect(Constant *C, Constant *V1, Constant *V2);
 989
 990   /// get - Return a binary or shift operator constant expression,
 991   /// folding if possible.
 992   ///
 993   static Constant *get(unsigned Opcode, Constant *C1, Constant *C2,
 994                        unsigned Flags = 0);
 995
 996   /// @brief Return an ICmp or FCmp comparison operator constant expression.
 997   static Constant *getCompare(unsigned short pred, Constant *C1, Constant *C2);
 998
 999   /// get* - Return some common constants without having to
1000   /// specify the full Instruction::OPCODE identifier.
1001   ///
1002   static Constant *getICmp(unsigned short pred, Constant *LHS, Constant *RHS);
1003   static Constant *getFCmp(unsigned short pred, Constant *LHS, Constant *RHS);
1004
1005   /// Getelementptr form.  Value* is only accepted for convenience;
1006   /// all elements must be Constant's.
1007   ///
1008   static Constant *getGetElementPtr(Constant *C,
1009                                     ArrayRef<Constant *> IdxList,
1010                                     bool InBounds = false) {
1011     return getGetElementPtr(C, makeArrayRef((Value * const *)IdxList.data(),
1012                                             IdxList.size()),
1013                             InBounds);
1014   }
1015   static Constant *getGetElementPtr(Constant *C,
1016                                     Constant *Idx,
1017                                     bool InBounds = false) {
1018     // This form of the function only exists to avoid ambiguous overload
1019     // warnings about whether to convert Idx to ArrayRef<Constant *> or
1020     // ArrayRef<Value *>.
1021     return getGetElementPtr(C, cast<Value>(Idx), InBounds);
1022   }
1023   static Constant *getGetElementPtr(Constant *C,
1024                                     ArrayRef<Value *> IdxList,
1025                                     bool InBounds = false);
1026
1027   /// Create an "inbounds" getelementptr. See the documentation for the
1028   /// "inbounds" flag in LangRef.html for details.
1029   static Constant *getInBoundsGetElementPtr(Constant *C,
1030                                             ArrayRef<Constant *> IdxList) {
1031     return getGetElementPtr(C, IdxList, true);
1032   }
1033   static Constant *getInBoundsGetElementPtr(Constant *C,
1034                                             Constant *Idx) {
1035     // This form of the function only exists to avoid ambiguous overload
1036     // warnings about whether to convert Idx to ArrayRef<Constant *> or
1037     // ArrayRef<Value *>.
1038     return getGetElementPtr(C, Idx, true);
1039   }
1040   static Constant *getInBoundsGetElementPtr(Constant *C,
1041                                             ArrayRef<Value *> IdxList) {
1042     return getGetElementPtr(C, IdxList, true);
1043   }
1044
1045   static Constant *getExtractElement(Constant *Vec, Constant *Idx);
1046   static Constant *getInsertElement(Constant *Vec, Constant *Elt,Constant *Idx);
1047   static Constant *getShuffleVector(Constant *V1, Constant *V2, Constant *Mask);
1048   static Constant *getExtractValue(Constant *Agg, ArrayRef<unsigned> Idxs);
1049   static Constant *getInsertValue(Constant *Agg, Constant *Val,
1050                                   ArrayRef<unsigned> Idxs);
1051
1052   /// getOpcode - Return the opcode at the root of this constant expression
1053   unsigned getOpcode() const { return getSubclassDataFromValue(); }
1054
1055   /// getPredicate - Return the ICMP or FCMP predicate value. Assert if this is
1056   /// not an ICMP or FCMP constant expression.
1057   unsigned getPredicate() const;
1058
1059   /// getIndices - Assert that this is an insertvalue or exactvalue
1060   /// expression and return the list of indices.
1061   ArrayRef<unsigned> getIndices() const;
1062
1063   /// getOpcodeName - Return a string representation for an opcode.
1064   const char *getOpcodeName() const;
1065
1066   /// getWithOperandReplaced - Return a constant expression identical to this
1067   /// one, but with the specified operand set to the specified value.
1068   Constant *getWithOperandReplaced(unsigned OpNo, Constant *Op) const;
1069
1070   /// getWithOperands - This returns the current constant expression with the
1071   /// operands replaced with the specified values.  The specified array must
1072   /// have the same number of operands as our current one.
1073   Constant *getWithOperands(ArrayRef<Constant*> Ops) const {
1074     return getWithOperands(Ops, getType());
1075   }
1076
1077   /// getWithOperands - This returns the current constant expression with the
1078   /// operands replaced with the specified values and with the specified result
1079   /// type.  The specified array must have the same number of operands as our
1080   /// current one.
1081   Constant *getWithOperands(ArrayRef<Constant*> Ops, Type *Ty) const;
1082
1083   virtual void destroyConstant();
1084   virtual void replaceUsesOfWithOnConstant(Value *From, Value *To, Use *U);
1085
1086   /// Methods for support type inquiry through isa, cast, and dyn_cast:
1087   static inline bool classof(const ConstantExpr *) { return true; }
1088   static inline bool classof(const Value *V) {
1089     return V->getValueID() == ConstantExprVal;
1090   }
1091
1092 private:
1093   // Shadow Value::setValueSubclassData with a private forwarding method so that
1094   // subclasses cannot accidentally use it.
1095   void setValueSubclassData(unsigned short D) {
1096     Value::setValueSubclassData(D);
1097   }
1098 };
1099
1100 template <>
1101 struct OperandTraits<ConstantExpr> :
1102   public VariadicOperandTraits<ConstantExpr, 1> {
1103 };
1104
1105 DEFINE_TRANSPARENT_OPERAND_ACCESSORS(ConstantExpr, Constant)
1106
1107 //===----------------------------------------------------------------------===//
1108 /// UndefValue - 'undef' values are things that do not have specified contents.
1109 /// These are used for a variety of purposes, including global variable
1110 /// initializers and operands to instructions.  'undef' values can occur with
1111 /// any first-class type.
1112 ///
1113 /// Undef values aren't exactly constants; if they have multiple uses, they
1114 /// can appear to have different bit patterns at each use. See
1115 /// LangRef.html#undefvalues for details.
1116 ///
1117 class UndefValue : public Constant {
1118   void *operator new(size_t, unsigned); // DO NOT IMPLEMENT
1119   UndefValue(const UndefValue &);      // DO NOT IMPLEMENT
1120 protected:
1121   explicit UndefValue(Type *T) : Constant(T, UndefValueVal, 0, 0) {}
1122 protected:
1123   // allocate space for exactly zero operands
1124   void *operator new(size_t s) {
1125     return User::operator new(s, 0);
1126   }
1127 public:
1128   /// get() - Static factory methods - Return an 'undef' object of the specified
1129   /// type.
1130   ///
1131   static UndefValue *get(Type *T);
1132
1133   /// getSequentialElement - If this Undef has array or vector type, return a
1134   /// undef with the right element type.
1135   UndefValue *getSequentialElement() const;
1136
1137   /// getStructElement - If this undef has struct type, return a undef with the
1138   /// right element type for the specified element.
1139   UndefValue *getStructElement(unsigned Elt) const;
1140
1141   /// getElementValue - Return an undef of the right value for the specified GEP
1142   /// index.
1143   UndefValue *getElementValue(Constant *C) const;
1144
1145   /// getElementValue - Return an undef of the right value for the specified GEP
1146   /// index.
1147   UndefValue *getElementValue(unsigned Idx) const;
1148
1149   virtual void destroyConstant();
1150
1151   /// Methods for support type inquiry through isa, cast, and dyn_cast:
1152   static inline bool classof(const UndefValue *) { return true; }
1153   static bool classof(const Value *V) {
1154     return V->getValueID() == UndefValueVal;
1155   }
1156 };
1157
1158 } // End llvm namespace
1159
1160 #endif