diff options
Diffstat (limited to 'include')
| -rw-r--r-- | include/llvm/LLVMContext.h | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/include/llvm/LLVMContext.h b/include/llvm/LLVMContext.h index 018d777c01..398fae26dd 100644 --- a/include/llvm/LLVMContext.h +++ b/include/llvm/LLVMContext.h @@ -6,6 +6,11 @@ // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// +// +// This file declares LLVMContext, a container of "global" state in LLVM, such +// as the global type and constant uniquing tables. +// +//===----------------------------------------------------------------------===// #ifndef LLVM_LLVMCONTEXT_H #define LLVM_LLVMCONTEXT_H @@ -35,6 +40,11 @@ class APInt; class APFloat; class Value; +/// This is an important class for using LLVM in a threaded context. It +/// (opaquely) owns and manages the core "global" data of LLVM's core +/// infrastructure, including the type and constant uniquing tables. +/// LLVMContext itself provides no locking guarantees, so you should be careful +/// to have one context per thread. class LLVMContext { LLVMContextImpl* pImpl; public: |