1 //===-- llvm/LLVMContext.h - Class for managing "global" state --*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares LLVMContext, a container of "global" state in LLVM, such
11 // as the global type and constant uniquing tables.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_LLVMCONTEXT_H
16 #define LLVM_LLVMCONTEXT_H
20 class LLVMContextImpl;
24 template <typename T> class SmallVectorImpl;
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.
33 LLVMContextImpl *const pImpl;
37 // Pinned metadata names, which always have the same value. This is a
38 // compile-time performance optimization, not a correctness optimization.
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;
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;
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.
57 /// LLVMContext doesn't take ownership or interpreter either of these
59 void setInlineAsmDiagnosticHandler(void *DiagHandler, void *DiagContext = 0);
61 /// getInlineAsmDiagnosticHandler - Return the diagnostic handler set by
62 /// setInlineAsmDiagnosticHandler.
63 void *getInlineAsmDiagnosticHandler() const;
65 /// getInlineAsmDiagnosticContext - Return the diagnostic context set by
66 /// setInlineAsmDiagnosticHandler.
67 void *getInlineAsmDiagnosticContext() const;
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);
81 LLVMContext(LLVMContext&);
82 void operator=(LLVMContext&);
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*);
88 /// removeModule - Unregister a module from this context.
89 void removeModule(Module*);
91 // Module needs access to the add/removeModule methods.
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();