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 "llvm/ADT/SmallVector.h"
17 #include "llvm/ADT/StringMap.h"
18 #include "llvm/ADT/StringRef.h"
19 #include "llvm/ADT/Twine.h"
20 #include "LLVMContextImpl.h"
21 #include "llvm/IR/DiagnosticInfo.h"
22 #include "llvm/IR/DiagnosticPrinter.h"
23 #include "llvm/IR/Metadata.h"
24 #include "llvm/IR/Module.h"
25 #include "llvm/Support/Casting.h"
26 #include "llvm/Support/ErrorHandling.h"
27 #include "llvm/Support/raw_ostream.h"
28 #include <cassert>
29 #include <cstdlib>
30 #include <string>
31 #include <utility>
32 
33 using namespace llvm;
34 
35 LLVMContext::LLVMContext() : pImpl(new LLVMContextImpl(*this)) {
36   // Create the fixed metadata kinds. This is done in the same order as the
37   // MD_* enum values so that they correspond.
38 
39   // Create the 'dbg' metadata kind.
40   unsigned DbgID = getMDKindID("dbg");
41   assert(DbgID == MD_dbg && "dbg kind id drifted"); (void)DbgID;
42 
43   // Create the 'tbaa' metadata kind.
44   unsigned TBAAID = getMDKindID("tbaa");
45   assert(TBAAID == MD_tbaa && "tbaa kind id drifted"); (void)TBAAID;
46 
47   // Create the 'prof' metadata kind.
48   unsigned ProfID = getMDKindID("prof");
49   assert(ProfID == MD_prof && "prof kind id drifted"); (void)ProfID;
50 
51   // Create the 'fpmath' metadata kind.
52   unsigned FPAccuracyID = getMDKindID("fpmath");
53   assert(FPAccuracyID == MD_fpmath && "fpmath kind id drifted");
54   (void)FPAccuracyID;
55 
56   // Create the 'range' metadata kind.
57   unsigned RangeID = getMDKindID("range");
58   assert(RangeID == MD_range && "range kind id drifted");
59   (void)RangeID;
60 
61   // Create the 'tbaa.struct' metadata kind.
62   unsigned TBAAStructID = getMDKindID("tbaa.struct");
63   assert(TBAAStructID == MD_tbaa_struct && "tbaa.struct kind id drifted");
64   (void)TBAAStructID;
65 
66   // Create the 'invariant.load' metadata kind.
67   unsigned InvariantLdId = getMDKindID("invariant.load");
68   assert(InvariantLdId == MD_invariant_load && "invariant.load kind id drifted");
69   (void)InvariantLdId;
70 
71   // Create the 'alias.scope' metadata kind.
72   unsigned AliasScopeID = getMDKindID("alias.scope");
73   assert(AliasScopeID == MD_alias_scope && "alias.scope kind id drifted");
74   (void)AliasScopeID;
75 
76   // Create the 'noalias' metadata kind.
77   unsigned NoAliasID = getMDKindID("noalias");
78   assert(NoAliasID == MD_noalias && "noalias kind id drifted");
79   (void)NoAliasID;
80 
81   // Create the 'nontemporal' metadata kind.
82   unsigned NonTemporalID = getMDKindID("nontemporal");
83   assert(NonTemporalID == MD_nontemporal && "nontemporal kind id drifted");
84   (void)NonTemporalID;
85 
86   // Create the 'llvm.mem.parallel_loop_access' metadata kind.
87   unsigned MemParallelLoopAccessID = getMDKindID("llvm.mem.parallel_loop_access");
88   assert(MemParallelLoopAccessID == MD_mem_parallel_loop_access &&
89          "mem_parallel_loop_access kind id drifted");
90   (void)MemParallelLoopAccessID;
91 
92   // Create the 'nonnull' metadata kind.
93   unsigned NonNullID = getMDKindID("nonnull");
94   assert(NonNullID == MD_nonnull && "nonnull kind id drifted");
95   (void)NonNullID;
96 
97   // Create the 'dereferenceable' metadata kind.
98   unsigned DereferenceableID = getMDKindID("dereferenceable");
99   assert(DereferenceableID == MD_dereferenceable &&
100          "dereferenceable kind id drifted");
101   (void)DereferenceableID;
102 
103   // Create the 'dereferenceable_or_null' metadata kind.
104   unsigned DereferenceableOrNullID = getMDKindID("dereferenceable_or_null");
105   assert(DereferenceableOrNullID == MD_dereferenceable_or_null &&
106          "dereferenceable_or_null kind id drifted");
107   (void)DereferenceableOrNullID;
108 
109   // Create the 'make.implicit' metadata kind.
110   unsigned MakeImplicitID = getMDKindID("make.implicit");
111   assert(MakeImplicitID == MD_make_implicit &&
112          "make.implicit kind id drifted");
113   (void)MakeImplicitID;
114 
115   // Create the 'unpredictable' metadata kind.
116   unsigned UnpredictableID = getMDKindID("unpredictable");
117   assert(UnpredictableID == MD_unpredictable &&
118          "unpredictable kind id drifted");
119   (void)UnpredictableID;
120 
121   // Create the 'invariant.group' metadata kind.
122   unsigned InvariantGroupId = getMDKindID("invariant.group");
123   assert(InvariantGroupId == MD_invariant_group &&
124          "invariant.group kind id drifted");
125   (void)InvariantGroupId;
126 
127   // Create the 'align' metadata kind.
128   unsigned AlignID = getMDKindID("align");
129   assert(AlignID == MD_align && "align kind id drifted");
130   (void)AlignID;
131 
132   // Create the 'llvm.loop' metadata kind.
133   unsigned LoopID = getMDKindID("llvm.loop");
134   assert(LoopID == MD_loop && "llvm.loop kind id drifted");
135   (void)LoopID;
136 
137   unsigned TypeID = getMDKindID("type");
138   assert(TypeID == MD_type && "type kind id drifted");
139   (void)TypeID;
140 
141   auto *DeoptEntry = pImpl->getOrInsertBundleTag("deopt");
142   assert(DeoptEntry->second == LLVMContext::OB_deopt &&
143          "deopt operand bundle id drifted!");
144   (void)DeoptEntry;
145 
146   auto *FuncletEntry = pImpl->getOrInsertBundleTag("funclet");
147   assert(FuncletEntry->second == LLVMContext::OB_funclet &&
148          "funclet operand bundle id drifted!");
149   (void)FuncletEntry;
150 
151   auto *GCTransitionEntry = pImpl->getOrInsertBundleTag("gc-transition");
152   assert(GCTransitionEntry->second == LLVMContext::OB_gc_transition &&
153          "gc-transition operand bundle id drifted!");
154   (void)GCTransitionEntry;
155 }
156 
157 LLVMContext::~LLVMContext() { delete pImpl; }
158 
159 void LLVMContext::addModule(Module *M) {
160   pImpl->OwnedModules.insert(M);
161 }
162 
163 void LLVMContext::removeModule(Module *M) {
164   pImpl->OwnedModules.erase(M);
165 }
166 
167 //===----------------------------------------------------------------------===//
168 // Recoverable Backend Errors
169 //===----------------------------------------------------------------------===//
170 
171 void LLVMContext::
172 setInlineAsmDiagnosticHandler(InlineAsmDiagHandlerTy DiagHandler,
173                               void *DiagContext) {
174   pImpl->InlineAsmDiagHandler = DiagHandler;
175   pImpl->InlineAsmDiagContext = DiagContext;
176 }
177 
178 /// getInlineAsmDiagnosticHandler - Return the diagnostic handler set by
179 /// setInlineAsmDiagnosticHandler.
180 LLVMContext::InlineAsmDiagHandlerTy
181 LLVMContext::getInlineAsmDiagnosticHandler() const {
182   return pImpl->InlineAsmDiagHandler;
183 }
184 
185 /// getInlineAsmDiagnosticContext - Return the diagnostic context set by
186 /// setInlineAsmDiagnosticHandler.
187 void *LLVMContext::getInlineAsmDiagnosticContext() const {
188   return pImpl->InlineAsmDiagContext;
189 }
190 
191 void LLVMContext::setDiagnosticHandler(DiagnosticHandlerTy DiagnosticHandler,
192                                        void *DiagnosticContext,
193                                        bool RespectFilters) {
194   pImpl->DiagnosticHandler = DiagnosticHandler;
195   pImpl->DiagnosticContext = DiagnosticContext;
196   pImpl->RespectDiagnosticFilters = RespectFilters;
197 }
198 
199 void LLVMContext::setDiagnosticHotnessRequested(bool Requested) {
200   pImpl->DiagnosticHotnessRequested = Requested;
201 }
202 bool LLVMContext::getDiagnosticHotnessRequested() const {
203   return pImpl->DiagnosticHotnessRequested;
204 }
205 
206 yaml::Output *LLVMContext::getDiagnosticsOutputFile() {
207   return pImpl->DiagnosticsOutputFile.get();
208 }
209 
210 void LLVMContext::setDiagnosticsOutputFile(yaml::Output *F) {
211   pImpl->DiagnosticsOutputFile.reset(F);
212 }
213 
214 LLVMContext::DiagnosticHandlerTy LLVMContext::getDiagnosticHandler() const {
215   return pImpl->DiagnosticHandler;
216 }
217 
218 void *LLVMContext::getDiagnosticContext() const {
219   return pImpl->DiagnosticContext;
220 }
221 
222 void LLVMContext::setYieldCallback(YieldCallbackTy Callback, void *OpaqueHandle)
223 {
224   pImpl->YieldCallback = Callback;
225   pImpl->YieldOpaqueHandle = OpaqueHandle;
226 }
227 
228 void LLVMContext::yield() {
229   if (pImpl->YieldCallback)
230     pImpl->YieldCallback(this, pImpl->YieldOpaqueHandle);
231 }
232 
233 void LLVMContext::emitError(const Twine &ErrorStr) {
234   diagnose(DiagnosticInfoInlineAsm(ErrorStr));
235 }
236 
237 void LLVMContext::emitError(const Instruction *I, const Twine &ErrorStr) {
238   assert (I && "Invalid instruction");
239   diagnose(DiagnosticInfoInlineAsm(*I, ErrorStr));
240 }
241 
242 static bool isDiagnosticEnabled(const DiagnosticInfo &DI) {
243   // Optimization remarks are selective. They need to check whether the regexp
244   // pattern, passed via one of the -pass-remarks* flags, matches the name of
245   // the pass that is emitting the diagnostic. If there is no match, ignore the
246   // diagnostic and return.
247   if (auto *Remark = dyn_cast<DiagnosticInfoOptimizationBase>(&DI))
248     return Remark->isEnabled();
249 
250   return true;
251 }
252 
253 const char *
254 LLVMContext::getDiagnosticMessagePrefix(DiagnosticSeverity Severity) {
255   switch (Severity) {
256   case DS_Error:
257     return "error";
258   case DS_Warning:
259     return "warning";
260   case DS_Remark:
261     return "remark";
262   case DS_Note:
263     return "note";
264   }
265   llvm_unreachable("Unknown DiagnosticSeverity");
266 }
267 
268 void LLVMContext::diagnose(const DiagnosticInfo &DI) {
269   // If there is a report handler, use it.
270   if (pImpl->DiagnosticHandler) {
271     if (!pImpl->RespectDiagnosticFilters || isDiagnosticEnabled(DI))
272       pImpl->DiagnosticHandler(DI, pImpl->DiagnosticContext);
273     return;
274   }
275 
276   if (!isDiagnosticEnabled(DI))
277     return;
278 
279   // Otherwise, print the message with a prefix based on the severity.
280   DiagnosticPrinterRawOStream DP(errs());
281   errs() << getDiagnosticMessagePrefix(DI.getSeverity()) << ": ";
282   DI.print(DP);
283   errs() << "\n";
284   if (DI.getSeverity() == DS_Error)
285     exit(1);
286 }
287 
288 void LLVMContext::emitError(unsigned LocCookie, const Twine &ErrorStr) {
289   diagnose(DiagnosticInfoInlineAsm(LocCookie, ErrorStr));
290 }
291 
292 //===----------------------------------------------------------------------===//
293 // Metadata Kind Uniquing
294 //===----------------------------------------------------------------------===//
295 
296 /// Return a unique non-zero ID for the specified metadata kind.
297 unsigned LLVMContext::getMDKindID(StringRef Name) const {
298   // If this is new, assign it its ID.
299   return pImpl->CustomMDKindNames.insert(
300                                      std::make_pair(
301                                          Name, pImpl->CustomMDKindNames.size()))
302       .first->second;
303 }
304 
305 /// getHandlerNames - Populate client-supplied smallvector using custom
306 /// metadata name and ID.
307 void LLVMContext::getMDKindNames(SmallVectorImpl<StringRef> &Names) const {
308   Names.resize(pImpl->CustomMDKindNames.size());
309   for (StringMap<unsigned>::const_iterator I = pImpl->CustomMDKindNames.begin(),
310        E = pImpl->CustomMDKindNames.end(); I != E; ++I)
311     Names[I->second] = I->first();
312 }
313 
314 void LLVMContext::getOperandBundleTags(SmallVectorImpl<StringRef> &Tags) const {
315   pImpl->getOperandBundleTags(Tags);
316 }
317 
318 uint32_t LLVMContext::getOperandBundleTagID(StringRef Tag) const {
319   return pImpl->getOperandBundleTagID(Tag);
320 }
321 
322 void LLVMContext::setGC(const Function &Fn, std::string GCName) {
323   auto It = pImpl->GCNames.find(&Fn);
324 
325   if (It == pImpl->GCNames.end()) {
326     pImpl->GCNames.insert(std::make_pair(&Fn, std::move(GCName)));
327     return;
328   }
329   It->second = std::move(GCName);
330 }
331 
332 const std::string &LLVMContext::getGC(const Function &Fn) {
333   return pImpl->GCNames[&Fn];
334 }
335 
336 void LLVMContext::deleteGC(const Function &Fn) {
337   pImpl->GCNames.erase(&Fn);
338 }
339 
340 bool LLVMContext::shouldDiscardValueNames() const {
341   return pImpl->DiscardValueNames;
342 }
343 
344 bool LLVMContext::isODRUniquingDebugTypes() const { return !!pImpl->DITypeMap; }
345 
346 void LLVMContext::enableDebugTypeODRUniquing() {
347   if (pImpl->DITypeMap)
348     return;
349 
350   pImpl->DITypeMap.emplace();
351 }
352 
353 void LLVMContext::disableDebugTypeODRUniquing() { pImpl->DITypeMap.reset(); }
354 
355 void LLVMContext::setDiscardValueNames(bool Discard) {
356   pImpl->DiscardValueNames = Discard;
357 }
358 
359 OptBisect &LLVMContext::getOptBisect() {
360   return pImpl->getOptBisect();
361 }
362