include/llvm/Constant.h

   1 //===-- llvm/Constant.h - Constant class definition -------------*- 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 // This file contains the declaration of the Constant class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_CONSTANT_H
  15 #define LLVM_CONSTANT_H
  16
  17 #include "llvm/User.h"
  18
  19 namespace llvm {
  20   class APInt;
  21
  22   template<typename T> class SmallVectorImpl;
  23   class LLVMContext;
  24
  25 /// This is an important base class in LLVM. It provides the common facilities
  26 /// of all constant values in an LLVM program. A constant is a value that is
  27 /// immutable at runtime. Functions are constants because their address is
  28 /// immutable. Same with global variables.
  29 ///
  30 /// All constants share the capabilities provided in this class. All constants
  31 /// can have a null value. They can have an operand list. Constants can be
  32 /// simple (integer and floating point values), complex (arrays and structures),
  33 /// or expression based (computations yielding a constant value composed of
  34 /// only certain operators and other constant values).
  35 ///
  36 /// Note that Constants are immutable (once created they never change)
  37 /// and are fully shared by structural equivalence.  This means that two
  38 /// structurally equivalent constants will always have the same address.
  39 /// Constants are created on demand as needed and never deleted: thus clients
  40 /// don't have to worry about the lifetime of the objects.
  41 /// @brief LLVM Constant Representation
  42 class Constant : public User {
  43   void operator=(const Constant &);     // Do not implement
  44   Constant(const Constant &);           // Do not implement
  45
  46 protected:
  47   Constant(const Type *ty, ValueTy vty, Use *Ops, unsigned NumOps)
  48     : User(ty, vty, Ops, NumOps) {}
  49
  50   void destroyConstantImpl();
  51
  52   void setOperand(unsigned i, Value *V) {
  53     User::setOperand(i, V);
  54   }
  55 public:
  56   /// isNullValue - Return true if this is the value that would be returned by
  57   /// getNullValue.
  58   virtual bool isNullValue() const = 0;
  59
  60   /// isNegativeZeroValue - Return true if the value is what would be returned
  61   /// by getZeroValueForNegation.
  62   virtual bool isNegativeZeroValue() const { return isNullValue(); }
  63
  64   /// canTrap - Return true if evaluation of this constant could trap.  This is
  65   /// true for things like constant expressions that could divide by zero.
  66   bool canTrap() const;
  67
  68   enum PossibleRelocationsTy {
  69     NoRelocation = 0,
  70     LocalRelocation = 1,
  71     GlobalRelocations = 2
  72   };
  73
  74   /// getRelocationInfo - This method classifies the entry according to
  75   /// whether or not it may generate a relocation entry.  This must be
  76   /// conservative, so if it might codegen to a relocatable entry, it should say
  77   /// so.  The return values are:
  78   ///
  79   ///  NoRelocation: This constant pool entry is guaranteed to never have a
  80   ///     relocation applied to it (because it holds a simple constant like
  81   ///     '4').
  82   ///  LocalRelocation: This entry has relocations, but the entries are
  83   ///     guaranteed to be resolvable by the static linker, so the dynamic
  84   ///     linker will never see them.
  85   ///  GlobalRelocations: This entry may have arbitrary relocations.
  86   ///
  87   /// FIXME: This really should not be in VMCore.
  88   PossibleRelocationsTy getRelocationInfo() const;
  89
  90   // Specialize get/setOperand for Users as their operands are always
  91   // constants or BasicBlocks as well.
  92   User *getOperand(unsigned i) {
  93     return static_cast<User*>(User::getOperand(i));
  94   }
  95   const User *getOperand(unsigned i) const {
  96     return static_cast<const User*>(User::getOperand(i));
  97   }
  98
  99   /// getVectorElements - This method, which is only valid on constant of vector
 100   /// type, returns the elements of the vector in the specified smallvector.
 101   /// This handles breaking down a vector undef into undef elements, etc.  For
 102   /// constant exprs and other cases we can't handle, we return an empty vector.
 103   void getVectorElements(LLVMContext &Context,
 104                          SmallVectorImpl<Constant*> &Elts) const;
 105
 106   /// destroyConstant - Called if some element of this constant is no longer
 107   /// valid.  At this point only other constants may be on the use_list for this
 108   /// constant.  Any constants on our Use list must also be destroy'd.  The
 109   /// implementation must be sure to remove the constant from the list of
 110   /// available cached constants.  Implementations should call
 111   /// destroyConstantImpl as the last thing they do, to destroy all users and
 112   /// delete this.
 113   virtual void destroyConstant() { assert(0 && "Not reached!"); }
 114
 115   //// Methods for support type inquiry through isa, cast, and dyn_cast:
 116   static inline bool classof(const Constant *) { return true; }
 117   static inline bool classof(const GlobalValue *) { return true; }
 118   static inline bool classof(const Value *V) {
 119     return V->getValueID() >= ConstantFirstVal &&
 120            V->getValueID() <= ConstantLastVal;
 121   }
 122
 123   /// replaceUsesOfWithOnConstant - This method is a special form of
 124   /// User::replaceUsesOfWith (which does not work on constants) that does work
 125   /// on constants.  Basically this method goes through the trouble of building
 126   /// a new constant that is equivalent to the current one, with all uses of
 127   /// From replaced with uses of To.  After this construction is completed, all
 128   /// of the users of 'this' are replaced to use the new constant, and then
 129   /// 'this' is deleted.  In general, you should not call this method, instead,
 130   /// use Value::replaceAllUsesWith, which automatically dispatches to this
 131   /// method as needed.
 132   ///
 133   virtual void replaceUsesOfWithOnConstant(Value *, Value *, Use *) {
 134     // Provide a default implementation for constants (like integers) that
 135     // cannot use any other values.  This cannot be called at runtime, but needs
 136     // to be here to avoid link errors.
 137     assert(getNumOperands() == 0 && "replaceUsesOfWithOnConstant must be "
 138            "implemented for all constants that have operands!");
 139     assert(0 && "Constants that do not have operands cannot be using 'From'!");
 140   }
 141
 142   static Constant* getNullValue(const Type* Ty);
 143
 144   /// @returns the value for an integer constant of the given type that has all
 145   /// its bits set to true.
 146   /// @brief Get the all ones value
 147   static Constant* getAllOnesValue(const Type* Ty);
 148
 149   /// getIntegerValue - Return the value for an integer or pointer constant,
 150   /// or a vector thereof, with the given scalar value.
 151   static Constant* getIntegerValue(const Type* Ty, const APInt &V);
 152 };
 153
 154 } // End llvm namespace
 155
 156 #endif