blob: effff2ea5cfab44295be80440c5d7949629ed059 [file] [log] [blame]
//===- JITEventListener.h - Exposes events from JIT compilation -*- C++ -*-===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
// This file defines the JITEventListener interface, which lets users get
// callbacks when significant events happen during the JIT compilation process.
#include "llvm-c/ExecutionEngine.h"
#include "llvm/Config/llvm-config.h"
#include "llvm/ExecutionEngine/RuntimeDyld.h"
#include "llvm/IR/DebugLoc.h"
#include "llvm/Support/CBindingWrapping.h"
#include <cstdint>
namespace llvm {
class IntelJITEventsWrapper;
class OProfileWrapper;
namespace object {
class ObjectFile;
} // end namespace object
/// JITEventListener - Abstract interface for use by the JIT to notify clients
/// about significant events during compilation. For example, to notify
/// profilers and debuggers that need to know where functions have been emitted.
/// The default implementation of each method does nothing.
class JITEventListener {
using ObjectKey = uint64_t;
JITEventListener() = default;
virtual ~JITEventListener() = default;
/// notifyObjectLoaded - Called after an object has had its sections allocated
/// and addresses assigned to all symbols. Note: Section memory will not have
/// been relocated yet. notifyFunctionLoaded will not be called for
/// individual functions in the object.
/// ELF-specific information
/// The ObjectImage contains the generated object image
/// with section headers updated to reflect the address at which sections
/// were loaded and with relocations performed in-place on debug sections.
virtual void notifyObjectLoaded(ObjectKey K, const object::ObjectFile &Obj,
const RuntimeDyld::LoadedObjectInfo &L) {}
/// notifyFreeingObject - Called just before the memory associated with
/// a previously emitted object is released.
virtual void notifyFreeingObject(ObjectKey K) {}
// Get a pointe to the GDB debugger registration listener.
static JITEventListener *createGDBRegistrationListener();
// Construct an IntelJITEventListener
static JITEventListener *createIntelJITEventListener();
// Construct an IntelJITEventListener with a test Intel JIT API implementation
static JITEventListener *createIntelJITEventListener(
IntelJITEventsWrapper* AlternativeImpl);
static JITEventListener *createIntelJITEventListener() { return nullptr; }
static JITEventListener *createIntelJITEventListener(
IntelJITEventsWrapper* AlternativeImpl) {
return nullptr;
// Construct an OProfileJITEventListener
static JITEventListener *createOProfileJITEventListener();
// Construct an OProfileJITEventListener with a test opagent implementation
static JITEventListener *createOProfileJITEventListener(
OProfileWrapper* AlternativeImpl);
static JITEventListener *createOProfileJITEventListener() { return nullptr; }
static JITEventListener *createOProfileJITEventListener(
OProfileWrapper* AlternativeImpl) {
return nullptr;
#endif // USE_OPROFILE
static JITEventListener *createPerfJITEventListener();
static JITEventListener *createPerfJITEventListener()
return nullptr;
#endif // USE_PERF
virtual void anchor();
} // end namespace llvm