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;
126 // Create the 'align' metadata kind.
127 unsigned AlignID = getMDKindID("align");
128 assert(AlignID == MD_align && "align kind id drifted");
131 auto *DeoptEntry = pImpl->getOrInsertBundleTag("deopt");
132 assert(DeoptEntry->second == LLVMContext::OB_deopt &&
133 "deopt operand bundle id drifted!");
136 LLVMContext::~LLVMContext() { delete pImpl; }
138 void LLVMContext::addModule(Module *M) {
139 pImpl->OwnedModules.insert(M);
142 void LLVMContext::removeModule(Module *M) {
143 pImpl->OwnedModules.erase(M);
146 //===----------------------------------------------------------------------===//
147 // Recoverable Backend Errors
148 //===----------------------------------------------------------------------===//
151 setInlineAsmDiagnosticHandler(InlineAsmDiagHandlerTy DiagHandler,
153 pImpl->InlineAsmDiagHandler = DiagHandler;
154 pImpl->InlineAsmDiagContext = DiagContext;
157 /// getInlineAsmDiagnosticHandler - Return the diagnostic handler set by
158 /// setInlineAsmDiagnosticHandler.
159 LLVMContext::InlineAsmDiagHandlerTy
160 LLVMContext::getInlineAsmDiagnosticHandler() const {
161 return pImpl->InlineAsmDiagHandler;
164 /// getInlineAsmDiagnosticContext - Return the diagnostic context set by
165 /// setInlineAsmDiagnosticHandler.
166 void *LLVMContext::getInlineAsmDiagnosticContext() const {
167 return pImpl->InlineAsmDiagContext;
170 void LLVMContext::setDiagnosticHandler(DiagnosticHandlerTy DiagnosticHandler,
171 void *DiagnosticContext,
172 bool RespectFilters) {
173 pImpl->DiagnosticHandler = DiagnosticHandler;
174 pImpl->DiagnosticContext = DiagnosticContext;
175 pImpl->RespectDiagnosticFilters = RespectFilters;
178 LLVMContext::DiagnosticHandlerTy LLVMContext::getDiagnosticHandler() const {
179 return pImpl->DiagnosticHandler;
182 void *LLVMContext::getDiagnosticContext() const {
183 return pImpl->DiagnosticContext;
186 void LLVMContext::setYieldCallback(YieldCallbackTy Callback, void *OpaqueHandle)
188 pImpl->YieldCallback = Callback;
189 pImpl->YieldOpaqueHandle = OpaqueHandle;
192 void LLVMContext::yield() {
193 if (pImpl->YieldCallback)
194 pImpl->YieldCallback(this, pImpl->YieldOpaqueHandle);
197 void LLVMContext::emitError(const Twine &ErrorStr) {
198 diagnose(DiagnosticInfoInlineAsm(ErrorStr));
201 void LLVMContext::emitError(const Instruction *I, const Twine &ErrorStr) {
202 assert (I && "Invalid instruction");
203 diagnose(DiagnosticInfoInlineAsm(*I, ErrorStr));
206 static bool isDiagnosticEnabled(const DiagnosticInfo &DI) {
207 // Optimization remarks are selective. They need to check whether the regexp
208 // pattern, passed via one of the -pass-remarks* flags, matches the name of
209 // the pass that is emitting the diagnostic. If there is no match, ignore the
210 // diagnostic and return.
211 switch (DI.getKind()) {
212 case llvm::DK_OptimizationRemark:
213 if (!cast<DiagnosticInfoOptimizationRemark>(DI).isEnabled())
216 case llvm::DK_OptimizationRemarkMissed:
217 if (!cast<DiagnosticInfoOptimizationRemarkMissed>(DI).isEnabled())
220 case llvm::DK_OptimizationRemarkAnalysis:
221 if (!cast<DiagnosticInfoOptimizationRemarkAnalysis>(DI).isEnabled())
224 case llvm::DK_OptimizationRemarkAnalysisFPCommute:
225 if (!cast<DiagnosticInfoOptimizationRemarkAnalysisFPCommute>(DI)
235 static const char *getDiagnosticMessagePrefix(DiagnosticSeverity Severity) {
246 llvm_unreachable("Unknown DiagnosticSeverity");
249 void LLVMContext::diagnose(const DiagnosticInfo &DI) {
250 // If there is a report handler, use it.
251 if (pImpl->DiagnosticHandler) {
252 if (!pImpl->RespectDiagnosticFilters || isDiagnosticEnabled(DI))
253 pImpl->DiagnosticHandler(DI, pImpl->DiagnosticContext);
257 if (!isDiagnosticEnabled(DI))
260 // Otherwise, print the message with a prefix based on the severity.
261 DiagnosticPrinterRawOStream DP(errs());
262 errs() << getDiagnosticMessagePrefix(DI.getSeverity()) << ": ";
265 if (DI.getSeverity() == DS_Error)
269 void LLVMContext::emitError(unsigned LocCookie, const Twine &ErrorStr) {
270 diagnose(DiagnosticInfoInlineAsm(LocCookie, ErrorStr));
273 //===----------------------------------------------------------------------===//
274 // Metadata Kind Uniquing
275 //===----------------------------------------------------------------------===//
277 /// Return a unique non-zero ID for the specified metadata kind.
278 unsigned LLVMContext::getMDKindID(StringRef Name) const {
279 // If this is new, assign it its ID.
280 return pImpl->CustomMDKindNames.insert(
282 Name, pImpl->CustomMDKindNames.size()))
286 /// getHandlerNames - Populate client-supplied smallvector using custom
287 /// metadata name and ID.
288 void LLVMContext::getMDKindNames(SmallVectorImpl<StringRef> &Names) const {
289 Names.resize(pImpl->CustomMDKindNames.size());
290 for (StringMap<unsigned>::const_iterator I = pImpl->CustomMDKindNames.begin(),
291 E = pImpl->CustomMDKindNames.end(); I != E; ++I)
292 Names[I->second] = I->first();
295 void LLVMContext::getOperandBundleTags(SmallVectorImpl<StringRef> &Tags) const {
296 pImpl->getOperandBundleTags(Tags);
299 uint32_t LLVMContext::getOperandBundleTagID(StringRef Tag) const {
300 return pImpl->getOperandBundleTagID(Tag);