include/llvm/GlobalValue.h

   1 //===-- llvm/GlobalValue.h - Class to represent a global value --*- 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 is a common base class of all globally definable objects.  As such,
  11 // it is subclassed by GlobalVariable, GlobalAlias and by Function.  This is
  12 // used because you can do certain things with these global objects that you
  13 // can't do to anything else.  For example, use the address of one as a
  14 // constant.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #ifndef LLVM_GLOBALVALUE_H
  19 #define LLVM_GLOBALVALUE_H
  20
  21 #include "llvm/Constant.h"
  22
  23 namespace llvm {
  24
  25 class PointerType;
  26 class Module;
  27
  28 class GlobalValue : public Constant {
  29   GlobalValue(const GlobalValue &);             // do not implement
  30 public:
  31   /// @brief An enumeration for the kinds of linkage for global values.
  32   enum LinkageTypes {
  33     ExternalLinkage = 0,///< Externally visible function
  34     AvailableExternallyLinkage, ///< Available for inspection, not emission.
  35     LinkOnceAnyLinkage, ///< Keep one copy of function when linking (inline)
  36     LinkOnceODRLinkage, ///< Same, but only replaced by something equivalent.
  37     WeakAnyLinkage,     ///< Keep one copy of named function when linking (weak)
  38     WeakODRLinkage,     ///< Same, but only replaced by something equivalent.
  39     AppendingLinkage,   ///< Special purpose, only applies to global arrays
  40     InternalLinkage,    ///< Rename collisions when linking (static functions).
  41     PrivateLinkage,     ///< Like Internal, but omit from symbol table.
  42     LinkerPrivateLinkage, ///< Like Private, but linker removes.
  43     LinkerPrivateWeakLinkage, ///< Like LinkerPrivate, but weak.
  44     DLLImportLinkage,   ///< Function to be imported from DLL
  45     DLLExportLinkage,   ///< Function to be accessible from DLL.
  46     ExternalWeakLinkage,///< ExternalWeak linkage description.
  47     CommonLinkage       ///< Tentative definitions.
  48   };
  49
  50   /// @brief An enumeration for the kinds of visibility of global values.
  51   enum VisibilityTypes {
  52     DefaultVisibility = 0,  ///< The GV is visible
  53     HiddenVisibility,       ///< The GV is hidden
  54     ProtectedVisibility     ///< The GV is protected
  55   };
  56
  57 protected:
  58   GlobalValue(const Type *ty, ValueTy vty, Use *Ops, unsigned NumOps,
  59               LinkageTypes linkage, const Twine &Name)
  60     : Constant(ty, vty, Ops, NumOps), Parent(0),
  61       Linkage(linkage), Visibility(DefaultVisibility), Alignment(0) {
  62     setName(Name);
  63   }
  64
  65   Module *Parent;
  66   // Note: VC++ treats enums as signed, so an extra bit is required to prevent
  67   // Linkage and Visibility from turning into negative values.
  68   LinkageTypes Linkage : 5;   // The linkage of this global
  69   unsigned Visibility : 2;    // The visibility style of this global
  70   unsigned Alignment : 16;    // Alignment of this symbol, must be power of two
  71   std::string Section;        // Section to emit this into, empty mean default
  72 public:
  73   ~GlobalValue() {
  74     removeDeadConstantUsers();   // remove any dead constants using this.
  75   }
  76
  77   unsigned getAlignment() const {
  78     return (1u << Alignment) >> 1;
  79   }
  80   void setAlignment(unsigned Align);
  81
  82   VisibilityTypes getVisibility() const { return VisibilityTypes(Visibility); }
  83   bool hasDefaultVisibility() const { return Visibility == DefaultVisibility; }
  84   bool hasHiddenVisibility() const { return Visibility == HiddenVisibility; }
  85   bool hasProtectedVisibility() const {
  86     return Visibility == ProtectedVisibility;
  87   }
  88   void setVisibility(VisibilityTypes V) { Visibility = V; }
  89
  90   bool hasSection() const { return !Section.empty(); }
  91   const std::string &getSection() const { return Section; }
  92   void setSection(StringRef S) { Section = S; }
  93
  94   /// If the usage is empty (except transitively dead constants), then this
  95   /// global value can be safely deleted since the destructor will
  96   /// delete the dead constants as well.
  97   /// @brief Determine if the usage of this global value is empty except
  98   /// for transitively dead constants.
  99   bool use_empty_except_constants();
 100
 101   /// getType - Global values are always pointers.
 102   inline const PointerType *getType() const {
 103     return reinterpret_cast<const PointerType*>(User::getType());
 104   }
 105
 106   static LinkageTypes getLinkOnceLinkage(bool ODR) {
 107     return ODR ? LinkOnceODRLinkage : LinkOnceAnyLinkage;
 108   }
 109   static LinkageTypes getWeakLinkage(bool ODR) {
 110     return ODR ? WeakODRLinkage : WeakAnyLinkage;
 111   }
 112
 113   static bool isExternalLinkage(LinkageTypes Linkage) {
 114     return Linkage == ExternalLinkage;
 115   }
 116   static bool isAvailableExternallyLinkage(LinkageTypes Linkage) {
 117     return Linkage == AvailableExternallyLinkage;
 118   }
 119   static bool isLinkOnceLinkage(LinkageTypes Linkage) {
 120     return Linkage == LinkOnceAnyLinkage || Linkage == LinkOnceODRLinkage;
 121   }
 122   static bool isWeakLinkage(LinkageTypes Linkage) {
 123     return Linkage == WeakAnyLinkage || Linkage == WeakODRLinkage;
 124   }
 125   static bool isAppendingLinkage(LinkageTypes Linkage) {
 126     return Linkage == AppendingLinkage;
 127   }
 128   static bool isInternalLinkage(LinkageTypes Linkage) {
 129     return Linkage == InternalLinkage;
 130   }
 131   static bool isPrivateLinkage(LinkageTypes Linkage) {
 132     return Linkage == PrivateLinkage;
 133   }
 134   static bool isLinkerPrivateLinkage(LinkageTypes Linkage) {
 135     return Linkage == LinkerPrivateLinkage;
 136   }
 137   static bool isLinkerPrivateWeakLinkage(LinkageTypes Linkage) {
 138     return Linkage == LinkerPrivateWeakLinkage;
 139   }
 140   static bool isLocalLinkage(LinkageTypes Linkage) {
 141     return isInternalLinkage(Linkage) || isPrivateLinkage(Linkage) ||
 142       isLinkerPrivateLinkage(Linkage) || isLinkerPrivateWeakLinkage(Linkage);
 143   }
 144   static bool isDLLImportLinkage(LinkageTypes Linkage) {
 145     return Linkage == DLLImportLinkage;
 146   }
 147   static bool isDLLExportLinkage(LinkageTypes Linkage) {
 148     return Linkage == DLLExportLinkage;
 149   }
 150   static bool isExternalWeakLinkage(LinkageTypes Linkage) {
 151     return Linkage == ExternalWeakLinkage;
 152   }
 153   static bool isCommonLinkage(LinkageTypes Linkage) {
 154     return Linkage == CommonLinkage;
 155   }
 156
 157   /// mayBeOverridden - Whether the definition of this global may be replaced
 158   /// by something non-equivalent at link time.  For example, if a function has
 159   /// weak linkage then the code defining it may be replaced by different code.
 160   static bool mayBeOverridden(LinkageTypes Linkage) {
 161     return (Linkage == WeakAnyLinkage ||
 162             Linkage == LinkOnceAnyLinkage ||
 163             Linkage == CommonLinkage ||
 164             Linkage == ExternalWeakLinkage ||
 165             Linkage == LinkerPrivateWeakLinkage);
 166   }
 167
 168   /// isWeakForLinker - Whether the definition of this global may be replaced at
 169   /// link time.
 170   static bool isWeakForLinker(LinkageTypes Linkage)  {
 171     return (Linkage == AvailableExternallyLinkage ||
 172             Linkage == WeakAnyLinkage ||
 173             Linkage == WeakODRLinkage ||
 174             Linkage == LinkOnceAnyLinkage ||
 175             Linkage == LinkOnceODRLinkage ||
 176             Linkage == CommonLinkage ||
 177             Linkage == ExternalWeakLinkage ||
 178             Linkage == LinkerPrivateWeakLinkage);
 179   }
 180
 181   bool hasExternalLinkage() const { return isExternalLinkage(Linkage); }
 182   bool hasAvailableExternallyLinkage() const {
 183     return isAvailableExternallyLinkage(Linkage);
 184   }
 185   bool hasLinkOnceLinkage() const {
 186     return isLinkOnceLinkage(Linkage);
 187   }
 188   bool hasWeakLinkage() const {
 189     return isWeakLinkage(Linkage);
 190   }
 191   bool hasAppendingLinkage() const { return isAppendingLinkage(Linkage); }
 192   bool hasInternalLinkage() const { return isInternalLinkage(Linkage); }
 193   bool hasPrivateLinkage() const { return isPrivateLinkage(Linkage); }
 194   bool hasLinkerPrivateLinkage() const { return isLinkerPrivateLinkage(Linkage); }
 195   bool hasLinkerPrivateWeakLinkage() const {
 196     return isLinkerPrivateWeakLinkage(Linkage);
 197   }
 198   bool hasLocalLinkage() const { return isLocalLinkage(Linkage); }
 199   bool hasDLLImportLinkage() const { return isDLLImportLinkage(Linkage); }
 200   bool hasDLLExportLinkage() const { return isDLLExportLinkage(Linkage); }
 201   bool hasExternalWeakLinkage() const { return isExternalWeakLinkage(Linkage); }
 202   bool hasCommonLinkage() const { return isCommonLinkage(Linkage); }
 203
 204   void setLinkage(LinkageTypes LT) { Linkage = LT; }
 205   LinkageTypes getLinkage() const { return Linkage; }
 206
 207   bool mayBeOverridden() const { return mayBeOverridden(Linkage); }
 208
 209   bool isWeakForLinker() const { return isWeakForLinker(Linkage); }
 210
 211   /// copyAttributesFrom - copy all additional attributes (those not needed to
 212   /// create a GlobalValue) from the GlobalValue Src to this one.
 213   virtual void copyAttributesFrom(const GlobalValue *Src);
 214
 215 /// @name Materialization
 216 /// Materialization is used to construct functions only as they're needed. This
 217 /// is useful to reduce memory usage in LLVM or parsing work done by the
 218 /// BitcodeReader to load the Module.
 219 /// @{
 220
 221   /// isMaterializable - If this function's Module is being lazily streamed in
 222   /// functions from disk or some other source, this method can be used to check
 223   /// to see if the function has been read in yet or not.
 224   bool isMaterializable() const;
 225
 226   /// isDematerializable - Returns true if this function was loaded from a
 227   /// GVMaterializer that's still attached to its Module and that knows how to
 228   /// dematerialize the function.
 229   bool isDematerializable() const;
 230
 231   /// Materialize - make sure this GlobalValue is fully read.  If the module is
 232   /// corrupt, this returns true and fills in the optional string with
 233   /// information about the problem.  If successful, this returns false.
 234   bool Materialize(std::string *ErrInfo = 0);
 235
 236   /// Dematerialize - If this GlobalValue is read in, and if the GVMaterializer
 237   /// supports it, release the memory for the function, and set it up to be
 238   /// materialized lazily.  If !isDematerializable(), this method is a noop.
 239   void Dematerialize();
 240
 241 /// @}
 242
 243   /// Override from Constant class. No GlobalValue's are null values so this
 244   /// always returns false.
 245   virtual bool isNullValue() const { return false; }
 246
 247   /// Override from Constant class.
 248   virtual void destroyConstant();
 249
 250   /// isDeclaration - Return true if the primary definition of this global
 251   /// value is outside of the current translation unit...
 252   virtual bool isDeclaration() const = 0;
 253
 254   /// removeFromParent - This method unlinks 'this' from the containing module,
 255   /// but does not delete it.
 256   virtual void removeFromParent() = 0;
 257
 258   /// eraseFromParent - This method unlinks 'this' from the containing module
 259   /// and deletes it.
 260   virtual void eraseFromParent() = 0;
 261
 262   /// getParent - Get the module that this global value is contained inside
 263   /// of...
 264   inline Module *getParent() { return Parent; }
 265   inline const Module *getParent() const { return Parent; }
 266
 267   /// removeDeadConstantUsers - If there are any dead constant users dangling
 268   /// off of this global value, remove them.  This method is useful for clients
 269   /// that want to check to see if a global is unused, but don't want to deal
 270   /// with potentially dead constants hanging off of the globals.
 271   void removeDeadConstantUsers() const;
 272
 273   // Methods for support type inquiry through isa, cast, and dyn_cast:
 274   static inline bool classof(const GlobalValue *) { return true; }
 275   static inline bool classof(const Value *V) {
 276     return V->getValueID() == Value::FunctionVal ||
 277            V->getValueID() == Value::GlobalVariableVal ||
 278            V->getValueID() == Value::GlobalAliasVal;
 279   }
 280 };
 281
 282 } // End llvm namespace
 283
 284 #endif