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/ADT/SmallVector.h"
18 #include "llvm/ADT/StringMap.h"
19 #include "llvm/ADT/StringRef.h"
20 #include "llvm/ADT/Twine.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   std::pair<unsigned, StringRef> MDKinds[] = {
39     {MD_dbg, "dbg"},
40     {MD_tbaa, "tbaa"},
41     {MD_prof, "prof"},
42     {MD_fpmath, "fpmath"},
43     {MD_range, "range"},
44     {MD_tbaa_struct, "tbaa.struct"},
45     {MD_invariant_load, "invariant.load"},
46     {MD_alias_scope, "alias.scope"},
47     {MD_noalias, "noalias"},
48     {MD_nontemporal, "nontemporal"},
49     {MD_mem_parallel_loop_access, "llvm.mem.parallel_loop_access"},
50     {MD_nonnull, "nonnull"},
51     {MD_dereferenceable, "dereferenceable"},
52     {MD_dereferenceable_or_null, "dereferenceable_or_null"},
53     {MD_make_implicit, "make.implicit"},
54     {MD_unpredictable, "unpredictable"},
55     {MD_invariant_group, "invariant.group"},
56     {MD_align, "align"},
57     {MD_loop, "llvm.loop"},
58     {MD_type, "type"},
59     {MD_section_prefix, "section_prefix"},
60     {MD_absolute_symbol, "absolute_symbol"},
61     {MD_associated, "associated"},
62   };
63 
64   for (auto &MDKind : MDKinds) {
65     unsigned ID = getMDKindID(MDKind.second);
66     assert(ID == MDKind.first && "metadata kind id drifted");
67     (void)ID;
68   }
69 
70   auto *DeoptEntry = pImpl->getOrInsertBundleTag("deopt");
71   assert(DeoptEntry->second == LLVMContext::OB_deopt &&
72          "deopt operand bundle id drifted!");
73   (void)DeoptEntry;
74 
75   auto *FuncletEntry = pImpl->getOrInsertBundleTag("funclet");
76   assert(FuncletEntry->second == LLVMContext::OB_funclet &&
77          "funclet operand bundle id drifted!");
78   (void)FuncletEntry;
79 
80   auto *GCTransitionEntry = pImpl->getOrInsertBundleTag("gc-transition");
81   assert(GCTransitionEntry->second == LLVMContext::OB_gc_transition &&
82          "gc-transition operand bundle id drifted!");
83   (void)GCTransitionEntry;
84 
85   SyncScope::ID SingleThreadSSID =
86       pImpl->getOrInsertSyncScopeID("singlethread");
87   assert(SingleThreadSSID == SyncScope::SingleThread &&
88          "singlethread synchronization scope ID drifted!");
89   (void)SingleThreadSSID;
90 
91   SyncScope::ID SystemSSID =
92       pImpl->getOrInsertSyncScopeID("");
93   assert(SystemSSID == SyncScope::System &&
94          "system synchronization scope ID drifted!");
95   (void)SystemSSID;
96 }
97 
98 LLVMContext::~LLVMContext() { delete pImpl; }
99 
100 void LLVMContext::addModule(Module *M) {
101   pImpl->OwnedModules.insert(M);
102 }
103 
104 void LLVMContext::removeModule(Module *M) {
105   pImpl->OwnedModules.erase(M);
106 }
107 
108 //===----------------------------------------------------------------------===//
109 // Recoverable Backend Errors
110 //===----------------------------------------------------------------------===//
111 
112 void LLVMContext::
113 setInlineAsmDiagnosticHandler(InlineAsmDiagHandlerTy DiagHandler,
114                               void *DiagContext) {
115   pImpl->InlineAsmDiagHandler = DiagHandler;
116   pImpl->InlineAsmDiagContext = DiagContext;
117 }
118 
119 /// getInlineAsmDiagnosticHandler - Return the diagnostic handler set by
120 /// setInlineAsmDiagnosticHandler.
121 LLVMContext::InlineAsmDiagHandlerTy
122 LLVMContext::getInlineAsmDiagnosticHandler() const {
123   return pImpl->InlineAsmDiagHandler;
124 }
125 
126 /// getInlineAsmDiagnosticContext - Return the diagnostic context set by
127 /// setInlineAsmDiagnosticHandler.
128 void *LLVMContext::getInlineAsmDiagnosticContext() const {
129   return pImpl->InlineAsmDiagContext;
130 }
131 
132 void LLVMContext::setDiagnosticHandlerCallBack(
133     DiagnosticHandler::DiagnosticHandlerTy DiagnosticHandler,
134     void *DiagnosticContext, bool RespectFilters) {
135   pImpl->DiagHandler->DiagHandlerCallback = DiagnosticHandler;
136   pImpl->DiagHandler->DiagnosticContext = DiagnosticContext;
137   pImpl->RespectDiagnosticFilters = RespectFilters;
138 }
139 
140 void LLVMContext::setDiagnosticHandler(std::unique_ptr<DiagnosticHandler> &&DH,
141                                       bool RespectFilters) {
142   pImpl->DiagHandler = std::move(DH);
143   pImpl->RespectDiagnosticFilters = RespectFilters;
144 }
145 
146 void LLVMContext::setDiagnosticsHotnessRequested(bool Requested) {
147   pImpl->DiagnosticsHotnessRequested = Requested;
148 }
149 bool LLVMContext::getDiagnosticsHotnessRequested() const {
150   return pImpl->DiagnosticsHotnessRequested;
151 }
152 
153 void LLVMContext::setDiagnosticsHotnessThreshold(uint64_t Threshold) {
154   pImpl->DiagnosticsHotnessThreshold = Threshold;
155 }
156 uint64_t LLVMContext::getDiagnosticsHotnessThreshold() const {
157   return pImpl->DiagnosticsHotnessThreshold;
158 }
159 
160 yaml::Output *LLVMContext::getDiagnosticsOutputFile() {
161   return pImpl->DiagnosticsOutputFile.get();
162 }
163 
164 void LLVMContext::setDiagnosticsOutputFile(std::unique_ptr<yaml::Output> F) {
165   pImpl->DiagnosticsOutputFile = std::move(F);
166 }
167 
168 DiagnosticHandler::DiagnosticHandlerTy
169 LLVMContext::getDiagnosticHandlerCallBack() const {
170   return pImpl->DiagHandler->DiagHandlerCallback;
171 }
172 
173 void *LLVMContext::getDiagnosticContext() const {
174   return pImpl->DiagHandler->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   //
203   // Also noisy remarks are only enabled if we have hotness information to sort
204   // them.
205   if (auto *Remark = dyn_cast<DiagnosticInfoOptimizationBase>(&DI))
206     return Remark->isEnabled() &&
207            (!Remark->isVerbose() || Remark->getHotness());
208 
209   return true;
210 }
211 
212 const char *
213 LLVMContext::getDiagnosticMessagePrefix(DiagnosticSeverity Severity) {
214   switch (Severity) {
215   case DS_Error:
216     return "error";
217   case DS_Warning:
218     return "warning";
219   case DS_Remark:
220     return "remark";
221   case DS_Note:
222     return "note";
223   }
224   llvm_unreachable("Unknown DiagnosticSeverity");
225 }
226 
227 void LLVMContext::diagnose(const DiagnosticInfo &DI) {
228   if (auto *OptDiagBase = dyn_cast<DiagnosticInfoOptimizationBase>(&DI)) {
229     yaml::Output *Out = getDiagnosticsOutputFile();
230     if (Out) {
231       // For remarks the << operator takes a reference to a pointer.
232       auto *P = const_cast<DiagnosticInfoOptimizationBase *>(OptDiagBase);
233       *Out << P;
234     }
235   }
236   // If there is a report handler, use it.
237   if (pImpl->DiagHandler &&
238       (!pImpl->RespectDiagnosticFilters || isDiagnosticEnabled(DI)) &&
239       pImpl->DiagHandler->handleDiagnostics(DI))
240     return;
241 
242   if (!isDiagnosticEnabled(DI))
243     return;
244 
245   // Otherwise, print the message with a prefix based on the severity.
246   DiagnosticPrinterRawOStream DP(errs());
247   errs() << getDiagnosticMessagePrefix(DI.getSeverity()) << ": ";
248   DI.print(DP);
249   errs() << "\n";
250   if (DI.getSeverity() == DS_Error)
251     exit(1);
252 }
253 
254 void LLVMContext::emitError(unsigned LocCookie, const Twine &ErrorStr) {
255   diagnose(DiagnosticInfoInlineAsm(LocCookie, ErrorStr));
256 }
257 
258 //===----------------------------------------------------------------------===//
259 // Metadata Kind Uniquing
260 //===----------------------------------------------------------------------===//
261 
262 /// Return a unique non-zero ID for the specified metadata kind.
263 unsigned LLVMContext::getMDKindID(StringRef Name) const {
264   // If this is new, assign it its ID.
265   return pImpl->CustomMDKindNames.insert(
266                                      std::make_pair(
267                                          Name, pImpl->CustomMDKindNames.size()))
268       .first->second;
269 }
270 
271 /// getHandlerNames - Populate client-supplied smallvector using custom
272 /// metadata name and ID.
273 void LLVMContext::getMDKindNames(SmallVectorImpl<StringRef> &Names) const {
274   Names.resize(pImpl->CustomMDKindNames.size());
275   for (StringMap<unsigned>::const_iterator I = pImpl->CustomMDKindNames.begin(),
276        E = pImpl->CustomMDKindNames.end(); I != E; ++I)
277     Names[I->second] = I->first();
278 }
279 
280 void LLVMContext::getOperandBundleTags(SmallVectorImpl<StringRef> &Tags) const {
281   pImpl->getOperandBundleTags(Tags);
282 }
283 
284 uint32_t LLVMContext::getOperandBundleTagID(StringRef Tag) const {
285   return pImpl->getOperandBundleTagID(Tag);
286 }
287 
288 SyncScope::ID LLVMContext::getOrInsertSyncScopeID(StringRef SSN) {
289   return pImpl->getOrInsertSyncScopeID(SSN);
290 }
291 
292 void LLVMContext::getSyncScopeNames(SmallVectorImpl<StringRef> &SSNs) const {
293   pImpl->getSyncScopeNames(SSNs);
294 }
295 
296 void LLVMContext::setGC(const Function &Fn, std::string GCName) {
297   auto It = pImpl->GCNames.find(&Fn);
298 
299   if (It == pImpl->GCNames.end()) {
300     pImpl->GCNames.insert(std::make_pair(&Fn, std::move(GCName)));
301     return;
302   }
303   It->second = std::move(GCName);
304 }
305 
306 const std::string &LLVMContext::getGC(const Function &Fn) {
307   return pImpl->GCNames[&Fn];
308 }
309 
310 void LLVMContext::deleteGC(const Function &Fn) {
311   pImpl->GCNames.erase(&Fn);
312 }
313 
314 bool LLVMContext::shouldDiscardValueNames() const {
315   return pImpl->DiscardValueNames;
316 }
317 
318 bool LLVMContext::isODRUniquingDebugTypes() const { return !!pImpl->DITypeMap; }
319 
320 void LLVMContext::enableDebugTypeODRUniquing() {
321   if (pImpl->DITypeMap)
322     return;
323 
324   pImpl->DITypeMap.emplace();
325 }
326 
327 void LLVMContext::disableDebugTypeODRUniquing() { pImpl->DITypeMap.reset(); }
328 
329 void LLVMContext::setDiscardValueNames(bool Discard) {
330   pImpl->DiscardValueNames = Discard;
331 }
332 
333 OptBisect &LLVMContext::getOptBisect() {
334   return pImpl->getOptBisect();
335 }
336 
337 const DiagnosticHandler *LLVMContext::getDiagHandlerPtr() const {
338   return pImpl->DiagHandler.get();
339 }
340 
341 std::unique_ptr<DiagnosticHandler> LLVMContext::getDiagnosticHandler() {
342   return std::move(pImpl->DiagHandler);
343 }
344