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   // Create the 'unpredictable' metadata kind.
115   unsigned UnpredictableID = getMDKindID("unpredictable");
116   assert(UnpredictableID == MD_unpredictable &&
117          "unpredictable kind id drifted");
118   (void)UnpredictableID;
119 
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;
125 
126   // Create the 'align' metadata kind.
127   unsigned AlignID = getMDKindID("align");
128   assert(AlignID == MD_align && "align kind id drifted");
129   (void)AlignID;
130 
131   auto *DeoptEntry = pImpl->getOrInsertBundleTag("deopt");
132   assert(DeoptEntry->second == LLVMContext::OB_deopt &&
133          "deopt operand bundle id drifted!");
134   (void)DeoptEntry;
135 }
136 LLVMContext::~LLVMContext() { delete pImpl; }
137 
138 void LLVMContext::addModule(Module *M) {
139   pImpl->OwnedModules.insert(M);
140 }
141 
142 void LLVMContext::removeModule(Module *M) {
143   pImpl->OwnedModules.erase(M);
144 }
145 
146 //===----------------------------------------------------------------------===//
147 // Recoverable Backend Errors
148 //===----------------------------------------------------------------------===//
149 
150 void LLVMContext::
151 setInlineAsmDiagnosticHandler(InlineAsmDiagHandlerTy DiagHandler,
152                               void *DiagContext) {
153   pImpl->InlineAsmDiagHandler = DiagHandler;
154   pImpl->InlineAsmDiagContext = DiagContext;
155 }
156 
157 /// getInlineAsmDiagnosticHandler - Return the diagnostic handler set by
158 /// setInlineAsmDiagnosticHandler.
159 LLVMContext::InlineAsmDiagHandlerTy
160 LLVMContext::getInlineAsmDiagnosticHandler() const {
161   return pImpl->InlineAsmDiagHandler;
162 }
163 
164 /// getInlineAsmDiagnosticContext - Return the diagnostic context set by
165 /// setInlineAsmDiagnosticHandler.
166 void *LLVMContext::getInlineAsmDiagnosticContext() const {
167   return pImpl->InlineAsmDiagContext;
168 }
169 
170 void LLVMContext::setDiagnosticHandler(DiagnosticHandlerTy DiagnosticHandler,
171                                        void *DiagnosticContext,
172                                        bool RespectFilters) {
173   pImpl->DiagnosticHandler = DiagnosticHandler;
174   pImpl->DiagnosticContext = DiagnosticContext;
175   pImpl->RespectDiagnosticFilters = RespectFilters;
176 }
177 
178 LLVMContext::DiagnosticHandlerTy LLVMContext::getDiagnosticHandler() const {
179   return pImpl->DiagnosticHandler;
180 }
181 
182 void *LLVMContext::getDiagnosticContext() const {
183   return pImpl->DiagnosticContext;
184 }
185 
186 void LLVMContext::setYieldCallback(YieldCallbackTy Callback, void *OpaqueHandle)
187 {
188   pImpl->YieldCallback = Callback;
189   pImpl->YieldOpaqueHandle = OpaqueHandle;
190 }
191 
192 void LLVMContext::yield() {
193   if (pImpl->YieldCallback)
194     pImpl->YieldCallback(this, pImpl->YieldOpaqueHandle);
195 }
196 
197 void LLVMContext::emitError(const Twine &ErrorStr) {
198   diagnose(DiagnosticInfoInlineAsm(ErrorStr));
199 }
200 
201 void LLVMContext::emitError(const Instruction *I, const Twine &ErrorStr) {
202   assert (I && "Invalid instruction");
203   diagnose(DiagnosticInfoInlineAsm(*I, ErrorStr));
204 }
205 
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())
214       return false;
215     break;
216   case llvm::DK_OptimizationRemarkMissed:
217     if (!cast<DiagnosticInfoOptimizationRemarkMissed>(DI).isEnabled())
218       return false;
219     break;
220   case llvm::DK_OptimizationRemarkAnalysis:
221     if (!cast<DiagnosticInfoOptimizationRemarkAnalysis>(DI).isEnabled())
222       return false;
223     break;
224   case llvm::DK_OptimizationRemarkAnalysisFPCommute:
225     if (!cast<DiagnosticInfoOptimizationRemarkAnalysisFPCommute>(DI)
226              .isEnabled())
227       return false;
228     break;
229   default:
230     break;
231   }
232   return true;
233 }
234 
235 static const char *getDiagnosticMessagePrefix(DiagnosticSeverity Severity) {
236   switch (Severity) {
237   case DS_Error:
238     return "error";
239   case DS_Warning:
240     return "warning";
241   case DS_Remark:
242     return "remark";
243   case DS_Note:
244     return "note";
245   }
246   llvm_unreachable("Unknown DiagnosticSeverity");
247 }
248 
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);
254     return;
255   }
256 
257   if (!isDiagnosticEnabled(DI))
258     return;
259 
260   // Otherwise, print the message with a prefix based on the severity.
261   DiagnosticPrinterRawOStream DP(errs());
262   errs() << getDiagnosticMessagePrefix(DI.getSeverity()) << ": ";
263   DI.print(DP);
264   errs() << "\n";
265   if (DI.getSeverity() == DS_Error)
266     exit(1);
267 }
268 
269 void LLVMContext::emitError(unsigned LocCookie, const Twine &ErrorStr) {
270   diagnose(DiagnosticInfoInlineAsm(LocCookie, ErrorStr));
271 }
272 
273 //===----------------------------------------------------------------------===//
274 // Metadata Kind Uniquing
275 //===----------------------------------------------------------------------===//
276 
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(
281                                      std::make_pair(
282                                          Name, pImpl->CustomMDKindNames.size()))
283       .first->second;
284 }
285 
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();
293 }
294 
295 void LLVMContext::getOperandBundleTags(SmallVectorImpl<StringRef> &Tags) const {
296   pImpl->getOperandBundleTags(Tags);
297 }
298 
299 uint32_t LLVMContext::getOperandBundleTagID(StringRef Tag) const {
300   return pImpl->getOperandBundleTagID(Tag);
301 }
302