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"
61 /// getMDKindID - Return a unique non-zero ID for the specified metadata kind.
62 /// This ID is uniqued across modules in the current LLVMContext.
63 unsigned getMDKindID(StringRef Name) const;
65 /// getMDKindNames - Populate client supplied SmallVector with the name for
66 /// custom metadata IDs registered in this LLVMContext.
67 void getMDKindNames(SmallVectorImpl<StringRef> &Result) const;
70 typedef void (*InlineAsmDiagHandlerTy)(const SMDiagnostic&, void *Context,
73 /// Defines the type of a diagnostic handler.
74 /// \see LLVMContext::setDiagnosticHandler.
75 /// \see LLVMContext::diagnose.
76 typedef void (*DiagnosticHandlerTy)(const DiagnosticInfo &DI, void *Context);
78 /// Defines the type of a yield callback.
79 /// \see LLVMContext::setYieldCallback.
80 typedef void (*YieldCallbackTy)(LLVMContext *Context, void *OpaqueHandle);
82 /// setInlineAsmDiagnosticHandler - This method sets a handler that is invoked
83 /// when problems with inline asm are detected by the backend. The first
84 /// argument is a function pointer and the second is a context pointer that
85 /// gets passed into the DiagHandler.
87 /// LLVMContext doesn't take ownership or interpret either of these
89 void setInlineAsmDiagnosticHandler(InlineAsmDiagHandlerTy DiagHandler,
90 void *DiagContext = nullptr);
92 /// getInlineAsmDiagnosticHandler - Return the diagnostic handler set by
93 /// setInlineAsmDiagnosticHandler.
94 InlineAsmDiagHandlerTy getInlineAsmDiagnosticHandler() const;
96 /// getInlineAsmDiagnosticContext - Return the diagnostic context set by
97 /// setInlineAsmDiagnosticHandler.
98 void *getInlineAsmDiagnosticContext() const;
100 /// setDiagnosticHandler - This method sets a handler that is invoked
101 /// when the backend needs to report anything to the user. The first
102 /// argument is a function pointer and the second is a context pointer that
103 /// gets passed into the DiagHandler. The third argument should be set to
104 /// true if the handler only expects enabled diagnostics.
106 /// LLVMContext doesn't take ownership or interpret either of these
108 void setDiagnosticHandler(DiagnosticHandlerTy DiagHandler,
109 void *DiagContext = nullptr,
110 bool RespectFilters = false);
112 /// getDiagnosticHandler - Return the diagnostic handler set by
113 /// setDiagnosticHandler.
114 DiagnosticHandlerTy getDiagnosticHandler() const;
116 /// getDiagnosticContext - Return the diagnostic context set by
117 /// setDiagnosticContext.
118 void *getDiagnosticContext() const;
120 /// \brief Report a message to the currently installed diagnostic handler.
122 /// This function returns, in particular in the case of error reporting
123 /// (DI.Severity == \a DS_Error), so the caller should leave the compilation
124 /// process in a self-consistent state, even though the generated code
125 /// need not be correct.
127 /// The diagnostic message will be implicitly prefixed with a severity keyword
128 /// according to \p DI.getSeverity(), i.e., "error: " for \a DS_Error,
129 /// "warning: " for \a DS_Warning, and "note: " for \a DS_Note.
130 void diagnose(const DiagnosticInfo &DI);
132 /// \brief Registers a yield callback with the given context.
134 /// The yield callback function may be called by LLVM to transfer control back
135 /// to the client that invoked the LLVM compilation. This can be used to yield
136 /// control of the thread, or perform periodic work needed by the client.
137 /// There is no guaranteed frequency at which callbacks must occur; in fact,
138 /// the client is not guaranteed to ever receive this callback. It is at the
139 /// sole discretion of LLVM to do so and only if it can guarantee that
140 /// suspending the thread won't block any forward progress in other LLVM
141 /// contexts in the same process.
143 /// At a suspend point, the state of the current LLVM context is intentionally
144 /// undefined. No assumptions about it can or should be made. Only LLVM
145 /// context API calls that explicitly state that they can be used during a
146 /// yield callback are allowed to be used. Any other API calls into the
147 /// context are not supported until the yield callback function returns
148 /// control to LLVM. Other LLVM contexts are unaffected by this restriction.
149 void setYieldCallback(YieldCallbackTy Callback, void *OpaqueHandle);
151 /// \brief Calls the yield callback (if applicable).
153 /// This transfers control of the current thread back to the client, which may
154 /// suspend the current thread. Only call this method when LLVM doesn't hold
155 /// any global mutex or cannot block the execution in another LLVM context.
158 /// emitError - Emit an error message to the currently installed error handler
159 /// with optional location information. This function returns, so code should
160 /// be prepared to drop the erroneous construct on the floor and "not crash".
161 /// The generated code need not be correct. The error message will be
162 /// implicitly prefixed with "error: " and should not end with a ".".
163 void emitError(unsigned LocCookie, const Twine &ErrorStr);
164 void emitError(const Instruction *I, const Twine &ErrorStr);
165 void emitError(const Twine &ErrorStr);
167 /// \brief Query for a debug option's value.
169 /// This function returns typed data populated from command line parsing.
170 template <typename ValT, typename Base, ValT(Base::*Mem)>
171 ValT getOption() const {
172 return OptionRegistry::instance().template get<ValT, Base, Mem>();
176 LLVMContext(LLVMContext&) LLVM_DELETED_FUNCTION;
177 void operator=(LLVMContext&) LLVM_DELETED_FUNCTION;
179 /// addModule - Register a module as being instantiated in this context. If
180 /// the context is deleted, the module will be deleted as well.
181 void addModule(Module*);
183 /// removeModule - Unregister a module from this context.
184 void removeModule(Module*);
186 // Module needs access to the add/removeModule methods.
190 /// getGlobalContext - Returns a global context. This is for LLVM clients that
191 /// only care about operating on a single thread.
192 extern LLVMContext &getGlobalContext();
194 // Create wrappers for C Binding types (see CBindingWrapping.h).
195 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef)
197 /* Specialized opaque context conversions.
199 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
200 return reinterpret_cast<LLVMContext**>(Tys);
203 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
204 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));