Add isFOO() helpers. Fix getDirectory() and getFilename() for DIScope.
[oota-llvm.git] / include / llvm / GlobalValue.h
index b0e58d4451c7eb5e6983c37cfcd010ef0d31a35b..7b0de34d9cb6fd5c2dd218efc34d61665219238c 100644 (file)
@@ -31,15 +31,20 @@ public:
   /// @brief An enumeration for the kinds of linkage for global values.
   enum LinkageTypes {
     ExternalLinkage = 0,///< Externally visible function
-    LinkOnceLinkage,    ///< Keep one copy of function when linking (inline)
-    WeakLinkage,        ///< Keep one copy of named function when linking (weak)
+    AvailableExternallyLinkage, ///< Available for inspection, not emission.
+    LinkOnceAnyLinkage, ///< Keep one copy of function when linking (inline)
+    LinkOnceODRLinkage, ///< Same, but only replaced by something equivalent.
+    WeakAnyLinkage,     ///< Keep one copy of named function when linking (weak)
+    WeakODRLinkage,     ///< Same, but only replaced by something equivalent.
     AppendingLinkage,   ///< Special purpose, only applies to global arrays
-    InternalLinkage,    ///< Rename collisions when linking (static functions)
+    InternalLinkage,    ///< Rename collisions when linking (static functions).
+    PrivateLinkage,     ///< Like Internal, but omit from symbol table.
+    LinkerPrivateLinkage, ///< Like Private, but linker removes.
     DLLImportLinkage,   ///< Function to be imported from DLL
-    DLLExportLinkage,   ///< Function to be accessible from DLL
-    ExternalWeakLinkage,///< ExternalWeak linkage description
-    GhostLinkage,       ///< Stand-in functions for streaming fns from BC files
-    CommonLinkage       ///< Tentative definitions
+    DLLExportLinkage,   ///< Function to be accessible from DLL.
+    ExternalWeakLinkage,///< ExternalWeak linkage description.
+    GhostLinkage,       ///< Stand-in functions for streaming fns from BC files.
+    CommonLinkage       ///< Tentative definitions.
   };
 
   /// @brief An enumeration for the kinds of visibility of global values.
@@ -51,10 +56,10 @@ public:
 
 protected:
   GlobalValue(const Type *ty, ValueTy vty, Use *Ops, unsigned NumOps,
-              LinkageTypes linkage, const std::string &name = "")
+              LinkageTypes linkage, const Twine &Name = "")
     : Constant(ty, vty, Ops, NumOps), Parent(0),
       Linkage(linkage), Visibility(DefaultVisibility), Alignment(0) {
-    if (!name.empty()) setName(name);
+    setName(Name);
   }
 
   Module *Parent;
@@ -76,6 +81,7 @@ public:
   }
 
   VisibilityTypes getVisibility() const { return VisibilityTypes(Visibility); }
+  bool hasDefaultVisibility() const { return Visibility == DefaultVisibility; }
   bool hasHiddenVisibility() const { return Visibility == HiddenVisibility; }
   bool hasProtectedVisibility() const {
     return Visibility == ProtectedVisibility;
@@ -84,7 +90,7 @@ public:
   
   bool hasSection() const { return !Section.empty(); }
   const std::string &getSection() const { return Section; }
-  void setSection(const std::string &S) { Section = S; }
+  void setSection(const StringRef &S) { Section = S; }
   
   /// If the usage is empty (except transitively dead constants), then this
   /// global value can can be safely deleted since the destructor will
@@ -98,25 +104,58 @@ public:
     return reinterpret_cast<const PointerType*>(User::getType());
   }
 
