lib/ExecutionEngine/JIT/OProfileJITEventListener.cpp

   1 //===-- OProfileJITEventListener.cpp - Tell OProfile about JITted code ----===//
   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 defines a JITEventListener object that calls into OProfile to tell
  11 // it about JITted functions.  For now, we only record function names and sizes,
  12 // but eventually we'll also record line number information.
  13 //
  14 // See http://oprofile.sourceforge.net/doc/devel/jit-interface.html for the
  15 // definition of the interface we're using.
  16 //
  17 //===----------------------------------------------------------------------===//
  18
  19 #define DEBUG_TYPE "oprofile-jit-event-listener"
  20 #include "llvm/Function.h"
  21 #include "llvm/Analysis/DebugInfo.h"
  22 #include "llvm/CodeGen/MachineFunction.h"
  23 #include "llvm/ExecutionEngine/JITEventListener.h"
  24 #include "llvm/Support/Debug.h"
  25 #include "llvm/Support/raw_ostream.h"
  26 #include "llvm/System/Errno.h"
  27 #include "llvm/Config/config.h"
  28 #include <stddef.h>
  29 using namespace llvm;
  30
  31 #if USE_OPROFILE
  32
  33 #include <opagent.h>
  34
  35 namespace {
  36
  37 class OProfileJITEventListener : public JITEventListener {
  38   op_agent_t Agent;
  39 public:
  40   OProfileJITEventListener();
  41   ~OProfileJITEventListener();
  42
  43   virtual void NotifyFunctionEmitted(const Function &F,
  44                                      void *FnStart, size_t FnSize,
  45                                      const EmittedFunctionDetails &Details);
  46   virtual void NotifyFreeingMachineCode(void *OldPtr);
  47 };
  48
  49 OProfileJITEventListener::OProfileJITEventListener()
  50     : Agent(op_open_agent()) {
  51   if (Agent == NULL) {
  52     const std::string err_str = sys::StrError();
  53     DEBUG(errs() << "Failed to connect to OProfile agent: " << err_str << "\n");
  54   } else {
  55     DEBUG(errs() << "Connected to OProfile agent.\n");
  56   }
  57 }
  58
  59 OProfileJITEventListener::~OProfileJITEventListener() {
  60   if (Agent != NULL) {
  61     if (op_close_agent(Agent) == -1) {
  62       const std::string err_str = sys::StrError();
  63       DEBUG(errs() << "Failed to disconnect from OProfile agent: "
  64                    << err_str << "\n");
  65     } else {
  66       DEBUG(errs() << "Disconnected from OProfile agent.\n");
  67     }
  68   }
  69 }
  70
  71 class FilenameCache {
  72   // Holds the filename of each Scope, so that we can pass a null-terminated
  73   // string into oprofile.
  74   DenseMap<MDNode*, std::string> Filenames;
  75
  76  public:
  77   const char *getFilename(MDNode *Scope) {
  78     std::string &Filename = Filenames[Scope];
  79     if (Filename == NULL) {
  80       DIScope S(Scope);
  81       Filename = S.getFilename();
  82     }
  83     return Filename.c_str();
  84   }
  85 };
  86
  87 static debug_line_info LineStartToOProfileFormat(
  88     const MachineFunction &MF, FilenameCache &Filenames,
  89     uintptr_t Address, DebugLoc Loc) {
  90   debug_line_info Result;
  91   Result.vma = Address;
  92   const DebugLocTuple &tuple = MF.getDebugLocTuple(Loc);
  93   Result.lineno = tuple.Line;
  94   Result.filename = Filenames.getFilename(tuple.Scope);
  95   DEBUG(errs() << "Mapping " << reinterpret_cast<void*>(Result.vma) << " to "
  96                << Result.filename << ":" << Result.lineno << "\n");
  97   return Result;
  98 }
  99
 100 // Adds the just-emitted function to the symbol table.
 101 void OProfileJITEventListener::NotifyFunctionEmitted(
 102     const Function &F, void *FnStart, size_t FnSize,
 103     const EmittedFunctionDetails &Details) {
 104   assert(F.hasName() && FnStart != 0 && "Bad symbol to add");
 105   if (op_write_native_code(Agent, F.getName().data(),
 106                            reinterpret_cast<uint64_t>(FnStart),
 107                            FnStart, FnSize) == -1) {
 108     DEBUG(errs() << "Failed to tell OProfile about native function "
 109           << F.getName() << " at ["
 110           << FnStart << "-" << ((char*)FnStart + FnSize) << "]\n");
 111     return;
 112   }
 113
 114   // Now we convert the line number information from the address/DebugLoc format
 115   // in Details to the address/filename/lineno format that OProfile expects.
 116   // OProfile 0.9.4 (and maybe later versions) has a bug that causes it to
 117   // ignore line numbers for addresses above 4G.
 118   FilenameCache Filenames;
 119   std::vector<debug_line_info> LineInfo;
 120   LineInfo.reserve(1 + Details.LineStarts.size());
 121   if (!Details.MF->getDefaultDebugLoc().isUnknown()) {
 122     LineInfo.push_back(LineStartToOProfileFormat(
 123         *Details.MF, Filenames,
 124         reinterpret_cast<uintptr_t>(FnStart),
 125         Details.MF->getDefaultDebugLoc()));
 126   }
 127   for (std::vector<EmittedFunctionDetails::LineStart>::const_iterator
 128            I = Details.LineStarts.begin(), E = Details.LineStarts.end();
 129        I != E; ++I) {
 130     LineInfo.push_back(LineStartToOProfileFormat(
 131         *Details.MF, Filenames, I->Address, I->Loc));
 132   }
 133   if (!LineInfo.empty()) {
 134     if (op_write_debug_line_info(Agent, FnStart,
 135                                  LineInfo.size(), &*LineInfo.begin()) == -1) {
 136       DEBUG(errs()
 137             << "Failed to tell OProfile about line numbers for native function "
 138             << F.getName() << " at ["
 139             << FnStart << "-" << ((char*)FnStart + FnSize) << "]\n");
 140     }
 141   }
 142 }
 143
 144 // Removes the being-deleted function from the symbol table.
 145 void OProfileJITEventListener::NotifyFreeingMachineCode(void *FnStart) {
 146   assert(FnStart && "Invalid function pointer");
 147   if (op_unload_native_code(Agent, reinterpret_cast<uint64_t>(FnStart)) == -1) {
 148     DEBUG(errs()
 149           << "Failed to tell OProfile about unload of native function at "
 150           << FnStart << "\n");
 151   }
 152 }
 153
 154 }  // anonymous namespace.
 155
 156 namespace llvm {
 157 JITEventListener *createOProfileJITEventListener() {
 158   return new OProfileJITEventListener;
 159 }
 160 }
 161
 162 #else  // USE_OPROFILE
 163
 164 namespace llvm {
 165 // By defining this to return NULL, we can let clients call it unconditionally,
 166 // even if they haven't configured with the OProfile libraries.
 167 JITEventListener *createOProfileJITEventListener() {
 168   return NULL;
 169 }
 170 }  // namespace llvm
 171
 172 #endif  // USE_OPROFILE