1 //===-- LLVMContext.cpp - Implement LLVMContext ---------------------------===//
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 implements LLVMContext, as a wrapper around the opaque
11 //  class LLVMContextImpl.
12 //
13 //===----------------------------------------------------------------------===//
14 
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"
25 #include <cctype>
26 using namespace llvm;
27 
28 static ManagedStatic<LLVMContext> GlobalContext;
29 
30 LLVMContext& llvm::getGlobalContext() {
31   return *GlobalContext;
32 }
33 
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.
37 
38   // Create the 'dbg' metadata kind.
39   unsigned DbgID = getMDKindID("dbg");
40   assert(DbgID == MD_dbg && "dbg kind id drifted"); (void)DbgID;
41 
42   // Create the 'tbaa' metadata kind.
43   unsigned TBAAID = getMDKindID("tbaa");
44   assert(TBAAID == MD_tbaa && "tbaa kind id drifted"); (void)TBAAID;
45 
46   // Create the 'prof' metadata kind.
47   unsigned ProfID = getMDKindID("prof");
48   assert(ProfID == MD_prof && "prof kind id drifted"); (void)ProfID;
49 
50   // Create the 'fpmath' metadata kind.
51   unsigned FPAccuracyID = getMDKindID("fpmath");
52   assert(FPAccuracyID == MD_fpmath && "fpmath kind id drifted");
53   (void)FPAccuracyID;
54 
55   // Create the 'range' metadata kind.
56   unsigned RangeID = getMDKindID("range");
57   assert(RangeID == MD_range && "range kind id drifted");
58   (void)RangeID;
59 
60   // Create the 'tbaa.struct' metadata kind.
61   unsigned TBAAStructID = getMDKindID("tbaa.struct");
62   assert(TBAAStructID == MD_tbaa_struct && "tbaa.struct kind id drifted");
63   (void)TBAAStructID;
64 
65   // Create the 'invariant.load' metadata kind.
66   unsigned InvariantLdId = getMDKindID("invariant.load");
67   assert(InvariantLdId == MD_invariant_load && "invariant.load kind id drifted");
68   (void)InvariantLdId;
69 
70   // Create the 'alias.scope' metadata kind.
71   unsigned AliasScopeID = getMDKindID("alias.scope");
72   assert(AliasScopeID == MD_alias_scope && "alias.scope kind id drifted");
73   (void)AliasScopeID;
74 
75   // Create the 'noalias' metadata kind.
76   unsigned NoAliasID = getMDKindID("noalias");
77   assert(NoAliasID == MD_noalias && "noalias kind id drifted");
78   (void)NoAliasID;
79 
80   // Create the 'nontemporal' metadata kind.
81   unsigned NonTemporalID = getMDKindID("nontemporal");
82   assert(NonTemporalID == MD_nontemporal && "nontemporal kind id drifted");
83   (void)NonTemporalID;
84 
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;
90 
91   // Create the 'nonnull' metadata kind.
92   unsigned NonNullID = getMDKindID("nonnull");
93   assert(NonNullID == MD_nonnull && "nonnull kind id drifted");
94   (void)NonNullID;
95 
96   // Create the 'dereferenceable' metadata kind.
97   unsigned DereferenceableID = getMDKindID("dereferenceable");
98   assert(DereferenceableID == MD_dereferenceable &&
99          "dereferenceable kind id drifted");
100   (void)DereferenceableID;
101 
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;
107 
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;
113 }
114 LLVMContext::~LLVMContext() { delete pImpl; }
115 
116 void LLVMContext::addModule(Module *M) {
117   pImpl->OwnedModules.insert(M);
118 }
119 
120 void LLVMContext::removeModule(Module *M) {
121   pImpl->OwnedModules.erase(M);
122 }
123 
124 //===----------------------------------------------------------------------===//
125 // Recoverable Backend Errors
126 //===----------------------------------------------------------------------===//
127 
128 void LLVMContext::
129 setInlineAsmDiagnosticHandler(InlineAsmDiagHandlerTy DiagHandler,
130                               void *DiagContext) {
131   pImpl->InlineAsmDiagHandler = DiagHandler;
132   pImpl->InlineAsmDiagContext = DiagContext;
133 }
134 
135 /// getInlineAsmDiagnosticHandler - Return the diagnostic handler set by
136 /// setInlineAsmDiagnosticHandler.
137 LLVMContext::InlineAsmDiagHandlerTy
138 LLVMContext::getInlineAsmDiagnosticHandler() const {
139   return pImpl->InlineAsmDiagHandler;
140 }
141 
142 /// getInlineAsmDiagnosticContext - Return the diagnostic context set by
143 /// setInlineAsmDiagnosticHandler.
144 void *LLVMContext::getInlineAsmDiagnosticContext() const {
145   return pImpl->InlineAsmDiagContext;
146 }
147 
148 void LLVMContext::setDiagnosticHandler(DiagnosticHandlerTy DiagnosticHandler,
149                                        void *DiagnosticContext,
150                                        bool RespectFilters) {
151   pImpl->DiagnosticHandler = DiagnosticHandler;
152   pImpl->DiagnosticContext = DiagnosticContext;
153   pImpl->RespectDiagnosticFilters = RespectFilters;
154 }
155 
156 LLVMContext::DiagnosticHandlerTy LLVMContext::getDiagnosticHandler() const {
157   return pImpl->DiagnosticHandler;
158 }
159 
160 void *LLVMContext::getDiagnosticContext() const {
161   return pImpl->DiagnosticContext;
162 }
163 
164 void LLVMContext::setYieldCallback(YieldCallbackTy Callback, void *OpaqueHandle)
165 {
166   pImpl->YieldCallback = Callback;
167   pImpl->YieldOpaqueHandle = OpaqueHandle;
168 }
169 
170 void LLVMContext::yield() {
171   if (pImpl->YieldCallback)
172     pImpl->YieldCallback(this, pImpl->YieldOpaqueHandle);
173 }
174 
175 void LLVMContext::emitError(const Twine &ErrorStr) {
176   diagnose(DiagnosticInfoInlineAsm(ErrorStr));
177 }
178 
179 void LLVMContext::emitError(const Instruction *I, const Twine &ErrorStr) {
180   assert (I && "Invalid instruction");
181   diagnose(DiagnosticInfoInlineAsm(*I, ErrorStr));
182 }
183 
184 static bool isDiagnosticEnabled(const DiagnosticInfo &DI) {
185   // Optimization remarks are selective. They need to check whether the regexp
186   // pattern, passed via one of the -pass-remarks* flags, matches the name of
187   // the pass that is emitting the diagnostic. If there is no match, ignore the
188   // diagnostic and return.
189   switch (DI.getKind()) {
190   case llvm::DK_OptimizationRemark:
191     if (!cast<DiagnosticInfoOptimizationRemark>(DI).isEnabled())
192       return false;
193     break;
194   case llvm::DK_OptimizationRemarkMissed:
195     if (!cast<DiagnosticInfoOptimizationRemarkMissed>(DI).isEnabled())
196       return false;
197     break;
198   case llvm::DK_OptimizationRemarkAnalysis:
199     if (!cast<DiagnosticInfoOptimizationRemarkAnalysis>(DI).isEnabled())
200       return false;
201     break;
202   case llvm::DK_OptimizationRemarkAnalysisFPCommute:
203     if (!cast<DiagnosticInfoOptimizationRemarkAnalysisFPCommute>(DI)
204              .isEnabled())
205       return false;
206     break;
207   default:
208     break;
209   }
210   return true;
211 }
212 
213 static const char *getDiagnosticMessagePrefix(DiagnosticSeverity Severity) {
214   switch (Severity) {
215   case DS_Error:
216     return "error";
217   case DS_Warning:
218     return "warning";
219   case DS_Remark:
220     return "remark";
221   case DS_Note:
222     return "note";
223   }
224   llvm_unreachable("Unknown DiagnosticSeverity");
225 }
226 
227 void LLVMContext::diagnose(const DiagnosticInfo &DI) {
228   // If there is a report handler, use it.
229   if (pImpl->DiagnosticHandler) {
230     if (!pImpl->RespectDiagnosticFilters || isDiagnosticEnabled(DI))
231       pImpl->DiagnosticHandler(DI, pImpl->DiagnosticContext);
232     return;
233   }
234 
235   if (!isDiagnosticEnabled(DI))
236     return;
237 
238   // Otherwise, print the message with a prefix based on the severity.
239   DiagnosticPrinterRawOStream DP(errs());
240   errs() << getDiagnosticMessagePrefix(DI.getSeverity()) << ": ";
241   DI.print(DP);
242   errs() << "\n";
243   if (DI.getSeverity() == DS_Error)
244     exit(1);
245 }
246 
247 void LLVMContext::emitError(unsigned LocCookie, const Twine &ErrorStr) {
248   diagnose(DiagnosticInfoInlineAsm(LocCookie, ErrorStr));
249 }
250 
251 //===----------------------------------------------------------------------===//
252 // Metadata Kind Uniquing
253 //===----------------------------------------------------------------------===//
254 
255 /// Return a unique non-zero ID for the specified metadata kind.
256 unsigned LLVMContext::getMDKindID(StringRef Name) const {
257   // If this is new, assign it its ID.
258   return pImpl->CustomMDKindNames.insert(
259                                      std::make_pair(
260                                          Name, pImpl->CustomMDKindNames.size()))
261       .first->second;
262 }
263 
264 /// getHandlerNames - Populate client supplied smallvector using custome
265 /// metadata name and ID.
266 void LLVMContext::getMDKindNames(SmallVectorImpl<StringRef> &Names) const {
267   Names.resize(pImpl->CustomMDKindNames.size());
268   for (StringMap<unsigned>::const_iterator I = pImpl->CustomMDKindNames.begin(),
269        E = pImpl->CustomMDKindNames.end(); I != E; ++I)
270     Names[I->second] = I->first();
271 }
272