-  bool hasExternalLinkage()   const { return Linkage == ExternalLinkage; }
-  bool hasLinkOnceLinkage()   const { return Linkage == LinkOnceLinkage; }
-  bool hasWeakLinkage()       const { return Linkage == WeakLinkage; }
-  bool hasCommonLinkage()     const { return Linkage == CommonLinkage; }
-  bool hasAppendingLinkage()  const { return Linkage == AppendingLinkage; }
-  bool hasInternalLinkage()   const { return Linkage == InternalLinkage; }
-  bool hasDLLImportLinkage()  const { return Linkage == DLLImportLinkage; }
-  bool hasDLLExportLinkage()  const { return Linkage == DLLExportLinkage; }
+  static LinkageTypes getLinkOnceLinkage(bool ODR) {
+    return ODR ? LinkOnceODRLinkage : LinkOnceAnyLinkage;
+  }
+  static LinkageTypes getWeakLinkage(bool ODR) {
+    return ODR ? WeakODRLinkage : WeakAnyLinkage;
+  }
+
+  bool hasExternalLinkage() const { return Linkage == ExternalLinkage; }
+  bool hasAvailableExternallyLinkage() const {
+    return Linkage == AvailableExternallyLinkage;
+  }
+  bool hasLinkOnceLinkage() const {
+    return Linkage == LinkOnceAnyLinkage || Linkage == LinkOnceODRLinkage;
+  }
+  bool hasWeakLinkage() const {
+    return Linkage == WeakAnyLinkage || Linkage == WeakODRLinkage;
+  }
+  bool hasAppendingLinkage() const { return Linkage == AppendingLinkage; }
+  bool hasInternalLinkage() const { return Linkage == InternalLinkage; }
+  bool hasPrivateLinkage() const { return Linkage == PrivateLinkage; }
+  bool hasLinkerPrivateLinkage() const { return Linkage==LinkerPrivateLinkage; }
+  bool hasLocalLinkage() const {
+    return hasInternalLinkage() || hasPrivateLinkage() ||
+      hasLinkerPrivateLinkage();
+  }
+  bool hasDLLImportLinkage() const { return Linkage == DLLImportLinkage; }
+  bool hasDLLExportLinkage() const { return Linkage == DLLExportLinkage; }
   bool hasExternalWeakLinkage() const { return Linkage == ExternalWeakLinkage; }
-  bool hasGhostLinkage()      const { return Linkage == GhostLinkage; }
+  bool hasGhostLinkage() const { return Linkage == GhostLinkage; }
+  bool hasCommonLinkage() const { return Linkage == CommonLinkage; }
+
   void setLinkage(LinkageTypes LT) { Linkage = LT; }
   LinkageTypes getLinkage() const { return Linkage; }
 
   /// mayBeOverridden - Whether the definition of this global may be replaced
-  /// at link time.  For example, if a function has weak linkage then the code
-  /// defining it may be replaced by different code.
+  /// by something non-equivalent at link time.  For example, if a function has
+  /// weak linkage then the code defining it may be replaced by different code.
   bool mayBeOverridden() const {
-    return (Linkage == WeakLinkage ||
-            Linkage == LinkOnceLinkage ||
+    return (Linkage == WeakAnyLinkage ||
+            Linkage == LinkOnceAnyLinkage ||
+            Linkage == CommonLinkage ||
+            Linkage == ExternalWeakLinkage);
+  }
+
+  /// isWeakForLinker - Whether the definition of this global may be replaced at
+  /// link time.
+  bool isWeakForLinker() const {
+    return (Linkage == AvailableExternallyLinkage ||
+            Linkage == WeakAnyLinkage ||
+            Linkage == WeakODRLinkage ||
+            Linkage == LinkOnceAnyLinkage ||
+            Linkage == LinkOnceODRLinkage ||
             Linkage == CommonLinkage ||
             Linkage == ExternalWeakLinkage);
   }
@@ -160,7 +199,7 @@ public:
   /// off of this global value, remove them.  This method is useful for clients
   /// that want to check to see if a global is unused, but don't want to deal
   /// with potentially dead constants hanging off of the globals.
-  void removeDeadConstantUsers();
+  void removeDeadConstantUsers() const;
 
   // Methods for support type inquiry through isa, cast, and dyn_cast:
   static inline bool classof(const GlobalValue *) { return true; }