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::setDiagnosticHandler(DiagnosticHandlerTy DiagnosticHandler,
133                                        void *DiagnosticContext,
134                                        bool RespectFilters) {
135   pImpl->DiagnosticHandler = DiagnosticHandler;
136   pImpl->DiagnosticContext = DiagnosticContext;
137   pImpl->RespectDiagnosticFilters = RespectFilters;
138 }
139 
140 void LLVMContext::setDiagnosticsHotnessRequested(bool Requested) {
141   pImpl->DiagnosticsHotnessRequested = Requested;
142 }
143 bool LLVMContext::getDiagnosticsHotnessRequested() const {
144   return pImpl->DiagnosticsHotnessRequested;
145 }
146 
147 void LLVMContext::setDiagnosticsHotnessThreshold(uint64_t Threshold) {
148   pImpl->DiagnosticsHotnessThreshold = Threshold;
149 }
150 uint64_t LLVMContext::getDiagnosticsHotnessThreshold() const {
151   return pImpl->DiagnosticsHotnessThreshold;
152 }
153 
154 yaml::Output *LLVMContext::getDiagnosticsOutputFile() {
155   return pImpl->DiagnosticsOutputFile.get();
156 }
157 
158 void LLVMContext::setDiagnosticsOutputFile(std::unique_ptr<yaml::Output> F) {
159   pImpl->DiagnosticsOutputFile = std::move(F);
160 }
161 
162 LLVMContext::DiagnosticHandlerTy LLVMContext::getDiagnosticHandler() const {
163   return pImpl->DiagnosticHandler;
164 }
165 
166 void *LLVMContext::getDiagnosticContext() const {
167   return pImpl->DiagnosticContext;
168 }
169 
170 void LLVMContext::setYieldCallback(YieldCallbackTy Callback, void *OpaqueHandle)
171 {
172   pImpl->YieldCallback = Callback;
173   pImpl->YieldOpaqueHandle = OpaqueHandle;
174 }
175 
176 void LLVMContext::yield() {
177   if (pImpl->YieldCallback)
178     pImpl->YieldCallback(this, pImpl->YieldOpaqueHandle);
179 }
180 
181 void LLVMContext::emitError(const Twine &ErrorStr) {
182   diagnose(DiagnosticInfoInlineAsm(ErrorStr));
183 }
184 
185 void LLVMContext::emitError(const Instruction *I, const Twine &ErrorStr) {
186   assert (I && "Invalid instruction");
187   diagnose(DiagnosticInfoInlineAsm(*I, ErrorStr));
188 }
189 
190 static bool isDiagnosticEnabled(const DiagnosticInfo &DI) {
191   // Optimization remarks are selective. They need to check whether the regexp
192   // pattern, passed via one of the -pass-remarks* flags, matches the name of
193   // the pass that is emitting the diagnostic. If there is no match, ignore the
194   // diagnostic and return.
195   if (auto *Remark = dyn_cast<DiagnosticInfoOptimizationBase>(&DI))
196     return Remark->isEnabled();
197 
198   return true;
199 }
200 
201 const char *
202 LLVMContext::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 custom
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 
262 void LLVMContext::getOperandBundleTags(SmallVectorImpl<StringRef> &Tags) const {
263   pImpl->getOperandBundleTags(Tags);
264 }
265 
266 uint32_t LLVMContext::getOperandBundleTagID(StringRef Tag) const {
267   return pImpl->getOperandBundleTagID(Tag);
268 }
269 
270 SyncScope::ID LLVMContext::getOrInsertSyncScopeID(StringRef SSN) {
271   return pImpl->getOrInsertSyncScopeID(SSN);
272 }
273 
274 void LLVMContext::getSyncScopeNames(SmallVectorImpl<StringRef> &SSNs) const {
275   pImpl->getSyncScopeNames(SSNs);
276 }
277 
278 void LLVMContext::setGC(const Function &Fn, std::string GCName) {
279   auto It = pImpl->GCNames.find(&Fn);
280 
281   if (It == pImpl->GCNames.end()) {
282     pImpl->GCNames.insert(std::make_pair(&Fn, std::move(GCName)));
283     return;
284   }
285   It->second = std::move(GCName);
286 }
287 
288 const std::string &LLVMContext::getGC(const Function &Fn) {
289   return pImpl->GCNames[&Fn];
290 }
291 
292 void LLVMContext::deleteGC(const Function &Fn) {
293   pImpl->GCNames.erase(&Fn);
294 }
295 
296 bool LLVMContext::shouldDiscardValueNames() const {
297   return pImpl->DiscardValueNames;
298 }
299 
300 bool LLVMContext::isODRUniquingDebugTypes() const { return !!pImpl->DITypeMap; }
301 
302 void LLVMContext::enableDebugTypeODRUniquing() {
303   if (pImpl->DITypeMap)
304     return;
305 
306   pImpl->DITypeMap.emplace();
307 }
308 
309 void LLVMContext::disableDebugTypeODRUniquing() { pImpl->DITypeMap.reset(); }
310 
311 void LLVMContext::setDiscardValueNames(bool Discard) {
312   pImpl->DiscardValueNames = Discard;
313 }
314 
315 OptBisect &LLVMContext::getOptBisect() {
316   return pImpl->getOptBisect();
317 }
318