LLVM  9.0.0svn
LLVMContext.cpp
Go to the documentation of this file.
1 //===-- LLVMContext.cpp - Implement LLVMContext ---------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file implements LLVMContext, as a wrapper around the opaque
10 // class LLVMContextImpl.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "llvm/IR/LLVMContext.h"
15 #include "LLVMContextImpl.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 "llvm/IR/DiagnosticInfo.h"
22 #include "llvm/IR/Metadata.h"
23 #include "llvm/IR/Module.h"
24 #include "llvm/IR/RemarkStreamer.h"
25 #include "llvm/Support/Casting.h"
28 #include <cassert>
29 #include <cstdlib>
30 #include <string>
31 #include <utility>
32 
33 using namespace llvm;
34 
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  {MD_callees, "callees"},
63  {MD_irr_loop, "irr_loop"},
64  {MD_access_group, "llvm.access.group"},
65  {MD_callback, "callback"},
66  {MD_preserve_access_index, "llvm.preserve.access.index"},
67  };
68 
69  for (auto &MDKind : MDKinds) {
70  unsigned ID = getMDKindID(MDKind.second);
71  assert(ID == MDKind.first && "metadata kind id drifted");
72  (void)ID;
73  }
74 
75  auto *DeoptEntry = pImpl->getOrInsertBundleTag("deopt");
76  assert(DeoptEntry->second == LLVMContext::OB_deopt &&
77  "deopt operand bundle id drifted!");
78  (void)DeoptEntry;
79 
80  auto *FuncletEntry = pImpl->getOrInsertBundleTag("funclet");
81  assert(FuncletEntry->second == LLVMContext::OB_funclet &&
82  "funclet operand bundle id drifted!");
83  (void)FuncletEntry;
84 
85  auto *GCTransitionEntry = pImpl->getOrInsertBundleTag("gc-transition");
86  assert(GCTransitionEntry->second == LLVMContext::OB_gc_transition &&
87  "gc-transition operand bundle id drifted!");
88  (void)GCTransitionEntry;
89 
90  SyncScope::ID SingleThreadSSID =
91  pImpl->getOrInsertSyncScopeID("singlethread");
92  assert(SingleThreadSSID == SyncScope::SingleThread &&
93  "singlethread synchronization scope ID drifted!");
94  (void)SingleThreadSSID;
95 
96  SyncScope::ID SystemSSID =
98  assert(SystemSSID == SyncScope::System &&
99  "system synchronization scope ID drifted!");
100  (void)SystemSSID;
101 }
102 
104 
105 void LLVMContext::addModule(Module *M) {
107 }
108 
109 void LLVMContext::removeModule(Module *M) {
111 }
112 
113 //===----------------------------------------------------------------------===//
114 // Recoverable Backend Errors
115 //===----------------------------------------------------------------------===//
116 
117 void LLVMContext::
119  void *DiagContext) {
121  pImpl->InlineAsmDiagContext = DiagContext;
122 }
123 
124 /// getInlineAsmDiagnosticHandler - Return the diagnostic handler set by
125 /// setInlineAsmDiagnosticHandler.
128  return pImpl->InlineAsmDiagHandler;
129 }
130 
131 /// getInlineAsmDiagnosticContext - Return the diagnostic context set by
132 /// setInlineAsmDiagnosticHandler.
134  return pImpl->InlineAsmDiagContext;
135 }
136 
139  void *DiagnosticContext, bool RespectFilters) {
140  pImpl->DiagHandler->DiagHandlerCallback = DiagnosticHandler;
141  pImpl->DiagHandler->DiagnosticContext = DiagnosticContext;
142  pImpl->RespectDiagnosticFilters = RespectFilters;
143 }
144 
145 void LLVMContext::setDiagnosticHandler(std::unique_ptr<DiagnosticHandler> &&DH,
146  bool RespectFilters) {
147  pImpl->DiagHandler = std::move(DH);
148  pImpl->RespectDiagnosticFilters = RespectFilters;
149 }
150 
152  pImpl->DiagnosticsHotnessRequested = Requested;
153 }
156 }
157 
160 }
163 }
164 
166  return pImpl->RemarkDiagStreamer.get();
167 }
169  return const_cast<LLVMContext *>(this)->getRemarkStreamer();
170 }
172  std::unique_ptr<RemarkStreamer> RemarkStreamer) {
173  pImpl->RemarkDiagStreamer = std::move(RemarkStreamer);
174 }
175 
178  return pImpl->DiagHandler->DiagHandlerCallback;
179 }
180 
182  return pImpl->DiagHandler->DiagnosticContext;
183 }
184 
185 void LLVMContext::setYieldCallback(YieldCallbackTy Callback, void *OpaqueHandle)
186 {
187  pImpl->YieldCallback = Callback;
188  pImpl->YieldOpaqueHandle = OpaqueHandle;
189 }
190 
192  if (pImpl->YieldCallback)
194 }
195 
196 void LLVMContext::emitError(const Twine &ErrorStr) {
198 }
199 
200 void LLVMContext::emitError(const Instruction *I, const Twine &ErrorStr) {
201  assert (I && "Invalid instruction");
202  diagnose(DiagnosticInfoInlineAsm(*I, ErrorStr));
203 }
204 
205 static bool isDiagnosticEnabled(const DiagnosticInfo &DI) {
206  // Optimization remarks are selective. They need to check whether the regexp
207  // pattern, passed via one of the -pass-remarks* flags, matches the name of
208  // the pass that is emitting the diagnostic. If there is no match, ignore the
209  // diagnostic and return.
210  //
211  // Also noisy remarks are only enabled if we have hotness information to sort
212  // them.
213  if (auto *Remark = dyn_cast<DiagnosticInfoOptimizationBase>(&DI))
214  return Remark->isEnabled() &&
215  (!Remark->isVerbose() || Remark->getHotness());
216 
217  return true;
218 }
219 
220 const char *
222  switch (Severity) {
223  case DS_Error:
224  return "error";
225  case DS_Warning:
226  return "warning";
227  case DS_Remark:
228  return "remark";
229  case DS_Note:
230  return "note";
231  }
232  llvm_unreachable("Unknown DiagnosticSeverity");
233 }
234 
236  if (auto *OptDiagBase = dyn_cast<DiagnosticInfoOptimizationBase>(&DI))
237  if (RemarkStreamer *RS = getRemarkStreamer())
238  RS->emit(*OptDiagBase);
239 
240  // If there is a report handler, use it.
241  if (pImpl->DiagHandler &&
243  pImpl->DiagHandler->handleDiagnostics(DI))
244  return;
245 
246  if (!isDiagnosticEnabled(DI))
247  return;
248 
249  // Otherwise, print the message with a prefix based on the severity.
251  errs() << getDiagnosticMessagePrefix(DI.getSeverity()) << ": ";
252  DI.print(DP);
253  errs() << "\n";
254  if (DI.getSeverity() == DS_Error)
255  exit(1);
256 }
257 
258 void LLVMContext::emitError(unsigned LocCookie, const Twine &ErrorStr) {
259  diagnose(DiagnosticInfoInlineAsm(LocCookie, ErrorStr));
260 }
261 
262 //===----------------------------------------------------------------------===//
263 // Metadata Kind Uniquing
264 //===----------------------------------------------------------------------===//
265 
266 /// Return a unique non-zero ID for the specified metadata kind.
268  // If this is new, assign it its ID.
270  std::make_pair(
271  Name, pImpl->CustomMDKindNames.size()))
272  .first->second;
273 }
274 
275 /// getHandlerNames - Populate client-supplied smallvector using custom
276 /// metadata name and ID.
280  E = pImpl->CustomMDKindNames.end(); I != E; ++I)
281  Names[I->second] = I->first();
282 }
283 
286 }
287 
289  return pImpl->getOperandBundleTagID(Tag);
290 }
291 
293  return pImpl->getOrInsertSyncScopeID(SSN);
294 }
295 
297  pImpl->getSyncScopeNames(SSNs);
298 }
299 
300 void LLVMContext::setGC(const Function &Fn, std::string GCName) {
301  auto It = pImpl->GCNames.find(&Fn);
302 
303  if (It == pImpl->GCNames.end()) {
304  pImpl->GCNames.insert(std::make_pair(&Fn, std::move(GCName)));
305  return;
306  }
307  It->second = std::move(GCName);
308 }
309 
310 const std::string &LLVMContext::getGC(const Function &Fn) {
311  return pImpl->GCNames[&Fn];
312 }
313 
315  pImpl->GCNames.erase(&Fn);
316 }
317 
319  return pImpl->DiscardValueNames;
320 }
321 
323 
325  if (pImpl->DITypeMap)
326  return;
327 
328  pImpl->DITypeMap.emplace();
329 }
330 
332 
334  pImpl->DiscardValueNames = Discard;
335 }
336 
338  return pImpl->getOptPassGate();
339 }
340 
342  pImpl->setOptPassGate(OPG);
343 }
344 
346  return pImpl->DiagHandler.get();
347 }
348 
349 std::unique_ptr<DiagnosticHandler> LLVMContext::getDiagnosticHandler() {
350  return std::move(pImpl->DiagHandler);
351 }
void setDiagnosticHandler(std::unique_ptr< DiagnosticHandler > &&DH, bool RespectFilters=false)
setDiagnosticHandler - This method sets unique_ptr to object of DiagnosticHandler to provide custom d...
This is the base class for diagnostic handling in LLVM.
raw_ostream & errs()
This returns a reference to a raw_ostream for standard error.
void setRemarkStreamer(std::unique_ptr< RemarkStreamer > RemarkStreamer)
Set the diagnostics output used for optimization diagnostics.
void getOperandBundleTags(SmallVectorImpl< StringRef > &Tags) const
This class represents lattice values for constants.
Definition: AllocatorList.h:23
A Module instance is used to store all the information related to an LLVM module. ...
Definition: Module.h:65
const std::string & getGC(const Function &Fn)
Return the GC for a function.
Extensions to this class implement mechanisms to disable passes and individual optimizations at compi...
Definition: OptBisect.h:25
amdgpu Simplify well known AMD library false FunctionCallee Value const Twine & Name
RemarkStreamer * getRemarkStreamer()
Return the streamer used by the backend to save remark diagnostics.
std::unique_ptr< DiagnosticHandler > getDiagnosticHandler()
getDiagnosticHandler - transfers owenership of DiagnosticHandler unique_ptr to caller.
void(*)(LLVMContext *Context, void *OpaqueHandle) YieldCallbackTy
Defines the type of a yield callback.
Definition: LLVMContext.h:173
uint32_t getOperandBundleTagID(StringRef Tag) const
void setGC(const Function &Fn, std::string GCName)
Define the GC for a function.
SyncScope::ID getOrInsertSyncScopeID(StringRef SSN)
getOrInsertSyncScopeID - Maps synchronization scope name to synchronization scope ID...
This file contains the declarations for metadata subclasses.
void enableDebugTypeODRUniquing()
void * getInlineAsmDiagnosticContext() const
getInlineAsmDiagnosticContext - Return the diagnostic context set by setInlineAsmDiagnosticHandler.
void setInlineAsmDiagnosticHandler(InlineAsmDiagHandlerTy DiagHandler, void *DiagContext=nullptr)
setInlineAsmDiagnosticHandler - This method sets a handler that is invoked when problems with inline ...
void setYieldCallback(YieldCallbackTy Callback, void *OpaqueHandle)
Registers a yield callback with the given context.
void getSyncScopeNames(SmallVectorImpl< StringRef > &SSNs) const
getSyncScopeNames - Populates client supplied SmallVector with synchronization scope names registered...
void yield()
Calls the yield callback (if applicable).
LLVMContext::InlineAsmDiagHandlerTy InlineAsmDiagHandler
void setDiscardValueNames(bool Discard)
Set the Context runtime configuration to discard all value name (but GlobalValue).
void disableDebugTypeODRUniquing()
unsigned getMDKindID(StringRef Name) const
getMDKindID - Return a unique non-zero ID for the specified metadata kind.
void setDiagnosticsHotnessThreshold(uint64_t Threshold)
Set the minimum hotness value a diagnostic needs in order to be included in optimization diagnostics...
DiagnosticSeverity
Defines the different supported severity of a diagnostic.
unsigned size() const
Definition: StringMap.h:111
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:80
void getMDKindNames(SmallVectorImpl< StringRef > &Result) const
getMDKindNames - Populate client supplied SmallVector with the name for custom metadata IDs registere...
void deleteGC(const Function &Fn)
Remove the GC for a function.
std::unique_ptr< DiagnosticHandler > DiagHandler
bool DiscardValueNames
Flag to indicate if Value (other than GlobalValue) retains their name or not.
static void DiagHandler(const SMDiagnostic &Diag, void *Context)
Definition: TextStub.cpp:611
void emitError(unsigned LocCookie, const Twine &ErrorStr)
emitError - Emit an error message to the currently installed error handler with optional location inf...
OptPassGate & getOptPassGate() const
Access the object which can disable optional passes and individual optimizations at compile time...
void setDiagnosticsHotnessRequested(bool Requested)
Set if a code hotness metric should be included in optimization diagnostics.
void setOptPassGate(OptPassGate &)
Set the object which can disable optional passes and individual optimizations at compile time...
void(*)(const DiagnosticInfo &DI, void *Context) DiagnosticHandlerTy
LLVMContext::YieldCallbackTy YieldCallback
void setDiagnosticHandlerCallBack(DiagnosticHandler::DiagnosticHandlerTy DiagHandler, void *DiagContext=nullptr, bool RespectFilters=false)
setDiagnosticHandlerCallBack - This method sets a handler call back that is invoked when the backend ...
StringMap< unsigned > CustomMDKindNames
CustomMDKindNames - Map to hold the metadata string to ID mapping.
Synchronized with respect to all concurrently executing threads.
Definition: LLVMContext.h:54
void setOptPassGate(OptPassGate &)
Set the object which can disable optional passes and individual optimizations at compile time...
This is the base abstract class for diagnostic reporting in the backend.
OptPassGate & getOptPassGate() const
Access the object which can disable optional passes and individual optimizations at compile time...
This is an important class for using LLVM in a threaded context.
Definition: LLVMContext.h:64
StringMapEntry< uint32_t > * getOrInsertBundleTag(StringRef Tag)
bool shouldDiscardValueNames() const
Return true if the Context runtime configuration is set to discard all value names.
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
void getOperandBundleTags(SmallVectorImpl< StringRef > &Result) const
getOperandBundleTags - Populate client supplied SmallVector with the bundle tags registered in this L...
void getSyncScopeNames(SmallVectorImpl< StringRef > &SSNs) const
getSyncScopeNames - Populates client supplied SmallVector with synchronization scope names registered...
std::pair< iterator, bool > insert(PtrType Ptr)
Inserts Ptr if and only if there is no element in the container equal to Ptr.
Definition: SmallPtrSet.h:370
uint64_t getDiagnosticsHotnessThreshold() const
Return the minimum hotness value a diagnostic would need in order to be included in optimization diag...
bool getDiagnosticsHotnessRequested() const
Return if a code hotness metric should be included in optimization diagnostics.
bool isODRUniquingDebugTypes() const
Whether there is a string map for uniquing debug info identifiers across the context.
uint64_t DiagnosticsHotnessThreshold
Diagnostic information for inline asm reporting.
virtual void print(DiagnosticPrinter &DP) const =0
Print using the given DP a user-friendly message.
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
LLVMContextImpl *const pImpl
Definition: LLVMContext.h:66
bool erase(PtrType Ptr)
erase - If the set contains the specified pointer, remove it and return true, otherwise return false...
Definition: SmallPtrSet.h:377
Module.h This file contains the declarations for the Module class.
static const char * getDiagnosticMessagePrefix(DiagnosticSeverity Severity)
Get the prefix that should be printed in front of a diagnostic of the given Severity.
bool insert(MapEntryTy *KeyValue)
insert - Insert the specified key/value pair into the map.
Definition: StringMap.h:370
SmallPtrSet< Module *, 4 > OwnedModules
OwnedModules - The set of modules instantiated in this context, and which will be automatically delet...
StringMap - This is an unconventional map that is specialized for handling keys that are "strings"...
Definition: StringMap.h:219
void(*)(const SMDiagnostic &, void *Context, unsigned LocCookie) InlineAsmDiagHandlerTy
Definition: LLVMContext.h:169
static cl::opt< unsigned > Threshold("loop-unswitch-threshold", cl::desc("Max loop size to unswitch"), cl::init(100), cl::Hidden)
Streamer for remarks.
SyncScope::ID getOrInsertSyncScopeID(StringRef SSN)
getOrInsertSyncScopeID - Maps synchronization scope name to synchronization scope ID...
Basic diagnostic printer that uses an underlying raw_ostream.
iterator begin()
Definition: StringMap.h:314
#define I(x, y, z)
Definition: MD5.cpp:58
DenseMap< const Function *, std::string > GCNames
Maintain the GC name for each function.
DiagnosticSeverity getSeverity() const
InlineAsmDiagHandlerTy getInlineAsmDiagnosticHandler() const
getInlineAsmDiagnosticHandler - Return the diagnostic handler set by setInlineAsmDiagnosticHandler.
void diagnose(const DiagnosticInfo &DI)
Report a message to the currently installed diagnostic handler.
std::unique_ptr< RemarkStreamer > RemarkDiagStreamer
const DiagnosticHandler * getDiagHandlerPtr() const
getDiagHandlerPtr - Returns const raw pointer of DiagnosticHandler set by setDiagnosticHandler.
Synchronized with respect to signal handlers executing in the same thread.
Definition: LLVMContext.h:51
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48
void * getDiagnosticContext() const
getDiagnosticContext - Return the diagnostic context set by setDiagnosticContext. ...
static bool isDiagnosticEnabled(const DiagnosticInfo &DI)
DiagnosticHandler::DiagnosticHandlerTy getDiagnosticHandlerCallBack() const
getDiagnosticHandlerCallBack - Return the diagnostic handler call back set by setDiagnosticHandlerCal...
Optional< DenseMap< const MDString *, DICompositeType * > > DITypeMap
iterator end()
Definition: StringMap.h:317
uint32_t getOperandBundleTagID(StringRef Tag) const
getOperandBundleTagID - Maps a bundle tag to an integer ID.
void resize(size_type N)
Definition: SmallVector.h:344