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