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"
24 class LLVMContextImpl;
31 template <typename T> class SmallVectorImpl;
35 /// This is an important class for using LLVM in a threaded context. It
36 /// (opaquely) owns and manages the core "global" data of LLVM's core
37 /// infrastructure, including the type and constant uniquing tables.
38 /// LLVMContext itself provides no locking guarantees, so you should be careful
39 /// to have one context per thread.
42 LLVMContextImpl *const pImpl;
46 // Pinned metadata names, which always have the same value. This is a
47 // compile-time performance optimization, not a correctness optimization.
50 MD_tbaa = 1, // "tbaa"
51 MD_prof = 2, // "prof"
52 MD_fpmath = 3, // "fpmath"
53 MD_range = 4, // "range"
54 MD_tbaa_struct = 5, // "tbaa.struct"
55 MD_invariant_load = 6, // "invariant.load"
56 MD_alias_scope = 7, // "alias.scope"
57 MD_noalias = 8 // "noalias"
60 /// getMDKindID - Return a unique non-zero ID for the specified metadata kind.
61 /// This ID is uniqued across modules in the current LLVMContext.
62 unsigned getMDKindID(StringRef Name) const;
64 /// getMDKindNames - Populate client supplied SmallVector with the name for
65 /// custom metadata IDs registered in this LLVMContext.
66 void getMDKindNames(SmallVectorImpl<StringRef> &Result) const;
69 typedef void (*InlineAsmDiagHandlerTy)(const SMDiagnostic&, void *Context,
72 /// Defines the type of a diagnostic handler.
73 /// \see LLVMContext::setDiagnosticHandler.
74 /// \see LLVMContext::diagnose.
75 typedef void (*DiagnosticHandlerTy)(const DiagnosticInfo &DI, void *Context);
77 /// Defines the type of a yield callback.
78 /// \see LLVMContext::setYieldCallback.
79 typedef void (*YieldCallbackTy)(LLVMContext *Context, void *OpaqueHandle);
81 /// setInlineAsmDiagnosticHandler - This method sets a handler that is invoked
82 /// when problems with inline asm are detected by the backend. The first
83 /// argument is a function pointer and the second is a context pointer that
84 /// gets passed into the DiagHandler.
86 /// LLVMContext doesn't take ownership or interpret either of these
88 void setInlineAsmDiagnosticHandler(InlineAsmDiagHandlerTy DiagHandler,
89 void *DiagContext = nullptr);
91 /// getInlineAsmDiagnosticHandler - Return the diagnostic handler set by
92 /// setInlineAsmDiagnosticHandler.
93 InlineAsmDiagHandlerTy getInlineAsmDiagnosticHandler() const;
95 /// getInlineAsmDiagnosticContext - Return the diagnostic context set by
96 /// setInlineAsmDiagnosticHandler.
97 void *getInlineAsmDiagnosticContext() const;
99 /// setDiagnosticHandler - This method sets a handler that is invoked
100 /// when the backend needs to report anything to the user. 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 setDiagnosticHandler(DiagnosticHandlerTy DiagHandler,
107 void *DiagContext = nullptr);
109 /// getDiagnosticHandler - Return the diagnostic handler set by
110 /// setDiagnosticHandler.
111 DiagnosticHandlerTy getDiagnosticHandler() const;
113 /// getDiagnosticContext - Return the diagnostic context set by
114 /// setDiagnosticContext.
115 void *getDiagnosticContext() const;
117 /// \brief Report a message to the currently installed diagnostic handler.
119 /// This function returns, in particular in the case of error reporting
120 /// (DI.Severity == \a DS_Error), so the caller should leave the compilation
121 /// process in a self-consistent state, even though the generated code
122 /// need not be correct.
124 /// The diagnostic message will be implicitly prefixed with a severity keyword
125 /// according to \p DI.getSeverity(), i.e., "error: " for \a DS_Error,
126 /// "warning: " for \a DS_Warning, and "note: " for \a DS_Note.
127 void diagnose(const DiagnosticInfo &DI);
129 /// \brief Registers a yield callback with the given context.
131 /// The yield callback function may be called by LLVM to transfer control back
132 /// to the client that invoked the LLVM compilation. This can be used to yield
133 /// control of the thread, or perform periodic work needed by the client.
134 /// There is no guaranteed frequency at which callbacks must occur; in fact,
135 /// the client is not guaranteed to ever receive this callback. It is at the
136 /// sole discretion of LLVM to do so and only if it can guarantee that
137 /// suspending the thread won't block any forward progress in other LLVM
138 /// contexts in the same process.
140 /// At a suspend point, the state of the current LLVM context is intentionally
141 /// undefined. No assumptions about it can or should be made. Only LLVM
142 /// context API calls that explicitly state that they can be used during a
143 /// yield callback are allowed to be used. Any other API calls into the
144 /// context are not supported until the yield callback function returns
145 /// control to LLVM. Other LLVM contexts are unaffected by this restriction.
146 void setYieldCallback(YieldCallbackTy Callback, void *OpaqueHandle);
148 /// \brief Calls the yield callback (if applicable).
150 /// This transfers control of the current thread back to the client, which may
151 /// suspend the current thread. Only call this method when LLVM doesn't hold
152 /// any global mutex or cannot block the execution in another LLVM context.
155 /// emitError - Emit an error message to the currently installed error handler
156 /// with optional location information. This function returns, so code should
157 /// be prepared to drop the erroneous construct on the floor and "not crash".
158 /// The generated code need not be correct. The error message will be
159 /// implicitly prefixed with "error: " and should not end with a ".".
160 void emitError(unsigned LocCookie, const Twine &ErrorStr);
161 void emitError(const Instruction *I, const Twine &ErrorStr);
162 void emitError(const Twine &ErrorStr);
165 LLVMContext(LLVMContext&) LLVM_DELETED_FUNCTION;
166 void operator=(LLVMContext&) LLVM_DELETED_FUNCTION;
168 /// addModule - Register a module as being instantiated in this context. If
169 /// the context is deleted, the module will be deleted as well.
170 void addModule(Module*);
172 /// removeModule - Unregister a module from this context.
173 void removeModule(Module*);
175 // Module needs access to the add/removeModule methods.
179 /// getGlobalContext - Returns a global context. This is for LLVM clients that
180 /// only care about operating on a single thread.
181 extern LLVMContext &getGlobalContext();
183 // Create wrappers for C Binding types (see CBindingWrapping.h).
184 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef)
186 /* Specialized opaque context conversions.
188 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
189 return reinterpret_cast<LLVMContext**>(Tys);
192 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
193 return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));