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   // Create the 'llvm.loop' metadata kind.
132   unsigned LoopID = getMDKindID("llvm.loop");
133   assert(LoopID == MD_loop && "llvm.loop kind id drifted");
134   (void)LoopID;
135 
136   auto *DeoptEntry = pImpl->getOrInsertBundleTag("deopt");
137   assert(DeoptEntry->second == LLVMContext::OB_deopt &&
138          "deopt operand bundle id drifted!");
139   (void)DeoptEntry;
140 
141   auto *FuncletEntry = pImpl->getOrInsertBundleTag("funclet");
142   assert(FuncletEntry->second == LLVMContext::OB_funclet &&
143          "funclet operand bundle id drifted!");
144   (void)FuncletEntry;
145 
146   auto *GCTransitionEntry = pImpl->getOrInsertBundleTag("gc-transition");
147   assert(GCTransitionEntry->second == LLVMContext::OB_gc_transition &&
148          "gc-transition operand bundle id drifted!");
149   (void)GCTransitionEntry;
150 }
151 LLVMContext::~LLVMContext() { delete pImpl; }
152 
153 void LLVMContext::addModule(Module *M) {
154   pImpl->OwnedModules.insert(M);
155 }
156 
157 void LLVMContext::removeModule(Module *M) {
158   pImpl->OwnedModules.erase(M);
159 }
160 
161 //===----------------------------------------------------------------------===//
162 // Recoverable Backend Errors
163 //===----------------------------------------------------------------------===//
164 
165 void LLVMContext::
166 setInlineAsmDiagnosticHandler(InlineAsmDiagHandlerTy DiagHandler,
167                               void *DiagContext) {
168   pImpl->InlineAsmDiagHandler = DiagHandler;
169   pImpl->InlineAsmDiagContext = DiagContext;
170 }
171 
172 /// getInlineAsmDiagnosticHandler - Return the diagnostic handler set by
173 /// setInlineAsmDiagnosticHandler.
174 LLVMContext::InlineAsmDiagHandlerTy
175 LLVMContext::getInlineAsmDiagnosticHandler() const {
176   return pImpl->InlineAsmDiagHandler;
177 }
178 
179 /// getInlineAsmDiagnosticContext - Return the diagnostic context set by
180 /// setInlineAsmDiagnosticHandler.
181 void *LLVMContext::getInlineAsmDiagnosticContext() const {
182   return pImpl->InlineAsmDiagContext;
183 }
184 
185 void LLVMContext::setDiagnosticHandler(DiagnosticHandlerTy DiagnosticHandler,
186                                        void *DiagnosticContext,
187                                        bool RespectFilters) {
188   pImpl->DiagnosticHandler = DiagnosticHandler;
189   pImpl->DiagnosticContext = DiagnosticContext;
190   pImpl->RespectDiagnosticFilters = RespectFilters;
191 }
192 
193 LLVMContext::DiagnosticHandlerTy LLVMContext::getDiagnosticHandler() const {
194   return pImpl->DiagnosticHandler;
195 }
196 
197 void *LLVMContext::getDiagnosticContext() const {
198   return pImpl->DiagnosticContext;
199 }
200 
201 void LLVMContext::setYieldCallback(YieldCallbackTy Callback, void *OpaqueHandle)
202 {
203   pImpl->YieldCallback = Callback;
204   pImpl->YieldOpaqueHandle = OpaqueHandle;
205 }
206 
207 void LLVMContext::yield() {
208   if (pImpl->YieldCallback)
209     pImpl->YieldCallback(this, pImpl->YieldOpaqueHandle);
210 }
211 
212 void LLVMContext::emitError(const Twine &ErrorStr) {
213   diagnose(DiagnosticInfoInlineAsm(ErrorStr));
214 }
215 
216 void LLVMContext::emitError(const Instruction *I, const Twine &ErrorStr) {
217   assert (I && "Invalid instruction");
218   diagnose(DiagnosticInfoInlineAsm(*I, ErrorStr));
219 }
220 
221 static bool isDiagnosticEnabled(const DiagnosticInfo &DI) {
222   // Optimization remarks are selective. They need to check whether the regexp
223   // pattern, passed via one of the -pass-remarks* flags, matches the name of
224   // the pass that is emitting the diagnostic. If there is no match, ignore the
225   // diagnostic and return.
226   switch (DI.getKind()) {
227   case llvm::DK_OptimizationRemark:
228     if (!cast<DiagnosticInfoOptimizationRemark>(DI).isEnabled())
229       return false;
230     break;
231   case llvm::DK_OptimizationRemarkMissed:
232     if (!cast<DiagnosticInfoOptimizationRemarkMissed>(DI).isEnabled())
233       return false;
234     break;
235   case llvm::DK_OptimizationRemarkAnalysis:
236     if (!cast<DiagnosticInfoOptimizationRemarkAnalysis>(DI).isEnabled())
237       return false;
238     break;
239   case llvm::DK_OptimizationRemarkAnalysisFPCommute:
240     if (!cast<DiagnosticInfoOptimizationRemarkAnalysisFPCommute>(DI)
241              .isEnabled())
242       return false;
243     break;
244   default:
245     break;
246   }
247   return true;
248 }
249 
250 static const char *getDiagnosticMessagePrefix(DiagnosticSeverity Severity) {
251   switch (Severity) {
252   case DS_Error:
253     return "error";
254   case DS_Warning:
255     return "warning";
256   case DS_Remark:
257     return "remark";
258   case DS_Note:
259     return "note";
260   }
261   llvm_unreachable("Unknown DiagnosticSeverity");
262 }
263 
264 void LLVMContext::diagnose(const DiagnosticInfo &DI) {
265   // If there is a report handler, use it.
266   if (pImpl->DiagnosticHandler) {
267     if (!pImpl->RespectDiagnosticFilters || isDiagnosticEnabled(DI))
268       pImpl->DiagnosticHandler(DI, pImpl->DiagnosticContext);
269     return;
270   }
271 
272   if (!isDiagnosticEnabled(DI))
273     return;
274 
275   // Otherwise, print the message with a prefix based on the severity.
276   DiagnosticPrinterRawOStream DP(errs());
277   errs() << getDiagnosticMessagePrefix(DI.getSeverity()) << ": ";
278   DI.print(DP);
279   errs() << "\n";
280   if (DI.getSeverity() == DS_Error)
281     exit(1);
282 }
283 
284 void LLVMContext::emitError(unsigned LocCookie, const Twine &ErrorStr) {
285   diagnose(DiagnosticInfoInlineAsm(LocCookie, ErrorStr));
286 }
287 
288 //===----------------------------------------------------------------------===//
289 // Metadata Kind Uniquing
290 //===----------------------------------------------------------------------===//
291 
292 /// Return a unique non-zero ID for the specified metadata kind.
293 unsigned LLVMContext::getMDKindID(StringRef Name) const {
294   // If this is new, assign it its ID.
295   return pImpl->CustomMDKindNames.insert(
296                                      std::make_pair(
297                                          Name, pImpl->CustomMDKindNames.size()))
298       .first->second;
299 }
300 
301 /// getHandlerNames - Populate client-supplied smallvector using custom
302 /// metadata name and ID.
303 void LLVMContext::getMDKindNames(SmallVectorImpl<StringRef> &Names) const {
304   Names.resize(pImpl->CustomMDKindNames.size());
305   for (StringMap<unsigned>::const_iterator I = pImpl->CustomMDKindNames.begin(),
306        E = pImpl->CustomMDKindNames.end(); I != E; ++I)
307     Names[I->second] = I->first();
308 }
309 
310 void LLVMContext::getOperandBundleTags(SmallVectorImpl<StringRef> &Tags) const {
311   pImpl->getOperandBundleTags(Tags);
312 }
313 
314 uint32_t LLVMContext::getOperandBundleTagID(StringRef Tag) const {
315   return pImpl->getOperandBundleTagID(Tag);
316 }
317 
318 void LLVMContext::setGC(const Function &Fn, std::string GCName) {
319   auto It = pImpl->GCNames.find(&Fn);
320 
321   if (It == pImpl->GCNames.end()) {
322     pImpl->GCNames.insert(std::make_pair(&Fn, std::move(GCName)));
323     return;
324   }
325   It->second = std::move(GCName);
326 }
327 const std::string &LLVMContext::getGC(const Function &Fn) {
328   return pImpl->GCNames[&Fn];
329 }
330 void LLVMContext::deleteGC(const Function &Fn) {
331   pImpl->GCNames.erase(&Fn);
332 }
333 
334 bool LLVMContext::discardValueNames() { return pImpl->DiscardValueNames; }
335 
336 void LLVMContext::setDiscardValueNames(bool Discard) {
337   pImpl->DiscardValueNames = Discard;
338 }
339