1 //===-- llvm/LLVMContext.h - Class for managing "global" state --*- 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 declares LLVMContext, a container of "global" state in LLVM, such
11 // as the global type and constant uniquing tables.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_IR_LLVMCONTEXT_H
16 #define LLVM_IR_LLVMCONTEXT_H
18 #include "llvm-c/Core.h"
19 #include "llvm/Support/CBindingWrapping.h"
20 #include "llvm/Support/Compiler.h"
21 #include "llvm/Support/Options.h"
25 class LLVMContextImpl;
32 template <typename T> class SmallVectorImpl;
36 /// This is an important class for using LLVM in a threaded context. It
37 /// (opaquely) owns and manages the core "global" data of LLVM's core
38 /// infrastructure, including the type and constant uniquing tables.
39 /// LLVMContext itself provides no locking guarantees, so you should be careful
40 /// to have one context per thread.
43 LLVMContextImpl *const pImpl;
47 // Pinned metadata names, which always have the same value. This is a
48 // compile-time performance optimization, not a correctness optimization.
51 MD_tbaa = 1, // "tbaa"
52 MD_prof = 2, // "prof"
53 MD_fpmath = 3, // "fpmath"
54 MD_range = 4, // "range"
55 MD_tbaa_struct = 5, // "tbaa.struct"
56 MD_invariant_load = 6, // "invariant.load"
57 MD_alias_scope = 7, // "alias.scope"
58 MD_noalias = 8, // "noalias",
59 MD_nontemporal = 9, // "nontemporal"
60 MD_mem_parallel_loop_access = 10, // "llvm.mem.parallel_loop_access"
61 MD_nonnull = 11, // "nonnull"
62 MD_dereferenceable = 12, // "dereferenceable"
63 MD_dereferenceable_or_null = 13, // "dereferenceable_or_null"
64 MD_make_implicit = 14, // "make.implicit"
65 MD_unpredictable = 15, // "unpredictable"
66 MD_invariant_group = 16 // "invariant.group"
69 /// getMDKindID - Return a unique non-zero ID for the specified metadata kind.
70 /// This ID is uniqued across modules in the current LLVMContext.
71 unsigned getMDKindID(StringRef Name) const;
73 /// getMDKindNames - Populate client supplied SmallVector with the name for
74 /// custom metadata IDs registered in this LLVMContext.
75 void getMDKindNames(SmallVectorImpl<StringRef> &Result) const;
77 /// getOperandBundleTags - Populate client supplied SmallVector with the
78 /// bundle tags registered in this LLVMContext. The bundle tags are ordered
79 /// by increasing bundle IDs.
80 /// \see LLVMContext::getOperandBundleTagID
81 void getOperandBundleTags(SmallVectorImpl<StringRef> &Result) const;
83 /// getOperandBundleTagID - Maps a bundle tag to an integer ID. Every bundle
84 /// tag registered with an LLVMContext has an unique ID.
85 uint32_t getOperandBundleTagID(StringRef Tag) const;
87 typedef void (*InlineAsmDiagHandlerTy)(const SMDiagnostic&, void *Context,
90 /// Defines the type of a diagnostic handler.
91 /// \see LLVMContext::setDiagnosticHandler.
92 /// \see LLVMContext::diagnose.
93 typedef void (*DiagnosticHandlerTy)(const DiagnosticInfo &DI, void *Context);
95 /// Defines the type of a yield callback.
96 /// \see LLVMContext::setYieldCallback.
97 typedef void (*YieldCallbackTy)(LLVMContext *Context, void *OpaqueHandle);
99 /// setInlineAsmDiagnosticHandler - This method sets a handler that is invoked
100 /// when problems with inline asm are detected by the backend. The first
101 /// argument is a function pointer and the second is a context pointer that
102 /// gets passed into the DiagHandler.
104 /// LLVMContext doesn't take ownership or interpret either of these
106 void setInlineAsmDiagnosticHandler(InlineAsmDiagHandlerTy DiagHandler,
107 void *DiagContext = nullptr);
109 /// getInlineAsmDiagnosticHandler - Return the diagnostic handler set by
110 /// setInlineAsmDiagnosticHandler.
111 InlineAsmDiagHandlerTy getInlineAsmDiagnosticHandler() const;
113 /// getInlineAsmDiagnosticContext - Return the diagnostic context set by
114 /// setInlineAsmDiagnosticHandler.
115 void *getInlineAsmDiagnosticContext() const;
117 /// setDiagnosticHandler - This method sets a handler that is invoked
118 /// when the backend needs to report anything to the user. The first
119 /// argument is a function pointer and the second is a context pointer that
120 /// gets passed into the DiagHandler. The third argument should be set to
121 /// true if the handler only expects enabled diagnostics.
123 /// LLVMContext doesn't take ownership or interpret either of these
125 void setDiagnosticHandler(DiagnosticHandlerTy DiagHandler,
126 void *DiagContext = nullptr,
127 bool RespectFilters = false);
129 /// getDiagnosticHandler - Return the diagnostic handler set by
130 /// setDiagnosticHandler.
131 DiagnosticHandlerTy getDiagnosticHandler() const;
133 /// getDiagnosticContext - Return the diagnostic context set by
134 /// setDiagnosticContext.
135 void *getDiagnosticContext() const;
137 /// \brief Report a message to the currently installed diagnostic handler.
139 /// This function returns, in particular in the case of error reporting
140 /// (DI.Severity == \a DS_Error), so the caller should leave the compilation
141 /// process in a self-consistent state, even though the generated code
142 /// need not be correct.
144 /// The diagnostic message will be implicitly prefixed with a severity keyword
145 /// according to \p DI.getSeverity(), i.e., "error: " for \a DS_Error,
146 /// "warning: " for \a DS_Warning, and "note: " for \a DS_Note.
147 void diagnose(const DiagnosticInfo &DI);
149 /// \brief Registers a yield callback with the given context.
151 /// The yield callback function may be called by LLVM to transfer control back
152 /// to the client that invoked the LLVM compilation. This can be used to yield
153 /// control of the thread, or perform periodic work needed by the client.
154 /// There is no guaranteed frequency at which callbacks must occur; in fact,
155 /// the client is not guaranteed to ever receive this callback. It is at the
156 /// sole discretion of LLVM to do so and only if it can guarantee that
157 /// suspending the thread won't block any forward progress in other LLVM
158 /// contexts in the same process.
160 /// At a suspend point, the state of the current LLVM context is intentionally
161 /// undefined. No assumptions about it can or should be made. Only LLVM
162 /// context API calls that explicitly state that they can be used during a
163 /// yield callback are allowed to be used. Any other API calls into the
164 /// context are not supported until the yield callback function returns
165 /// control to LLVM. Other LLVM contexts are unaffected by this restriction.
166 void setYieldCallback(YieldCallbackTy Callback, void *OpaqueHandle);
168 /// \brief Calls the yield callback (if applicable).
170 /// This transfers control of the current thread back to the client, which may
171 /// suspend the current thread. Only call this method when LLVM doesn't hold
172 /// any global mutex or cannot block the execution in another LLVM context.
175 /// emitError - Emit an error message to the currently installed error handler
176 /// with optional location information. This function returns, so code should
177 /// be prepared to drop the erroneous construct on the floor and "not crash".
178 /// The generated code need not be correct. The error message will be
179 /// implicitly prefixed with "error: " and should not end with a ".".
180 void emitError(unsigned LocCookie, const Twine &ErrorStr);
181 void emitError(const Instruction *I, const Twine &ErrorStr);
182 void emitError(const Twine &ErrorStr);
184 /// \brief Query for a debug option's value.
186 /// This function returns typed data populated from command line parsing.
187 template <typename ValT, typename Base, ValT(Base::*Mem)>
188 ValT getOption() const {
189 return OptionRegistry::instance().template get<ValT, Base, Mem>();
193 LLVMContext(LLVMContext&) = delete;
194 void operator=(LLVMContext&) = delete;
196 /// addModule - Register a module as being instantiated in this context. If
197 /// the context is deleted, the module will be deleted as well.
198 void addModule(Module*);
200 /// removeModule - Unregister a module from this context.
201 void removeModule(Module*);
203 // Module needs access to the add/removeModule methods.
207 /// getGlobalContext - Returns a global context. This is for LLVM clients that
208 /// only care about operating on a single thread.
209 extern LLVMContext &getGlobalContext();
211 // Create wrappers for C Binding types (see CBindingWrapping.h).
212 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef)
214 /* Specialized opaque context conversions.
216 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
217 return reinterpret_cast<LLVMContext**>(Tys);
220 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
221 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));