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