1 //===-- llvm/GlobalValue.h - Class to represent a global value --*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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
16 //===----------------------------------------------------------------------===//
18 #ifndef LLVM_IR_GLOBALVALUE_H
19 #define LLVM_IR_GLOBALVALUE_H
21 #include "llvm/IR/Constant.h"
22 #include "llvm/IR/DerivedTypes.h"
23 #include <system_error>
35 class GlobalValue : public Constant {
36 GlobalValue(const GlobalValue &) = delete;
38 /// @brief An enumeration for the kinds of linkage for global values.
40 ExternalLinkage = 0,///< Externally visible function
41 AvailableExternallyLinkage, ///< Available for inspection, not emission.
42 LinkOnceAnyLinkage, ///< Keep one copy of function when linking (inline)
43 LinkOnceODRLinkage, ///< Same, but only replaced by something equivalent.
44 WeakAnyLinkage, ///< Keep one copy of named function when linking (weak)
45 WeakODRLinkage, ///< Same, but only replaced by something equivalent.
46 AppendingLinkage, ///< Special purpose, only applies to global arrays
47 InternalLinkage, ///< Rename collisions when linking (static functions).
48 PrivateLinkage, ///< Like Internal, but omit from symbol table.
49 ExternalWeakLinkage,///< ExternalWeak linkage description.
50 CommonLinkage ///< Tentative definitions.
53 /// @brief An enumeration for the kinds of visibility of global values.
54 enum VisibilityTypes {
55 DefaultVisibility = 0, ///< The GV is visible
56 HiddenVisibility, ///< The GV is hidden
57 ProtectedVisibility ///< The GV is protected
60 /// @brief Storage classes of global values for PE targets.
61 enum DLLStorageClassTypes {
62 DefaultStorageClass = 0,
63 DLLImportStorageClass = 1, ///< Function to be imported from DLL
64 DLLExportStorageClass = 2 ///< Function to be accessible from DLL.
68 GlobalValue(PointerType *Ty, ValueTy VTy, Use *Ops, unsigned NumOps,
69 LinkageTypes Linkage, const Twine &Name)
70 : Constant(Ty, VTy, Ops, NumOps), Linkage(Linkage),
71 Visibility(DefaultVisibility), UnnamedAddr(0),
72 DllStorageClass(DefaultStorageClass),
73 ThreadLocal(NotThreadLocal), IntID((Intrinsic::ID)0U), Parent(nullptr) {
77 // Note: VC++ treats enums as signed, so an extra bit is required to prevent
78 // Linkage and Visibility from turning into negative values.
79 LinkageTypes Linkage : 5; // The linkage of this global
80 unsigned Visibility : 2; // The visibility style of this global
81 unsigned UnnamedAddr : 1; // This value's address is not significant
82 unsigned DllStorageClass : 2; // DLL storage class
84 unsigned ThreadLocal : 3; // Is this symbol "Thread Local", if so, what is
88 // Give subclasses access to what otherwise would be wasted padding.
89 // (19 + 3 + 2 + 1 + 2 + 5) == 32.
90 unsigned SubClassData : 19;
93 /// \brief The intrinsic ID for this subclass (which must be a Function).
95 /// This member is defined by this class, but not used for anything.
96 /// Subclasses can use it to store their intrinsic ID, if they have one.
98 /// This is stored here to save space in Function on 64-bit hosts.
101 static const unsigned GlobalValueSubClassDataBits = 19;
102 unsigned getGlobalValueSubClassData() const {
105 void setGlobalValueSubClassData(unsigned V) {
106 assert(V < (1 << 19) && "It will not fit");
110 Module *Parent; // The containing module.
112 enum ThreadLocalMode {
114 GeneralDynamicTLSModel,
115 LocalDynamicTLSModel,
120 ~GlobalValue() override {
121 removeDeadConstantUsers(); // remove any dead constants using this.
124 unsigned getAlignment() const;
126 bool hasUnnamedAddr() const { return UnnamedAddr; }
127 void setUnnamedAddr(bool Val) { UnnamedAddr = Val; }
129 bool hasComdat() const { return getComdat() != nullptr; }
131 const Comdat *getComdat() const {
132 return const_cast<GlobalValue *>(this)->getComdat();
135 VisibilityTypes getVisibility() const { return VisibilityTypes(Visibility); }
136 bool hasDefaultVisibility() const { return Visibility == DefaultVisibility; }
137 bool hasHiddenVisibility() const { return Visibility == HiddenVisibility; }
138 bool hasProtectedVisibility() const {
139 return Visibility == ProtectedVisibility;
141 void setVisibility(VisibilityTypes V) {
142 assert((!hasLocalLinkage() || V == DefaultVisibility) &&
143 "local linkage requires default visibility");
147 /// If the value is "Thread Local", its value isn't shared by the threads.
148 bool isThreadLocal() const { return getThreadLocalMode() != NotThreadLocal; }
149 void setThreadLocal(bool Val) {
150 setThreadLocalMode(Val ? GeneralDynamicTLSModel : NotThreadLocal);
152 void setThreadLocalMode(ThreadLocalMode Val) {
153 assert(Val == NotThreadLocal || getValueID() != Value::FunctionVal);
156 ThreadLocalMode getThreadLocalMode() const {
157 return static_cast<ThreadLocalMode>(ThreadLocal);
160 DLLStorageClassTypes getDLLStorageClass() const {
161 return DLLStorageClassTypes(DllStorageClass);
163 bool hasDLLImportStorageClass() const {
164 return DllStorageClass == DLLImportStorageClass;
166 bool hasDLLExportStorageClass() const {
167 return DllStorageClass == DLLExportStorageClass;
169 void setDLLStorageClass(DLLStorageClassTypes C) { DllStorageClass = C; }
171 bool hasSection() const { return !StringRef(getSection()).empty(); }
172 // It is unfortunate that we have to use "char *" in here since this is
173 // always non NULL, but:
174 // * The C API expects a null terminated string, so we cannot use StringRef.
175 // * The C API expects us to own it, so we cannot use a std:string.
176 // * For GlobalAliases we can fail to find the section and we have to
177 // return "", so we cannot use a "const std::string &".
178 const char *getSection() const;
180 /// Global values are always pointers.
181 PointerType *getType() const { return cast<PointerType>(User::getType()); }
183 Type *getValueType() const { return getType()->getElementType(); }
185 static LinkageTypes getLinkOnceLinkage(bool ODR) {
186 return ODR ? LinkOnceODRLinkage : LinkOnceAnyLinkage;
188 static LinkageTypes getWeakLinkage(bool ODR) {
189 return ODR ? WeakODRLinkage : WeakAnyLinkage;
192 static bool isExternalLinkage(LinkageTypes Linkage) {
193 return Linkage == ExternalLinkage;
195 static bool isAvailableExternallyLinkage(LinkageTypes Linkage) {
196 return Linkage == AvailableExternallyLinkage;
198 static bool isLinkOnceODRLinkage(LinkageTypes Linkage) {
199 return Linkage == LinkOnceODRLinkage;
201 static bool isLinkOnceLinkage(LinkageTypes Linkage) {
202 return Linkage == LinkOnceAnyLinkage || Linkage == LinkOnceODRLinkage;
204 static bool isWeakAnyLinkage(LinkageTypes Linkage) {
205 return Linkage == WeakAnyLinkage;
207 static bool isWeakODRLinkage(LinkageTypes Linkage) {
208 return Linkage == WeakODRLinkage;
210 static bool isWeakLinkage(LinkageTypes Linkage) {
211 return isWeakAnyLinkage(Linkage) || isWeakODRLinkage(Linkage);
213 static bool isAppendingLinkage(LinkageTypes Linkage) {
214 return Linkage == AppendingLinkage;
216 static bool isInternalLinkage(LinkageTypes Linkage) {
217 return Linkage == InternalLinkage;
219 static bool isPrivateLinkage(LinkageTypes Linkage) {
220 return Linkage == PrivateLinkage;
222 static bool isLocalLinkage(LinkageTypes Linkage) {
223 return isInternalLinkage(Linkage) || isPrivateLinkage(Linkage);
225 static bool isExternalWeakLinkage(LinkageTypes Linkage) {
226 return Linkage == ExternalWeakLinkage;
228 static bool isCommonLinkage(LinkageTypes Linkage) {
229 return Linkage == CommonLinkage;
232 /// Whether the definition of this global may be discarded if it is not used
233 /// in its compilation unit.
234 static bool isDiscardableIfUnused(LinkageTypes Linkage) {
235 return isLinkOnceLinkage(Linkage) || isLocalLinkage(Linkage);
238 /// Whether the definition of this global may be replaced by something
239 /// non-equivalent at link time. For example, if a function has weak linkage
240 /// then the code defining it may be replaced by different code.
241 static bool mayBeOverridden(LinkageTypes Linkage) {
242 return Linkage == WeakAnyLinkage || Linkage == LinkOnceAnyLinkage ||
243 Linkage == CommonLinkage || Linkage == ExternalWeakLinkage;
246 /// Whether the definition of this global may be replaced at link time. NB:
247 /// Using this method outside of the code generators is almost always a
248 /// mistake: when working at the IR level use mayBeOverridden instead as it
249 /// knows about ODR semantics.
250 static bool isWeakForLinker(LinkageTypes Linkage) {
251 return Linkage == AvailableExternallyLinkage || Linkage == WeakAnyLinkage ||
252 Linkage == WeakODRLinkage || Linkage == LinkOnceAnyLinkage ||
253 Linkage == LinkOnceODRLinkage || Linkage == CommonLinkage ||
254 Linkage == ExternalWeakLinkage;
257 bool hasExternalLinkage() const { return isExternalLinkage(Linkage); }
258 bool hasAvailableExternallyLinkage() const {
259 return isAvailableExternallyLinkage(Linkage);
261 bool hasLinkOnceLinkage() const {
262 return isLinkOnceLinkage(Linkage);
264 bool hasLinkOnceODRLinkage() const { return isLinkOnceODRLinkage(Linkage); }
265 bool hasWeakLinkage() const {
266 return isWeakLinkage(Linkage);
268 bool hasWeakAnyLinkage() const {
269 return isWeakAnyLinkage(Linkage);
271 bool hasWeakODRLinkage() const {
272 return isWeakODRLinkage(Linkage);
274 bool hasAppendingLinkage() const { return isAppendingLinkage(Linkage); }
275 bool hasInternalLinkage() const { return isInternalLinkage(Linkage); }
276 bool hasPrivateLinkage() const { return isPrivateLinkage(Linkage); }
277 bool hasLocalLinkage() const { return isLocalLinkage(Linkage); }
278 bool hasExternalWeakLinkage() const { return isExternalWeakLinkage(Linkage); }
279 bool hasCommonLinkage() const { return isCommonLinkage(Linkage); }
281 void setLinkage(LinkageTypes LT) {
282 if (isLocalLinkage(LT))
283 Visibility = DefaultVisibility;
286 LinkageTypes getLinkage() const { return Linkage; }
288 bool isDiscardableIfUnused() const {
289 return isDiscardableIfUnused(Linkage);
292 bool mayBeOverridden() const { return mayBeOverridden(Linkage); }
294 bool isWeakForLinker() const { return isWeakForLinker(Linkage); }
296 /// Copy all additional attributes (those not needed to create a GlobalValue)
297 /// from the GlobalValue Src to this one.
298 virtual void copyAttributesFrom(const GlobalValue *Src);
300 /// If special LLVM prefix that is used to inform the asm printer to not emit
301 /// usual symbol prefix before the symbol name is used then return linkage
302 /// name after skipping this special LLVM prefix.
303 static StringRef getRealLinkageName(StringRef Name) {
304 if (!Name.empty() && Name[0] == '\1')
305 return Name.substr(1);
309 /// @name Materialization
310 /// Materialization is used to construct functions only as they're needed. This
311 /// is useful to reduce memory usage in LLVM or parsing work done by the
312 /// BitcodeReader to load the Module.
315 /// If this function's Module is being lazily streamed in functions from disk
316 /// or some other source, this method can be used to check to see if the
317 /// function has been read in yet or not.
318 bool isMaterializable() const;
320 /// Returns true if this function was loaded from a GVMaterializer that's
321 /// still attached to its Module and that knows how to dematerialize the
323 bool isDematerializable() const;
325 /// Make sure this GlobalValue is fully read. If the module is corrupt, this
326 /// returns true and fills in the optional string with information about the
327 /// problem. If successful, this returns false.
328 std::error_code materialize();
330 /// If this GlobalValue is read in, and if the GVMaterializer supports it,
331 /// release the memory for the function, and set it up to be materialized
332 /// lazily. If !isDematerializable(), this method is a noop.
333 void dematerialize();
337 /// Override from Constant class.
338 void destroyConstant() override;
340 /// Return true if the primary definition of this global value is outside of
341 /// the current translation unit.
342 bool isDeclaration() const;
344 bool isDeclarationForLinker() const {
345 if (hasAvailableExternallyLinkage())
348 return isDeclaration();
351 /// This method unlinks 'this' from the containing module, but does not delete
353 virtual void removeFromParent() = 0;
355 /// This method unlinks 'this' from the containing module and deletes it.
356 virtual void eraseFromParent() = 0;
358 /// Get the module that this global value is contained inside of...
359 Module *getParent() { return Parent; }
360 const Module *getParent() const { return Parent; }
362 // Methods for support type inquiry through isa, cast, and dyn_cast:
363 static bool classof(const Value *V) {
364 return V->getValueID() == Value::FunctionVal ||
365 V->getValueID() == Value::GlobalVariableVal ||
366 V->getValueID() == Value::GlobalAliasVal;
370 } // End llvm namespace