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 }
127 LLVMContext::~LLVMContext() { delete pImpl; }
128 
129 void LLVMContext::addModule(Module *M) {
130   pImpl->OwnedModules.insert(M);
131 }
132 
133 void LLVMContext::removeModule(Module *M) {
134   pImpl->OwnedModules.erase(M);
135 }
136 
137 //===----------------------------------------------------------------------===//
138 // Recoverable Backend Errors
139 //===----------------------------------------------------------------------===//
140 
141 void LLVMContext::
142 setInlineAsmDiagnosticHandler(InlineAsmDiagHandlerTy DiagHandler,
143                               void *DiagContext) {
144   pImpl->InlineAsmDiagHandler = DiagHandler;
145   pImpl->InlineAsmDiagContext = DiagContext;
146 }
147 
148 /// getInlineAsmDiagnosticHandler - Return the diagnostic handler set by
149 /// setInlineAsmDiagnosticHandler.
150 LLVMContext::InlineAsmDiagHandlerTy
151 LLVMContext::getInlineAsmDiagnosticHandler() const {
152   return pImpl->InlineAsmDiagHandler;
153 }
154 
155 /// getInlineAsmDiagnosticContext - Return the diagnostic context set by
156 /// setInlineAsmDiagnosticHandler.
157 void *LLVMContext::getInlineAsmDiagnosticContext() const {
158   return pImpl->InlineAsmDiagContext;
159 }
160 
161 void LLVMContext::setDiagnosticHandler(DiagnosticHandlerTy DiagnosticHandler,
162                                        void *DiagnosticContext,
163                                        bool RespectFilters) {
164   pImpl->DiagnosticHandler = DiagnosticHandler;
165   pImpl->DiagnosticContext = DiagnosticContext;
166   pImpl->RespectDiagnosticFilters = RespectFilters;
167 }
168 
169 LLVMContext::DiagnosticHandlerTy LLVMContext::getDiagnosticHandler() const {
170   return pImpl->DiagnosticHandler;
171 }
172 
173 void *LLVMContext::getDiagnosticContext() const {
174   return pImpl->DiagnosticContext;
175 }
176 
177 void LLVMContext::setYieldCallback(YieldCallbackTy Callback, void *OpaqueHandle)
178 {
179   pImpl->YieldCallback = Callback;
180   pImpl->YieldOpaqueHandle = OpaqueHandle;
181 }
182 
183 void LLVMContext::yield() {
184   if (pImpl->YieldCallback)
185     pImpl->YieldCallback(this, pImpl->YieldOpaqueHandle);
186 }
187 
188 void LLVMContext::emitError(const Twine &ErrorStr) {
189   diagnose(DiagnosticInfoInlineAsm(ErrorStr));
190 }
191 
192 void LLVMContext::emitError(const Instruction *I, const Twine &ErrorStr) {
193   assert (I && "Invalid instruction");
194   diagnose(DiagnosticInfoInlineAsm(*I, ErrorStr));
195 }
196 
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())
205       return false;
206     break;
207   case llvm::DK_OptimizationRemarkMissed:
208     if (!cast<DiagnosticInfoOptimizationRemarkMissed>(DI).isEnabled())
209       return false;
210     break;
211   case llvm::DK_OptimizationRemarkAnalysis:
212     if (!cast<DiagnosticInfoOptimizationRemarkAnalysis>(DI).isEnabled())
213       return false;
214     break;
215   case llvm::DK_OptimizationRemarkAnalysisFPCommute:
216     if (!cast<DiagnosticInfoOptimizationRemarkAnalysisFPCommute>(DI)
217              .isEnabled())
218       return false;
219     break;
220   default:
221     break;
222   }
223   return true;
224 }
225 
226 static const char *getDiagnosticMessagePrefix(DiagnosticSeverity Severity) {
227   switch (Severity) {
228   case DS_Error:
229     return "error";
230   case DS_Warning:
231     return "warning";
232   case DS_Remark:
233     return "remark";
234   case DS_Note:
235     return "note";
236   }
237   llvm_unreachable("Unknown DiagnosticSeverity");
238 }
239 
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);
245     return;
246   }
247 
248   if (!isDiagnosticEnabled(DI))
249     return;
250 
251   // Otherwise, print the message with a prefix based on the severity.
252   DiagnosticPrinterRawOStream DP(errs());
253   errs() << getDiagnosticMessagePrefix(DI.getSeverity()) << ": ";
254   DI.print(DP);
255   errs() << "\n";
256   if (DI.getSeverity() == DS_Error)
257     exit(1);
258 }
259 
260 void LLVMContext::emitError(unsigned LocCookie, const Twine &ErrorStr) {
261   diagnose(DiagnosticInfoInlineAsm(LocCookie, ErrorStr));
262 }
263 
264 //===----------------------------------------------------------------------===//
265 // Metadata Kind Uniquing
266 //===----------------------------------------------------------------------===//
267 
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(
272                                      std::make_pair(
273                                          Name, pImpl->CustomMDKindNames.size()))
274       .first->second;
275 }
276 
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();
284 }
285