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 #include "llvm/Support/Options.h"
  22
  23 namespace llvm {
  24
  25 class LLVMContextImpl;
  26 class StringRef;
  27 class Twine;
  28 class Instruction;
  29 class Module;
  30 class SMDiagnostic;
  31 class DiagnosticInfo;
  32 template <typename T> class SmallVectorImpl;
  33 class Function;
  34 class DebugLoc;
  35
  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.
  41 class LLVMContext {
  42 public:
  43   LLVMContextImpl *const pImpl;
  44   LLVMContext();
  45   ~LLVMContext();
  46
  47   // Pinned metadata names, which always have the same value.  This is a
  48   // compile-time performance optimization, not a correctness optimization.
  49   enum {
  50     MD_dbg = 0,  // "dbg"
  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   };
  67
  68   /// getMDKindID - Return a unique non-zero ID for the specified metadata kind.
  69   /// This ID is uniqued across modules in the current LLVMContext.
  70   unsigned getMDKindID(StringRef Name) const;
  71
  72   /// getMDKindNames - Populate client supplied SmallVector with the name for
  73   /// custom metadata IDs registered in this LLVMContext.
  74   void getMDKindNames(SmallVectorImpl<StringRef> &Result) const;
  75
  76
  77   typedef void (*InlineAsmDiagHandlerTy)(const SMDiagnostic&, void *Context,
  78                                          unsigned LocCookie);
  79
  80   /// Defines the type of a diagnostic handler.
  81   /// \see LLVMContext::setDiagnosticHandler.
  82   /// \see LLVMContext::diagnose.
  83   typedef void (*DiagnosticHandlerTy)(const DiagnosticInfo &DI, void *Context);
  84
  85   /// Defines the type of a yield callback.
  86   /// \see LLVMContext::setYieldCallback.
  87   typedef void (*YieldCallbackTy)(LLVMContext *Context, void *OpaqueHandle);
  88
  89   /// setInlineAsmDiagnosticHandler - This method sets a handler that is invoked
  90   /// when problems with inline asm are detected by the backend.  The first
  91   /// argument is a function pointer and the second is a context pointer that
  92   /// gets passed into the DiagHandler.
  93   ///
  94   /// LLVMContext doesn't take ownership or interpret either of these
  95   /// pointers.
  96   void setInlineAsmDiagnosticHandler(InlineAsmDiagHandlerTy DiagHandler,
  97                                      void *DiagContext = nullptr);
  98
  99   /// getInlineAsmDiagnosticHandler - Return the diagnostic handler set by
 100   /// setInlineAsmDiagnosticHandler.
 101   InlineAsmDiagHandlerTy getInlineAsmDiagnosticHandler() const;
 102
 103   /// getInlineAsmDiagnosticContext - Return the diagnostic context set by
 104   /// setInlineAsmDiagnosticHandler.
 105   void *getInlineAsmDiagnosticContext() const;
 106
 107   /// setDiagnosticHandler - This method sets a handler that is invoked
 108   /// when the backend needs to report anything to the user.  The first
 109   /// argument is a function pointer and the second is a context pointer that
 110   /// gets passed into the DiagHandler.  The third argument should be set to
 111   /// true if the handler only expects enabled diagnostics.
 112   ///
 113   /// LLVMContext doesn't take ownership or interpret either of these
 114   /// pointers.
 115   void setDiagnosticHandler(DiagnosticHandlerTy DiagHandler,
 116                             void *DiagContext = nullptr,
 117                             bool RespectFilters = false);
 118
 119   /// getDiagnosticHandler - Return the diagnostic handler set by
 120   /// setDiagnosticHandler.
 121   DiagnosticHandlerTy getDiagnosticHandler() const;
 122
 123   /// getDiagnosticContext - Return the diagnostic context set by
 124   /// setDiagnosticContext.
 125   void *getDiagnosticContext() const;
 126
 127   /// \brief Report a message to the currently installed diagnostic handler.
 128   ///
 129   /// This function returns, in particular in the case of error reporting
 130   /// (DI.Severity == \a DS_Error), so the caller should leave the compilation
 131   /// process in a self-consistent state, even though the generated code
 132   /// need not be correct.
 133   ///
 134   /// The diagnostic message will be implicitly prefixed with a severity keyword
 135   /// according to \p DI.getSeverity(), i.e., "error: " for \a DS_Error,
 136   /// "warning: " for \a DS_Warning, and "note: " for \a DS_Note.
 137   void diagnose(const DiagnosticInfo &DI);
 138
 139   /// \brief Registers a yield callback with the given context.
 140   ///
 141   /// The yield callback function may be called by LLVM to transfer control back
 142   /// to the client that invoked the LLVM compilation. This can be used to yield
 143   /// control of the thread, or perform periodic work needed by the client.
 144   /// There is no guaranteed frequency at which callbacks must occur; in fact,
 145   /// the client is not guaranteed to ever receive this callback. It is at the
 146   /// sole discretion of LLVM to do so and only if it can guarantee that
 147   /// suspending the thread won't block any forward progress in other LLVM
 148   /// contexts in the same process.
 149   ///
 150   /// At a suspend point, the state of the current LLVM context is intentionally
 151   /// undefined. No assumptions about it can or should be made. Only LLVM
 152   /// context API calls that explicitly state that they can be used during a
 153   /// yield callback are allowed to be used. Any other API calls into the
 154   /// context are not supported until the yield callback function returns
 155   /// control to LLVM. Other LLVM contexts are unaffected by this restriction.
 156   void setYieldCallback(YieldCallbackTy Callback, void *OpaqueHandle);
 157
 158   /// \brief Calls the yield callback (if applicable).
 159   ///
 160   /// This transfers control of the current thread back to the client, which may
 161   /// suspend the current thread. Only call this method when LLVM doesn't hold
 162   /// any global mutex or cannot block the execution in another LLVM context.
 163   void yield();
 164
 165   /// emitError - Emit an error message to the currently installed error handler
 166   /// with optional location information.  This function returns, so code should
 167   /// be prepared to drop the erroneous construct on the floor and "not crash".
 168   /// The generated code need not be correct.  The error message will be
 169   /// implicitly prefixed with "error: " and should not end with a ".".
 170   void emitError(unsigned LocCookie, const Twine &ErrorStr);
 171   void emitError(const Instruction *I, const Twine &ErrorStr);
 172   void emitError(const Twine &ErrorStr);
 173
 174   /// \brief Query for a debug option's value.
 175   ///
 176   /// This function returns typed data populated from command line parsing.
 177   template <typename ValT, typename Base, ValT(Base::*Mem)>
 178   ValT getOption() const {
 179     return OptionRegistry::instance().template get<ValT, Base, Mem>();
 180   }
 181
 182 private:
 183   LLVMContext(LLVMContext&) = delete;
 184   void operator=(LLVMContext&) = delete;
 185
 186   /// addModule - Register a module as being instantiated in this context.  If
 187   /// the context is deleted, the module will be deleted as well.
 188   void addModule(Module*);
 189
 190   /// removeModule - Unregister a module from this context.
 191   void removeModule(Module*);
 192
 193   // Module needs access to the add/removeModule methods.
 194   friend class Module;
 195 };
 196
 197 /// getGlobalContext - Returns a global context.  This is for LLVM clients that
 198 /// only care about operating on a single thread.
 199 extern LLVMContext &getGlobalContext();
 200
 201 // Create wrappers for C Binding types (see CBindingWrapping.h).
 202 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(LLVMContext, LLVMContextRef)
 203
 204 /* Specialized opaque context conversions.
 205  */
 206 inline LLVMContext **unwrap(LLVMContextRef* Tys) {
 207   return reinterpret_cast<LLVMContext**>(Tys);
 208 }
 209
 210 inline LLVMContextRef *wrap(const LLVMContext **Tys) {
 211   return reinterpret_cast<LLVMContextRef*>(const_cast<LLVMContext**>(Tys));
 212 }
 213
 214 }
 215
 216 #endif