1 //===-- LLVMContext.cpp - Implement LLVMContext ---------------------------===//
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 implements LLVMContext, as a wrapper around the opaque
11 // class LLVMContextImpl.
13 //===----------------------------------------------------------------------===//
15 #include "llvm/IR/LLVMContext.h"
16 #include "LLVMContextImpl.h"
17 #include "llvm/IR/Constants.h"
18 #include "llvm/IR/DebugLoc.h"
19 #include "llvm/IR/DiagnosticInfo.h"
20 #include "llvm/IR/DiagnosticPrinter.h"
21 #include "llvm/IR/Instruction.h"
22 #include "llvm/IR/Metadata.h"
23 #include "llvm/Support/ManagedStatic.h"
24 #include "llvm/Support/SourceMgr.h"
28 static ManagedStatic<LLVMContext> GlobalContext;
30 LLVMContext& llvm::getGlobalContext() {
31 return *GlobalContext;
34 LLVMContext::LLVMContext() : pImpl(new LLVMContextImpl(*this)) {
35 // Create the fixed metadata kinds. This is done in the same order as the
36 // MD_* enum values so that they correspond.
38 // Create the 'dbg' metadata kind.
39 unsigned DbgID = getMDKindID("dbg");
40 assert(DbgID == MD_dbg && "dbg kind id drifted"); (void)DbgID;
42 // Create the 'tbaa' metadata kind.
43 unsigned TBAAID = getMDKindID("tbaa");
44 assert(TBAAID == MD_tbaa && "tbaa kind id drifted"); (void)TBAAID;
46 // Create the 'prof' metadata kind.
47 unsigned ProfID = getMDKindID("prof");
48 assert(ProfID == MD_prof && "prof kind id drifted"); (void)ProfID;
50 // Create the 'fpmath' metadata kind.
51 unsigned FPAccuracyID = getMDKindID("fpmath");
52 assert(FPAccuracyID == MD_fpmath && "fpmath kind id drifted");
55 // Create the 'range' metadata kind.
56 unsigned RangeID = getMDKindID("range");
57 assert(RangeID == MD_range && "range kind id drifted");
60 // Create the 'tbaa.struct' metadata kind.
61 unsigned TBAAStructID = getMDKindID("tbaa.struct");
62 assert(TBAAStructID == MD_tbaa_struct && "tbaa.struct kind id drifted");
65 // Create the 'invariant.load' metadata kind.
66 unsigned InvariantLdId = getMDKindID("invariant.load");
67 assert(InvariantLdId == MD_invariant_load && "invariant.load kind id drifted");
70 // Create the 'alias.scope' metadata kind.
71 unsigned AliasScopeID = getMDKindID("alias.scope");
72 assert(AliasScopeID == MD_alias_scope && "alias.scope kind id drifted");
75 // Create the 'noalias' metadata kind.
76 unsigned NoAliasID = getMDKindID("noalias");
77 assert(NoAliasID == MD_noalias && "noalias kind id drifted");
80 // Create the 'nontemporal' metadata kind.
81 unsigned NonTemporalID = getMDKindID("nontemporal");
82 assert(NonTemporalID == MD_nontemporal && "nontemporal kind id drifted");
85 // Create the 'llvm.mem.parallel_loop_access' metadata kind.
86 unsigned MemParallelLoopAccessID = getMDKindID("llvm.mem.parallel_loop_access");
87 assert(MemParallelLoopAccessID == MD_mem_parallel_loop_access &&
88 "mem_parallel_loop_access kind id drifted");
89 (void)MemParallelLoopAccessID;
91 // Create the 'nonnull' metadata kind.
92 unsigned NonNullID = getMDKindID("nonnull");
93 assert(NonNullID == MD_nonnull && "nonnull kind id drifted");
96 // Create the 'dereferenceable' metadata kind.
97 unsigned DereferenceableID = getMDKindID("dereferenceable");
98 assert(DereferenceableID == MD_dereferenceable &&
99 "dereferenceable kind id drifted");
100 (void)DereferenceableID;
102 // Create the 'dereferenceable_or_null' metadata kind.
103 unsigned DereferenceableOrNullID = getMDKindID("dereferenceable_or_null");
104 assert(DereferenceableOrNullID == MD_dereferenceable_or_null &&
105 "dereferenceable_or_null kind id drifted");
106 (void)DereferenceableOrNullID;
108 // Create the 'make.implicit' metadata kind.
109 unsigned MakeImplicitID = getMDKindID("make.implicit");
110 assert(MakeImplicitID == MD_make_implicit &&
111 "make.implicit kind id drifted");
112 (void)MakeImplicitID;
114 // Create the 'unpredictable' metadata kind.
115 unsigned UnpredictableID = getMDKindID("unpredictable");
116 assert(UnpredictableID == MD_unpredictable &&
117 "unpredictable kind id drifted");
118 (void)UnpredictableID;
120 // Create the 'invariant.group' metadata kind.
121 unsigned InvariantGroupId = getMDKindID("invariant.group");
122 assert(InvariantGroupId == MD_invariant_group &&
123 "invariant.group kind id drifted");
124 (void)InvariantGroupId;
127 LLVMContext::~LLVMContext() { delete pImpl; }
129 void LLVMContext::addModule(Module *M) {
130 pImpl->OwnedModules.insert(M);
133 void LLVMContext::removeModule(Module *M) {
134 pImpl->OwnedModules.erase(M);
137 //===----------------------------------------------------------------------===//
138 // Recoverable Backend Errors
139 //===----------------------------------------------------------------------===//
142 setInlineAsmDiagnosticHandler(InlineAsmDiagHandlerTy DiagHandler,
144 pImpl->InlineAsmDiagHandler = DiagHandler;
145 pImpl->InlineAsmDiagContext = DiagContext;
148 /// getInlineAsmDiagnosticHandler - Return the diagnostic handler set by
149 /// setInlineAsmDiagnosticHandler.
150 LLVMContext::InlineAsmDiagHandlerTy
151 LLVMContext::getInlineAsmDiagnosticHandler() const {
152 return pImpl->InlineAsmDiagHandler;
155 /// getInlineAsmDiagnosticContext - Return the diagnostic context set by
156 /// setInlineAsmDiagnosticHandler.
157 void *LLVMContext::getInlineAsmDiagnosticContext() const {
158 return pImpl->InlineAsmDiagContext;
161 void LLVMContext::setDiagnosticHandler(DiagnosticHandlerTy DiagnosticHandler,
162 void *DiagnosticContext,
163 bool RespectFilters) {
164 pImpl->DiagnosticHandler = DiagnosticHandler;
165 pImpl->DiagnosticContext = DiagnosticContext;
166 pImpl->RespectDiagnosticFilters = RespectFilters;
169 LLVMContext::DiagnosticHandlerTy LLVMContext::getDiagnosticHandler() const {
170 return pImpl->DiagnosticHandler;
173 void *LLVMContext::getDiagnosticContext() const {
174 return pImpl->DiagnosticContext;
177 void LLVMContext::setYieldCallback(YieldCallbackTy Callback, void *OpaqueHandle)
179 pImpl->YieldCallback = Callback;
180 pImpl->YieldOpaqueHandle = OpaqueHandle;
183 void LLVMContext::yield() {
184 if (pImpl->YieldCallback)
185 pImpl->YieldCallback(this, pImpl->YieldOpaqueHandle);
188 void LLVMContext::emitError(const Twine &ErrorStr) {
189 diagnose(DiagnosticInfoInlineAsm(ErrorStr));
192 void LLVMContext::emitError(const Instruction *I, const Twine &ErrorStr) {
193 assert (I && "Invalid instruction");
194 diagnose(DiagnosticInfoInlineAsm(*I, ErrorStr));
197 static bool isDiagnosticEnabled(const DiagnosticInfo &DI) {
198 // Optimization remarks are selective. They need to check whether the regexp
199 // pattern, passed via one of the -pass-remarks* flags, matches the name of
200 // the pass that is emitting the diagnostic. If there is no match, ignore the
201 // diagnostic and return.
202 switch (DI.getKind()) {
203 case llvm::DK_OptimizationRemark:
204 if (!cast<DiagnosticInfoOptimizationRemark>(DI).isEnabled())
207 case llvm::DK_OptimizationRemarkMissed:
208 if (!cast<DiagnosticInfoOptimizationRemarkMissed>(DI).isEnabled())
211 case llvm::DK_OptimizationRemarkAnalysis:
212 if (!cast<DiagnosticInfoOptimizationRemarkAnalysis>(DI).isEnabled())
215 case llvm::DK_OptimizationRemarkAnalysisFPCommute:
216 if (!cast<DiagnosticInfoOptimizationRemarkAnalysisFPCommute>(DI)
226 static const char *getDiagnosticMessagePrefix(DiagnosticSeverity Severity) {
237 llvm_unreachable("Unknown DiagnosticSeverity");
240 void LLVMContext::diagnose(const DiagnosticInfo &DI) {
241 // If there is a report handler, use it.
242 if (pImpl->DiagnosticHandler) {
243 if (!pImpl->RespectDiagnosticFilters || isDiagnosticEnabled(DI))
244 pImpl->DiagnosticHandler(DI, pImpl->DiagnosticContext);
248 if (!isDiagnosticEnabled(DI))
251 // Otherwise, print the message with a prefix based on the severity.
252 DiagnosticPrinterRawOStream DP(errs());
253 errs() << getDiagnosticMessagePrefix(DI.getSeverity()) << ": ";
256 if (DI.getSeverity() == DS_Error)
260 void LLVMContext::emitError(unsigned LocCookie, const Twine &ErrorStr) {
261 diagnose(DiagnosticInfoInlineAsm(LocCookie, ErrorStr));
264 //===----------------------------------------------------------------------===//
265 // Metadata Kind Uniquing
266 //===----------------------------------------------------------------------===//
268 /// Return a unique non-zero ID for the specified metadata kind.
269 unsigned LLVMContext::getMDKindID(StringRef Name) const {
270 // If this is new, assign it its ID.
271 return pImpl->CustomMDKindNames.insert(
273 Name, pImpl->CustomMDKindNames.size()))
277 /// getHandlerNames - Populate client-supplied smallvector using custom
278 /// metadata name and ID.
279 void LLVMContext::getMDKindNames(SmallVectorImpl<StringRef> &Names) const {
280 Names.resize(pImpl->CustomMDKindNames.size());
281 for (StringMap<unsigned>::const_iterator I = pImpl->CustomMDKindNames.begin(),
282 E = pImpl->CustomMDKindNames.end(); I != E; ++I)
283 Names[I->second] = I->first();