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