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 Comdat;
  27 class PointerType;
  28 class Module;
  29
  30 class GlobalValue : public Constant {
  31   GlobalValue(const GlobalValue &) LLVM_DELETED_FUNCTION;
  32 public:
  33   /// @brief An enumeration for the kinds of linkage for global values.
  34   enum LinkageTypes {
  35     ExternalLinkage = 0,///< Externally visible function
  36     AvailableExternallyLinkage, ///< Available for inspection, not emission.
  37     LinkOnceAnyLinkage, ///< Keep one copy of function when linking (inline)
  38     LinkOnceODRLinkage, ///< Same, but only replaced by something equivalent.
  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     ExternalWeakLinkage,///< ExternalWeak linkage description.
  45     CommonLinkage       ///< Tentative definitions.
  46   };
  47
  48   /// @brief An enumeration for the kinds of visibility of global values.
  49   enum VisibilityTypes {
  50     DefaultVisibility = 0,  ///< The GV is visible
  51     HiddenVisibility,       ///< The GV is hidden
  52     ProtectedVisibility     ///< The GV is protected
  53   };
  54
  55   /// @brief Storage classes of global values for PE targets.
  56   enum DLLStorageClassTypes {
  57     DefaultStorageClass   = 0,
  58     DLLImportStorageClass = 1, ///< Function to be imported from DLL
  59     DLLExportStorageClass = 2  ///< Function to be accessible from DLL.
  60   };
  61
  62 protected:
  63   GlobalValue(Type *Ty, ValueTy VTy, Use *Ops, unsigned NumOps,
  64               LinkageTypes Linkage, const Twine &Name)
  65       : Constant(Ty, VTy, Ops, NumOps), Linkage(Linkage),
  66         Visibility(DefaultVisibility), UnnamedAddr(0),
  67         DllStorageClass(DefaultStorageClass),
  68         ThreadLocal(NotThreadLocal), Parent(nullptr) {
  69     setName(Name);
  70   }
  71
  72   // Note: VC++ treats enums as signed, so an extra bit is required to prevent
  73   // Linkage and Visibility from turning into negative values.
  74   LinkageTypes Linkage : 5;   // The linkage of this global
  75   unsigned Visibility : 2;    // The visibility style of this global
  76   unsigned UnnamedAddr : 1;   // This value's address is not significant
  77   unsigned DllStorageClass : 2; // DLL storage class
  78
  79   unsigned ThreadLocal : 3; // Is this symbol "Thread Local", if so, what is
  80                             // the desired model?
  81
  82 private:
  83   // Give subclasses access to what otherwise would be wasted padding.
  84   // (19 + 3 + 2 + 1 + 2 + 5) == 32.
  85   unsigned SubClassData : 19;
  86 protected:
  87   unsigned getGlobalValueSubClassData() const {
  88     return SubClassData;
  89   }
  90   void setGlobalValueSubClassData(unsigned V) {
  91     assert(V < (1 << 19) && "It will not fit");
  92     SubClassData = V;
  93   }
  94
  95   Module *Parent;             // The containing module.
  96 public:
  97   enum ThreadLocalMode {
  98     NotThreadLocal = 0,
  99     GeneralDynamicTLSModel,
 100     LocalDynamicTLSModel,
 101     InitialExecTLSModel,
 102     LocalExecTLSModel
 103   };
 104
 105   ~GlobalValue() {
 106     removeDeadConstantUsers();   // remove any dead constants using this.
 107   }
 108
 109   unsigned getAlignment() const;
 110
 111   bool hasUnnamedAddr() const { return UnnamedAddr; }
 112   void setUnnamedAddr(bool Val) { UnnamedAddr = Val; }
 113
 114   bool hasComdat() const { return getComdat() != nullptr; }
 115   Comdat *getComdat();
 116   const Comdat *getComdat() const {
 117     return const_cast<GlobalValue *>(this)->getComdat();
 118   }
 119
 120   VisibilityTypes getVisibility() const { return VisibilityTypes(Visibility); }
 121   bool hasDefaultVisibility() const { return Visibility == DefaultVisibility; }
 122   bool hasHiddenVisibility() const { return Visibility == HiddenVisibility; }
 123   bool hasProtectedVisibility() const {
 124     return Visibility == ProtectedVisibility;
 125   }
 126   void setVisibility(VisibilityTypes V) {
 127     assert((!hasLocalLinkage() || V == DefaultVisibility) &&
 128            "local linkage requires default visibility");
 129     Visibility = V;
 130   }
 131
 132   /// If the value is "Thread Local", its value isn't shared by the threads.
 133   bool isThreadLocal() const { return getThreadLocalMode() != NotThreadLocal; }
 134   void setThreadLocal(bool Val) {
 135     setThreadLocalMode(Val ? GeneralDynamicTLSModel : NotThreadLocal);
 136   }
 137   void setThreadLocalMode(ThreadLocalMode Val) {
 138     assert(Val == NotThreadLocal || getValueID() != Value::FunctionVal);
 139     ThreadLocal = Val;
 140   }
 141   ThreadLocalMode getThreadLocalMode() const {
 142     return static_cast<ThreadLocalMode>(ThreadLocal);
 143   }
 144
 145   DLLStorageClassTypes getDLLStorageClass() const {
 146     return DLLStorageClassTypes(DllStorageClass);
 147   }
 148   bool hasDLLImportStorageClass() const {
 149     return DllStorageClass == DLLImportStorageClass;
 150   }
 151   bool hasDLLExportStorageClass() const {
 152     return DllStorageClass == DLLExportStorageClass;
 153   }
 154   void setDLLStorageClass(DLLStorageClassTypes C) { DllStorageClass = C; }
 155
 156   bool hasSection() const { return !StringRef(getSection()).empty(); }
 157   // It is unfortunate that we have to use "char *" in here since this is
 158   // always non NULL, but:
 159   // * The C API expects a null terminated string, so we cannot use StringRef.
 160   // * The C API expects us to own it, so we cannot use a std:string.
 161   // * For GlobalAliases we can fail to find the section and we have to
 162   //   return "", so we cannot use a "const std::string &".
 163   const char *getSection() const;
 164
 165   /// Global values are always pointers.
 166   inline PointerType *getType() const {
 167     return cast<PointerType>(User::getType());
 168   }
 169
 170   static LinkageTypes getLinkOnceLinkage(bool ODR) {
 171     return ODR ? LinkOnceODRLinkage : LinkOnceAnyLinkage;
 172   }
 173   static LinkageTypes getWeakLinkage(bool ODR) {
 174     return ODR ? WeakODRLinkage : WeakAnyLinkage;
 175   }
 176
 177   static bool isExternalLinkage(LinkageTypes Linkage) {
 178     return Linkage == ExternalLinkage;
 179   }
 180   static bool isAvailableExternallyLinkage(LinkageTypes Linkage) {
 181     return Linkage == AvailableExternallyLinkage;
 182   }
 183   static bool isLinkOnceLinkage(LinkageTypes Linkage) {
 184     return Linkage == LinkOnceAnyLinkage || Linkage == LinkOnceODRLinkage;
 185   }
 186   static bool isWeakAnyLinkage(LinkageTypes Linkage) {
 187     return Linkage == WeakAnyLinkage;
 188   }
 189   static bool isWeakODRLinkage(LinkageTypes Linkage) {
 190     return Linkage == WeakODRLinkage;
 191   }
 192   static bool isWeakLinkage(LinkageTypes Linkage) {
 193     return isWeakAnyLinkage(Linkage) || isWeakODRLinkage(Linkage);
 194   }
 195   static bool isAppendingLinkage(LinkageTypes Linkage) {
 196     return Linkage == AppendingLinkage;
 197   }
 198   static bool isInternalLinkage(LinkageTypes Linkage) {
 199     return Linkage == InternalLinkage;
 200   }
 201   static bool isPrivateLinkage(LinkageTypes Linkage) {
 202     return Linkage == PrivateLinkage;
 203   }
 204   static bool isLocalLinkage(LinkageTypes Linkage) {
 205     return isInternalLinkage(Linkage) || isPrivateLinkage(Linkage);
 206   }
 207   static bool isExternalWeakLinkage(LinkageTypes Linkage) {
 208     return Linkage == ExternalWeakLinkage;
 209   }
 210   static bool isCommonLinkage(LinkageTypes Linkage) {
 211     return Linkage == CommonLinkage;
 212   }
 213
 214   /// Whether the definition of this global may be discarded if it is not used
 215   /// in its compilation unit.
 216   static bool isDiscardableIfUnused(LinkageTypes Linkage) {
 217     return isLinkOnceLinkage(Linkage) || isLocalLinkage(Linkage);
 218   }
 219
 220   /// Whether the definition of this global may be replaced by something
 221   /// non-equivalent at link time. For example, if a function has weak linkage
 222   /// then the code defining it may be replaced by different code.
 223   static bool mayBeOverridden(LinkageTypes Linkage) {
 224     return Linkage == WeakAnyLinkage || Linkage == LinkOnceAnyLinkage ||
 225            Linkage == CommonLinkage || Linkage == ExternalWeakLinkage;
 226   }
 227
 228   /// Whether the definition of this global may be replaced at link time.  NB:
 229   /// Using this method outside of the code generators is almost always a
 230   /// mistake: when working at the IR level use mayBeOverridden instead as it
 231   /// knows about ODR semantics.
 232   static bool isWeakForLinker(LinkageTypes Linkage)  {
 233     return Linkage == AvailableExternallyLinkage || Linkage == WeakAnyLinkage ||
 234            Linkage == WeakODRLinkage || Linkage == LinkOnceAnyLinkage ||
 235            Linkage == LinkOnceODRLinkage || Linkage == CommonLinkage ||
 236            Linkage == ExternalWeakLinkage;
 237   }
 238
 239   bool hasExternalLinkage() const { return isExternalLinkage(Linkage); }
 240   bool hasAvailableExternallyLinkage() const {
 241     return isAvailableExternallyLinkage(Linkage);
 242   }
 243   bool hasLinkOnceLinkage() const {
 244     return isLinkOnceLinkage(Linkage);
 245   }
 246   bool hasWeakLinkage() const {
 247     return isWeakLinkage(Linkage);
 248   }
 249   bool hasWeakAnyLinkage() const {
 250     return isWeakAnyLinkage(Linkage);
 251   }
 252   bool hasWeakODRLinkage() const {
 253     return isWeakODRLinkage(Linkage);
 254   }
 255   bool hasAppendingLinkage() const { return isAppendingLinkage(Linkage); }
 256   bool hasInternalLinkage() const { return isInternalLinkage(Linkage); }
 257   bool hasPrivateLinkage() const { return isPrivateLinkage(Linkage); }
 258   bool hasLocalLinkage() const { return isLocalLinkage(Linkage); }
 259   bool hasExternalWeakLinkage() const { return isExternalWeakLinkage(Linkage); }
 260   bool hasCommonLinkage() const { return isCommonLinkage(Linkage); }
 261
 262   void setLinkage(LinkageTypes LT) {
 263     if (isLocalLinkage(LT))
 264       Visibility = DefaultVisibility;
 265     Linkage = LT;
 266   }
 267   LinkageTypes getLinkage() const { return Linkage; }
 268
 269   bool isDiscardableIfUnused() const {
 270     return isDiscardableIfUnused(Linkage);
 271   }
 272
 273   bool mayBeOverridden() const { return mayBeOverridden(Linkage); }
 274
 275   bool isWeakForLinker() const { return isWeakForLinker(Linkage); }
 276
 277   /// Copy all additional attributes (those not needed to create a GlobalValue)
 278   /// from the GlobalValue Src to this one.
 279   virtual void copyAttributesFrom(const GlobalValue *Src);
 280
 281   /// If special LLVM prefix that is used to inform the asm printer to not emit
 282   /// usual symbol prefix before the symbol name is used then return linkage
 283   /// name after skipping this special LLVM prefix.
 284   static StringRef getRealLinkageName(StringRef Name) {
 285     if (!Name.empty() && Name[0] == '\1')
 286       return Name.substr(1);
 287     return Name;
 288   }
 289
 290 /// @name Materialization
 291 /// Materialization is used to construct functions only as they're needed. This
 292 /// is useful to reduce memory usage in LLVM or parsing work done by the
 293 /// BitcodeReader to load the Module.
 294 /// @{
 295
 296   /// If this function's Module is being lazily streamed in functions from disk
 297   /// or some other source, this method can be used to check to see if the
 298   /// function has been read in yet or not.
 299   bool isMaterializable() const;
 300
 301   /// Returns true if this function was loaded from a GVMaterializer that's
 302   /// still attached to its Module and that knows how to dematerialize the
 303   /// function.
 304   bool isDematerializable() const;
 305
 306   /// Make sure this GlobalValue is fully read. If the module is corrupt, this
 307   /// returns true and fills in the optional string with information about the
 308   /// problem.  If successful, this returns false.
 309   bool Materialize(std::string *ErrInfo = nullptr);
 310
 311   /// If this GlobalValue is read in, and if the GVMaterializer supports it,
 312   /// release the memory for the function, and set it up to be materialized
 313   /// lazily. If !isDematerializable(), this method is a noop.
 314   void Dematerialize();
 315
 316 /// @}
 317
 318   /// Override from Constant class.
 319   void destroyConstant() override;
 320
 321   /// Return true if the primary definition of this global value is outside of
 322   /// the current translation unit.
 323   bool isDeclaration() const;
 324
 325   /// This method unlinks 'this' from the containing module, but does not delete
 326   /// it.
 327   virtual void removeFromParent() = 0;
 328
 329   /// This method unlinks 'this' from the containing module and deletes it.
 330   virtual void eraseFromParent() = 0;
 331
 332   /// Get the module that this global value is contained inside of...
 333   inline Module *getParent() { return Parent; }
 334   inline const Module *getParent() const { return Parent; }
 335
 336   const DataLayout *getDataLayout() const;
 337
 338   // Methods for support type inquiry through isa, cast, and dyn_cast:
 339   static inline bool classof(const Value *V) {
 340     return V->getValueID() == Value::FunctionVal ||
 341            V->getValueID() == Value::GlobalVariableVal ||
 342            V->getValueID() == Value::GlobalAliasVal;
 343   }
 344 };
 345
 346 } // End llvm namespace
 347
 348 #endif