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