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 LLVMContext::~LLVMContext() { delete pImpl; }
109 
110 void LLVMContext::addModule(Module *M) {
111   pImpl->OwnedModules.insert(M);
112 }
113 
114 void LLVMContext::removeModule(Module *M) {
115   pImpl->OwnedModules.erase(M);
116 }
117 
118 //===----------------------------------------------------------------------===//
119 // Recoverable Backend Errors
120 //===----------------------------------------------------------------------===//
121 
122 void LLVMContext::
123 setInlineAsmDiagnosticHandler(InlineAsmDiagHandlerTy DiagHandler,
124                               void *DiagContext) {
125   pImpl->InlineAsmDiagHandler = DiagHandler;
126   pImpl->InlineAsmDiagContext = DiagContext;
127 }
128 
129 /// getInlineAsmDiagnosticHandler - Return the diagnostic handler set by
130 /// setInlineAsmDiagnosticHandler.
131 LLVMContext::InlineAsmDiagHandlerTy
132 LLVMContext::getInlineAsmDiagnosticHandler() const {
133   return pImpl->InlineAsmDiagHandler;
134 }
135 
136 /// getInlineAsmDiagnosticContext - Return the diagnostic context set by
137 /// setInlineAsmDiagnosticHandler.
138 void *LLVMContext::getInlineAsmDiagnosticContext() const {
139   return pImpl->InlineAsmDiagContext;
140 }
141 
142 void LLVMContext::setDiagnosticHandler(DiagnosticHandlerTy DiagnosticHandler,
143                                        void *DiagnosticContext,
144                                        bool RespectFilters) {
145   pImpl->DiagnosticHandler = DiagnosticHandler;
146   pImpl->DiagnosticContext = DiagnosticContext;
147   pImpl->RespectDiagnosticFilters = RespectFilters;
148 }
149 
150 LLVMContext::DiagnosticHandlerTy LLVMContext::getDiagnosticHandler() const {
151   return pImpl->DiagnosticHandler;
152 }
153 
154 void *LLVMContext::getDiagnosticContext() const {
155   return pImpl->DiagnosticContext;
156 }
157 
158 void LLVMContext::setYieldCallback(YieldCallbackTy Callback, void *OpaqueHandle)
159 {
160   pImpl->YieldCallback = Callback;
161   pImpl->YieldOpaqueHandle = OpaqueHandle;
162 }
163 
164 void LLVMContext::yield() {
165   if (pImpl->YieldCallback)
166     pImpl->YieldCallback(this, pImpl->YieldOpaqueHandle);
167 }
168 
169 void LLVMContext::emitError(const Twine &ErrorStr) {
170   diagnose(DiagnosticInfoInlineAsm(ErrorStr));
171 }
172 
173 void LLVMContext::emitError(const Instruction *I, const Twine &ErrorStr) {
174   assert (I && "Invalid instruction");
175   diagnose(DiagnosticInfoInlineAsm(*I, ErrorStr));
176 }
177 
178 static bool isDiagnosticEnabled(const DiagnosticInfo &DI) {
179   // Optimization remarks are selective. They need to check whether the regexp
180   // pattern, passed via one of the -pass-remarks* flags, matches the name of
181   // the pass that is emitting the diagnostic. If there is no match, ignore the
182   // diagnostic and return.
183   switch (DI.getKind()) {
184   case llvm::DK_OptimizationRemark:
185     if (!cast<DiagnosticInfoOptimizationRemark>(DI).isEnabled())
186       return false;
187     break;
188   case llvm::DK_OptimizationRemarkMissed:
189     if (!cast<DiagnosticInfoOptimizationRemarkMissed>(DI).isEnabled())
190       return false;
191     break;
192   case llvm::DK_OptimizationRemarkAnalysis:
193     if (!cast<DiagnosticInfoOptimizationRemarkAnalysis>(DI).isEnabled())
194       return false;
195     break;
196   default:
197     break;
198   }
199   return true;
200 }
201 
202 static const char *getDiagnosticMessagePrefix(DiagnosticSeverity Severity) {
203   switch (Severity) {
204   case DS_Error:
205     return "error";
206   case DS_Warning:
207     return "warning";
208   case DS_Remark:
209     return "remark";
210   case DS_Note:
211     return "note";
212   }
213   llvm_unreachable("Unknown DiagnosticSeverity");
214 }
215 
216 void LLVMContext::diagnose(const DiagnosticInfo &DI) {
217   // If there is a report handler, use it.
218   if (pImpl->DiagnosticHandler) {
219     if (!pImpl->RespectDiagnosticFilters || isDiagnosticEnabled(DI))
220       pImpl->DiagnosticHandler(DI, pImpl->DiagnosticContext);
221     return;
222   }
223 
224   if (!isDiagnosticEnabled(DI))
225     return;
226 
227   // Otherwise, print the message with a prefix based on the severity.
228   DiagnosticPrinterRawOStream DP(errs());
229   errs() << getDiagnosticMessagePrefix(DI.getSeverity()) << ": ";
230   DI.print(DP);
231   errs() << "\n";
232   if (DI.getSeverity() == DS_Error)
233     exit(1);
234 }
235 
236 void LLVMContext::emitError(unsigned LocCookie, const Twine &ErrorStr) {
237   diagnose(DiagnosticInfoInlineAsm(LocCookie, ErrorStr));
238 }
239 
240 //===----------------------------------------------------------------------===//
241 // Metadata Kind Uniquing
242 //===----------------------------------------------------------------------===//
243 
244 /// Return a unique non-zero ID for the specified metadata kind.
245 unsigned LLVMContext::getMDKindID(StringRef Name) const {
246   // If this is new, assign it its ID.
247   return pImpl->CustomMDKindNames.insert(
248                                      std::make_pair(
249                                          Name, pImpl->CustomMDKindNames.size()))
250       .first->second;
251 }
252 
253 /// getHandlerNames - Populate client supplied smallvector using custome
254 /// metadata name and ID.
255 void LLVMContext::getMDKindNames(SmallVectorImpl<StringRef> &Names) const {
256   Names.resize(pImpl->CustomMDKindNames.size());
257   for (StringMap<unsigned>::const_iterator I = pImpl->CustomMDKindNames.begin(),
258        E = pImpl->CustomMDKindNames.end(); I != E; ++I)
259     Names[I->second] = I->first();
260 }
261