include/llvm/IR/LLVMContext.h

   1 //===-- llvm/LLVMContext.h - Class for managing "global" state --*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file declares LLVMContext, a container of "global" state in LLVM, such
  11 // as the global type and constant uniquing tables.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_IR_LLVMCONTEXT_H
  16 #define LLVM_IR_LLVMCONTEXT_H
  17
  18 #include "llvm-c/Core.h"
  19 #include "llvm/Support/CBindingWrapping.h"
  20 #include "llvm/Support/Compiler.h"
  21
  22 namespace llvm {
  23
  24 class LLVMContextImpl;
  25 class StringRef;
  26 class Twine;
  27 class Instruction;
  28 class Module;
  29 class SMDiagnostic;
  30 class DiagnosticInfo;
  31 template <typename T> class SmallVectorImpl;
  32 class Function;
  33 class DebugLoc;
  34
  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.
  40 class LLVMContext {
  41 public:
  42   LLVMContextImpl *const pImpl;
  43   LLVMContext();
  44   ~LLVMContext();
  45
  46   // Pinned metadata names, which always have the same value.  This is a
  47   // compile-time performance optimization, not a correctness optimization.
  48   enum {
  49     MD_dbg = 0,  // "dbg"
  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"
  58   };
  59
  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;
  63
  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;
  67
  68
  69   typedef void (*InlineAsmDiagHandlerTy)(const SMDiagnostic&, void *Context,
  70                                          unsigned LocCookie);
  71
  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);
  76
  77   /// Defines the type of a yield callback.
  78   /// \see LLVMContext::setYieldCallback.
  79   typedef void (*YieldCallbackTy)(LLVMContext *Context, void *OpaqueHandle);
  80
  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.
  85   ///
  86   /// LLVMContext doesn't take ownership or interpret either of these
  87   /// pointers.
  88   void setInlineAsmDiagnosticHandler(InlineAsmDiagHandlerTy DiagHandler,
  89                                      void *DiagContext = nullptr);
  90
  91   /// getInlineAsmDiagnosticHandler - Return the diagnostic handler set by
  92   /// setInlineAsmDiagnosticHandler.
  93   InlineAsmDiagHandlerTy getInlineAsmDiagnosticHandler() const;
  94
  95   /// getInlineAsmDiagnosticContext - Return the diagnostic context set by
  96   /// setInlineAsmDiagnosticHandler.
  97   void *getInlineAsmDiagnosticContext() const;
  98
  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.  The third argument should be set to
 103   /// true if the handler only expects enabled diagnostics.
 104   ///
 105   /// LLVMContext doesn't take ownership or interpret either of these
 106   /// pointers.
 107   void setDiagnosticHandler(DiagnosticHandlerTy DiagHandler,
 108                             void *DiagContext = nullptr,
 109                             bool RespectFilters = false);
 110
 111   /// getDiagnosticHandler - Return the diagnostic handler set by
 112   /// setDiagnosticHandler.
 113   DiagnosticHandlerTy getDiagnosticHandler() const;
 114
 115   /// getDiagnosticContext - Return the diagnostic context set by
 116   /// setDiagnosticContext.
 117   void *getDiagnosticContext() const;
 118
 119   /// \brief Report a message to the currently installed diagnostic handler.
 120   ///
 121   /// This function returns, in particular in the case of error reporting
 122   /// (DI.Severity == \a DS_Error), so the caller should leave the compilation
 123   /// process in a self-consistent state, even though the generated code
 124   /// need not be correct.
 125   ///
 126   /// The diagnostic message will be implicitly prefixed with a severity keyword
 127   /// according to \p DI.getSeverity(), i.e., "error: " for \a DS_Error,
 128   /// "warning: " for \a DS_Warning, and "note: " for \a DS_Note.
 129   void diagnose(const DiagnosticInfo &DI);
 130
 131   /// \brief Registers a yield callback with the given context.
 132   ///
 133   /// The yield callback function may be called by LLVM to transfer control back
 134   /// to the client that invoked the LLVM compilation. This can be used to yield
 135   /// control of the thread, or perform periodic work needed by the client.
 136   /// There is no guaranteed frequency at which callbacks must occur; in fact,
 137   /// the client is not guaranteed to ever receive this callback. It is at the
 138   /// sole discretion of LLVM to do so and only if it can guarantee that
 139   /// suspending the thread won't block any forward progress in other LLVM
 140   /// contexts in the same process.
 141   ///
 142   /// At a suspend point, the state of the current LLVM context is intentionally
 143   /// undefined. No assumptions about it can or should be made. Only LLVM
 144   /// context API calls that explicitly state that they can be used during a
 145   /// yield callback are allowed to be used. Any other API calls into the
 146   /// context are not supported until the yield callback function returns
 147   /// control to LLVM. Other LLVM contexts are unaffected by this restriction.
 148   void setYieldCallback(YieldCallbackTy Callback, void *OpaqueHandle);
 149
 150   /// \brief Calls the yield callback (if applicable).
 151   ///
 152   /// This transfers control of the current thread back to the client, which may
 153   /// suspend the current thread. Only call this method when LLVM doesn't hold
 154   /// any global mutex or cannot block the execution in another LLVM context.
 155   void yield();
 156
 157   /// emitError - Emit an error message to the currently installed error handler
 158   /// with optional location information.  This function returns, so code should
 159   /// be prepared to drop the erroneous construct on the floor and "not crash".
 160   /// The generated code need not be correct.  The error message will be
 161   /// implicitly prefixed with "error: " and should not end with a ".".
 162   void emitError(unsigned LocCookie, const Twine &ErrorStr);
 163   void emitError(const Instruction *I, const Twine &ErrorStr);
 164   void emitError(const Twine &ErrorStr);
 165
 166 private:
 167   LLVMContext(LLVMContext&) LLVM_DELETED_FUNCTION;
 168   void operator=(LLVMContext&) LLVM_DELETED_FUNCTION;
 169
 170   /// addModule - Register a module as being instantiated in this context.  If
 171   /// the context is deleted, the module will be deleted as well.
 172   void addModule(Module*);
 173
 174   /// removeModule - Unregister a module from this context.
 175   void removeModule(Module*);
 176
 177   // Module needs access to the add/removeModule methods.
 178   friend class Module;
 179 };
 180
 181 /// getGlobalContext - Returns a global context.  This is for LLVM clients that
 182 /// only care about operating on a single thread.
 183 extern LLVMContext &getGlobalContext();
 184
 185 // Create wrappers for C Binding types (see CBindingWrapping.h).
 186 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef)
 187
 188 /* Specialized opaque context conversions.
 189  */
 190 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
 191   return reinterpret_cast<LLVMContext**>(Tys);
 192 }
 193
 194 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
 195   return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
 196 }
 197
 198 }
 199
 200 #endif