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