LLVM API Documentation

LLVMContext.h
Go to the documentation of this file.
00001 //===-- llvm/LLVMContext.h - Class for managing "global" state --*- C++ -*-===//
00002 //
00003 //                     The LLVM Compiler Infrastructure
00004 //
00005 // This file is distributed under the University of Illinois Open Source
00006 // License. See LICENSE.TXT for details.
00007 //
00008 //===----------------------------------------------------------------------===//
00009 //
00010 // This file declares LLVMContext, a container of "global" state in LLVM, such
00011 // as the global type and constant uniquing tables.
00012 //
00013 //===----------------------------------------------------------------------===//
00014 
00015 #ifndef LLVM_IR_LLVMCONTEXT_H
00016 #define LLVM_IR_LLVMCONTEXT_H
00017 
00018 #include "llvm-c/Core.h"
00019 #include "llvm/Support/CBindingWrapping.h"
00020 #include "llvm/Support/Compiler.h"
00021 #include "llvm/Support/Options.h"
00022 
00023 namespace llvm {
00024 
00025 class LLVMContextImpl;
00026 class StringRef;
00027 class Twine;
00028 class Instruction;
00029 class Module;
00030 class SMDiagnostic;
00031 class DiagnosticInfo;
00032 template <typename T> class SmallVectorImpl;
00033 class Function;
00034 class DebugLoc;
00035 
00036 /// This is an important class for using LLVM in a threaded context.  It
00037 /// (opaquely) owns and manages the core "global" data of LLVM's core
00038 /// infrastructure, including the type and constant uniquing tables.
00039 /// LLVMContext itself provides no locking guarantees, so you should be careful
00040 /// to have one context per thread.
00041 class LLVMContext {
00042 public:
00043   LLVMContextImpl *const pImpl;
00044   LLVMContext();
00045   ~LLVMContext();
00046 
00047   // Pinned metadata names, which always have the same value.  This is a
00048   // compile-time performance optimization, not a correctness optimization.
00049   enum {
00050     MD_dbg = 0,  // "dbg"
00051     MD_tbaa = 1, // "tbaa"
00052     MD_prof = 2,  // "prof"
00053     MD_fpmath = 3,  // "fpmath"
00054     MD_range = 4, // "range"
00055     MD_tbaa_struct = 5, // "tbaa.struct"
00056     MD_invariant_load = 6, // "invariant.load"
00057     MD_alias_scope = 7, // "alias.scope"
00058     MD_noalias = 8, // "noalias",
00059     MD_nontemporal = 9, // "nontemporal"
00060     MD_mem_parallel_loop_access = 10, // "llvm.mem.parallel_loop_access"
00061     MD_nonnull = 11 // "nonnull"
00062   };
00063 
00064   /// getMDKindID - Return a unique non-zero ID for the specified metadata kind.
00065   /// This ID is uniqued across modules in the current LLVMContext.
00066   unsigned getMDKindID(StringRef Name) const;
00067 
00068   /// getMDKindNames - Populate client supplied SmallVector with the name for
00069   /// custom metadata IDs registered in this LLVMContext.
00070   void getMDKindNames(SmallVectorImpl<StringRef> &Result) const;
00071 
00072 
00073   typedef void (*InlineAsmDiagHandlerTy)(const SMDiagnostic&, void *Context,
00074                                          unsigned LocCookie);
00075 
00076   /// Defines the type of a diagnostic handler.
00077   /// \see LLVMContext::setDiagnosticHandler.
00078   /// \see LLVMContext::diagnose.
00079   typedef void (*DiagnosticHandlerTy)(const DiagnosticInfo &DI, void *Context);
00080 
00081   /// Defines the type of a yield callback.
00082   /// \see LLVMContext::setYieldCallback.
00083   typedef void (*YieldCallbackTy)(LLVMContext *Context, void *OpaqueHandle);
00084 
00085   /// setInlineAsmDiagnosticHandler - This method sets a handler that is invoked
00086   /// when problems with inline asm are detected by the backend.  The first
00087   /// argument is a function pointer and the second is a context pointer that
00088   /// gets passed into the DiagHandler.
00089   ///
00090   /// LLVMContext doesn't take ownership or interpret either of these
00091   /// pointers.
00092   void setInlineAsmDiagnosticHandler(InlineAsmDiagHandlerTy DiagHandler,
00093                                      void *DiagContext = nullptr);
00094 
00095   /// getInlineAsmDiagnosticHandler - Return the diagnostic handler set by
00096   /// setInlineAsmDiagnosticHandler.
00097   InlineAsmDiagHandlerTy getInlineAsmDiagnosticHandler() const;
00098 
00099   /// getInlineAsmDiagnosticContext - Return the diagnostic context set by
00100   /// setInlineAsmDiagnosticHandler.
00101   void *getInlineAsmDiagnosticContext() const;
00102 
00103   /// setDiagnosticHandler - This method sets a handler that is invoked
00104   /// when the backend needs to report anything to the user.  The first
00105   /// argument is a function pointer and the second is a context pointer that
00106   /// gets passed into the DiagHandler.  The third argument should be set to
00107   /// true if the handler only expects enabled diagnostics.
00108   ///
00109   /// LLVMContext doesn't take ownership or interpret either of these
00110   /// pointers.
00111   void setDiagnosticHandler(DiagnosticHandlerTy DiagHandler,
00112                             void *DiagContext = nullptr,
00113                             bool RespectFilters = false);
00114 
00115   /// getDiagnosticHandler - Return the diagnostic handler set by
00116   /// setDiagnosticHandler.
00117   DiagnosticHandlerTy getDiagnosticHandler() const;
00118 
00119   /// getDiagnosticContext - Return the diagnostic context set by
00120   /// setDiagnosticContext.
00121   void *getDiagnosticContext() const;
00122 
00123   /// \brief Report a message to the currently installed diagnostic handler.
00124   ///
00125   /// This function returns, in particular in the case of error reporting
00126   /// (DI.Severity == \a DS_Error), so the caller should leave the compilation
00127   /// process in a self-consistent state, even though the generated code
00128   /// need not be correct.
00129   ///
00130   /// The diagnostic message will be implicitly prefixed with a severity keyword
00131   /// according to \p DI.getSeverity(), i.e., "error: " for \a DS_Error,
00132   /// "warning: " for \a DS_Warning, and "note: " for \a DS_Note.
00133   void diagnose(const DiagnosticInfo &DI);
00134 
00135   /// \brief Registers a yield callback with the given context.
00136   ///
00137   /// The yield callback function may be called by LLVM to transfer control back
00138   /// to the client that invoked the LLVM compilation. This can be used to yield
00139   /// control of the thread, or perform periodic work needed by the client.
00140   /// There is no guaranteed frequency at which callbacks must occur; in fact,
00141   /// the client is not guaranteed to ever receive this callback. It is at the
00142   /// sole discretion of LLVM to do so and only if it can guarantee that
00143   /// suspending the thread won't block any forward progress in other LLVM
00144   /// contexts in the same process.
00145   ///
00146   /// At a suspend point, the state of the current LLVM context is intentionally
00147   /// undefined. No assumptions about it can or should be made. Only LLVM
00148   /// context API calls that explicitly state that they can be used during a
00149   /// yield callback are allowed to be used. Any other API calls into the
00150   /// context are not supported until the yield callback function returns
00151   /// control to LLVM. Other LLVM contexts are unaffected by this restriction.
00152   void setYieldCallback(YieldCallbackTy Callback, void *OpaqueHandle);
00153 
00154   /// \brief Calls the yield callback (if applicable).
00155   ///
00156   /// This transfers control of the current thread back to the client, which may
00157   /// suspend the current thread. Only call this method when LLVM doesn't hold
00158   /// any global mutex or cannot block the execution in another LLVM context.
00159   void yield();
00160 
00161   /// emitError - Emit an error message to the currently installed error handler
00162   /// with optional location information.  This function returns, so code should
00163   /// be prepared to drop the erroneous construct on the floor and "not crash".
00164   /// The generated code need not be correct.  The error message will be
00165   /// implicitly prefixed with "error: " and should not end with a ".".
00166   void emitError(unsigned LocCookie, const Twine &ErrorStr);
00167   void emitError(const Instruction *I, const Twine &ErrorStr);
00168   void emitError(const Twine &ErrorStr);
00169 
00170   /// \brief Query for a debug option's value.
00171   ///
00172   /// This function returns typed data populated from command line parsing.
00173   template <typename ValT, typename Base, ValT(Base::*Mem)>
00174   ValT getOption() const {
00175     return OptionRegistry::instance().template get<ValT, Base, Mem>();
00176   }
00177 
00178 private:
00179   LLVMContext(LLVMContext&) LLVM_DELETED_FUNCTION;
00180   void operator=(LLVMContext&) LLVM_DELETED_FUNCTION;
00181 
00182   /// addModule - Register a module as being instantiated in this context.  If
00183   /// the context is deleted, the module will be deleted as well.
00184   void addModule(Module*);
00185 
00186   /// removeModule - Unregister a module from this context.
00187   void removeModule(Module*);
00188 
00189   // Module needs access to the add/removeModule methods.
00190   friend class Module;
00191 };
00192 
00193 /// getGlobalContext - Returns a global context.  This is for LLVM clients that
00194 /// only care about operating on a single thread.
00195 extern LLVMContext &getGlobalContext();
00196 
00197 // Create wrappers for C Binding types (see CBindingWrapping.h).
00198 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef)
00199 
00200 /* Specialized opaque context conversions.
00201  */
00202 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
00203   return reinterpret_cast<LLVMContext**>(Tys);
00204 }
00205 
00206 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
00207   return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
00208 }
00209 
00210 }
00211 
00212 #endif