include/llvm/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_LLVMCONTEXT_H
  16 #define LLVM_LLVMCONTEXT_H
  17
  18 namespace llvm {
  19
  20 class LLVMContextImpl;
  21 class StringRef;
  22 class Instruction;
  23 class Module;
  24 template <typename T> class SmallVectorImpl;
  25
  26 /// This is an important class for using LLVM in a threaded context.  It
  27 /// (opaquely) owns and manages the core "global" data of LLVM's core
  28 /// infrastructure, including the type and constant uniquing tables.
  29 /// LLVMContext itself provides no locking guarantees, so you should be careful
  30 /// to have one context per thread.
  31 class LLVMContext {
  32 public:
  33   LLVMContextImpl *const pImpl;
  34   LLVMContext();
  35   ~LLVMContext();
  36
  37   // Pinned metadata names, which always have the same value.  This is a
  38   // compile-time performance optimization, not a correctness optimization.
  39   enum {
  40     MD_dbg = 0,  // "dbg"
  41     MD_tbaa = 1  // "tbaa"
  42   };
  43
  44   /// getMDKindID - Return a unique non-zero ID for the specified metadata kind.
  45   /// This ID is uniqued across modules in the current LLVMContext.
  46   unsigned getMDKindID(StringRef Name) const;
  47
  48   /// getMDKindNames - Populate client supplied SmallVector with the name for
  49   /// custom metadata IDs registered in this LLVMContext.
  50   void getMDKindNames(SmallVectorImpl<StringRef> &Result) const;
  51
  52   /// setInlineAsmDiagnosticHandler - This method sets a handler that is invoked
  53   /// when problems with inline asm are detected by the backend.  The first
  54   /// argument is a function pointer (of type SourceMgr::DiagHandlerTy) and the
  55   /// second is a context pointer that gets passed into the DiagHandler.
  56   ///
  57   /// LLVMContext doesn't take ownership or interpreter either of these
  58   /// pointers.
  59   void setInlineAsmDiagnosticHandler(void *DiagHandler, void *DiagContext = 0);
  60
  61   /// getInlineAsmDiagnosticHandler - Return the diagnostic handler set by
  62   /// setInlineAsmDiagnosticHandler.
  63   void *getInlineAsmDiagnosticHandler() const;
  64
  65   /// getInlineAsmDiagnosticContext - Return the diagnostic context set by
  66   /// setInlineAsmDiagnosticHandler.
  67   void *getInlineAsmDiagnosticContext() const;
  68
  69
  70   /// emitError - Emit an error message to the currently installed error handler
  71   /// with optional location information.  This function returns, so code should
  72   /// be prepared to drop the erroneous construct on the floor and "not crash".
  73   /// The generated code need not be correct.  The error message will be
  74   /// implicitly prefixed with "error: " and should not end with a ".".
  75   void emitError(unsigned LocCookie, StringRef ErrorStr);
  76   void emitError(const Instruction *I, StringRef ErrorStr);
  77   void emitError(StringRef ErrorStr);
  78
  79 private:
  80   // DO NOT IMPLEMENT
  81   LLVMContext(LLVMContext&);
  82   void operator=(LLVMContext&);
  83
  84   /// addModule - Register a module as being instantiated in this context.  If
  85   /// the context is deleted, the module will be deleted as well.
  86   void addModule(Module*);
  87
  88   /// removeModule - Unregister a module from this context.
  89   void removeModule(Module*);
  90
  91   // Module needs access to the add/removeModule methods.
  92   friend class Module;
  93 };
  94
  95 /// getGlobalContext - Returns a global context.  This is for LLVM clients that
  96 /// only care about operating on a single thread.
  97 extern LLVMContext &getGlobalContext();
  98
  99 }
 100
 101 #endif