lib/IR/LLVMContext.cpp

   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 LLVMContext::~LLVMContext() { delete pImpl; }
  71
  72 void LLVMContext::addModule(Module *M) {
  73   pImpl->OwnedModules.insert(M);
  74 }
  75
  76 void LLVMContext::removeModule(Module *M) {
  77   pImpl->OwnedModules.erase(M);
  78 }
  79
  80 //===----------------------------------------------------------------------===//
  81 // Recoverable Backend Errors
  82 //===----------------------------------------------------------------------===//
  83
  84 void LLVMContext::
  85 setInlineAsmDiagnosticHandler(InlineAsmDiagHandlerTy DiagHandler,
  86                               void *DiagContext) {
  87   pImpl->InlineAsmDiagHandler = DiagHandler;
  88   pImpl->InlineAsmDiagContext = DiagContext;
  89 }
  90
  91 /// getInlineAsmDiagnosticHandler - Return the diagnostic handler set by
  92 /// setInlineAsmDiagnosticHandler.
  93 LLVMContext::InlineAsmDiagHandlerTy
  94 LLVMContext::getInlineAsmDiagnosticHandler() const {
  95   return pImpl->InlineAsmDiagHandler;
  96 }
  97
  98 /// getInlineAsmDiagnosticContext - Return the diagnostic context set by
  99 /// setInlineAsmDiagnosticHandler.
 100 void *LLVMContext::getInlineAsmDiagnosticContext() const {
 101   return pImpl->InlineAsmDiagContext;
 102 }
 103
 104 void LLVMContext::setDiagnosticHandler(DiagnosticHandlerTy DiagnosticHandler,
 105                                        void *DiagnosticContext) {
 106   pImpl->DiagnosticHandler = DiagnosticHandler;
 107   pImpl->DiagnosticContext = DiagnosticContext;
 108 }
 109
 110 LLVMContext::DiagnosticHandlerTy LLVMContext::getDiagnosticHandler() const {
 111   return pImpl->DiagnosticHandler;
 112 }
 113
 114 void *LLVMContext::getDiagnosticContext() const {
 115   return pImpl->DiagnosticContext;
 116 }
 117
 118 void LLVMContext::emitError(const Twine &ErrorStr) {
 119   diagnose(DiagnosticInfoInlineAsm(ErrorStr));
 120 }
 121
 122 void LLVMContext::emitError(const Instruction *I, const Twine &ErrorStr) {
 123   assert (I && "Invalid instruction");
 124   diagnose(DiagnosticInfoInlineAsm(*I, ErrorStr));
 125 }
 126
 127 void LLVMContext::diagnose(const DiagnosticInfo &DI) {
 128   // If there is a report handler, use it.
 129   if (pImpl->DiagnosticHandler) {
 130     pImpl->DiagnosticHandler(DI, pImpl->DiagnosticContext);
 131     return;
 132   }
 133
 134   // Optimization remarks are selective. They need to check whether
 135   // the regexp pattern, passed via -pass-remarks, matches the name
 136   // of the pass that is emitting the diagnostic. If there is no match,
 137   // ignore the diagnostic and return.
 138   if (DI.getKind() == llvm::DK_OptimizationRemark &&
 139       !pImpl->optimizationRemarksEnabledFor(
 140           cast<DiagnosticInfoOptimizationRemark>(DI).getPassName()))
 141     return;
 142
 143   // Otherwise, print the message with a prefix based on the severity.
 144   std::string MsgStorage;
 145   raw_string_ostream Stream(MsgStorage);
 146   DiagnosticPrinterRawOStream DP(Stream);
 147   DI.print(DP);
 148   Stream.flush();
 149   switch (DI.getSeverity()) {
 150   case DS_Error:
 151     errs() << "error: " << MsgStorage << "\n";
 152     exit(1);
 153   case DS_Warning:
 154     errs() << "warning: " << MsgStorage << "\n";
 155     break;
 156   case DS_Remark:
 157     errs() << "remark: " << MsgStorage << "\n";
 158     break;
 159   case DS_Note:
 160     errs() << "note: " << MsgStorage << "\n";
 161     break;
 162   }
 163 }
 164
 165 void LLVMContext::emitError(unsigned LocCookie, const Twine &ErrorStr) {
 166   diagnose(DiagnosticInfoInlineAsm(LocCookie, ErrorStr));
 167 }
 168
 169 void LLVMContext::emitOptimizationRemark(const char *PassName,
 170                                          const Function &Fn,
 171                                          const DebugLoc &DLoc,
 172                                          const Twine &Msg) {
 173   diagnose(DiagnosticInfoOptimizationRemark(PassName, Fn, DLoc, Msg));
 174 }
 175
 176 //===----------------------------------------------------------------------===//
 177 // Metadata Kind Uniquing
 178 //===----------------------------------------------------------------------===//
 179
 180 #ifndef NDEBUG
 181 /// isValidName - Return true if Name is a valid custom metadata handler name.
 182 static bool isValidName(StringRef MDName) {
 183   if (MDName.empty())
 184     return false;
 185
 186   if (!std::isalpha(static_cast<unsigned char>(MDName[0])))
 187     return false;
 188
 189   for (StringRef::iterator I = MDName.begin() + 1, E = MDName.end(); I != E;
 190        ++I) {
 191     if (!std::isalnum(static_cast<unsigned char>(*I)) && *I != '_' &&
 192         *I != '-' && *I != '.')
 193       return false;
 194   }
 195   return true;
 196 }
 197 #endif
 198
 199 /// getMDKindID - Return a unique non-zero ID for the specified metadata kind.
 200 unsigned LLVMContext::getMDKindID(StringRef Name) const {
 201   assert(isValidName(Name) && "Invalid MDNode name");
 202
 203   // If this is new, assign it its ID.
 204   return
 205     pImpl->CustomMDKindNames.GetOrCreateValue(
 206       Name, pImpl->CustomMDKindNames.size()).second;
 207 }
 208
 209 /// getHandlerNames - Populate client supplied smallvector using custome
 210 /// metadata name and ID.
 211 void LLVMContext::getMDKindNames(SmallVectorImpl<StringRef> &Names) const {
 212   Names.resize(pImpl->CustomMDKindNames.size());
 213   for (StringMap<unsigned>::const_iterator I = pImpl->CustomMDKindNames.begin(),
 214        E = pImpl->CustomMDKindNames.end(); I != E; ++I)
 215     Names[I->second] = I->first();
 216 }
 217
 218 //===----------------------------------------------------------------------===//
 219 // Pass Run Listeners
 220 //===----------------------------------------------------------------------===//
 221 /// Notify that we finished running a pass.
 222 void LLVMContext::notifyPassRun(Pass *P, Module *M, Function *F, BasicBlock *BB)
 223 {
 224   pImpl->notifyPassRun(this, P, M, F, BB);
 225 }
 226 /// Register the given PassRunListener to receive notifyPassRun() callbacks
 227 /// whenever a pass ran. The context will take ownership of the listener and
 228 /// free it when the context is destroyed.
 229 void LLVMContext::addRunListener(PassRunListener *L) {
 230   pImpl->addRunListener(L);
 231 }
 232 /// Unregister a PassRunListener so that it no longer receives notifyPassRun()
 233 /// callbacks. Remove and free the listener from the context.
 234 void LLVMContext::removeRunListener(PassRunListener *L) {
 235   pImpl->removeRunListener(L);
 236 }