mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2026-08-25 14:10:28 -04:00
Stefan Gränitz
44d6e1a3fb
Add a new ObjectLinkingLayer plugin `DebugObjectManagerPlugin` and infrastructure to handle creation of `DebugObject`s as well as their registration in OrcTargetProcess. The current implementation only covers ELF on x86-64, but the infrastructure is not limited to that. The journey starts with a new `LinkGraph` / `JITLinkContext` pair being created for a `MaterializationResponsibility` in ORC's `ObjectLinkingLayer`. It sends a `notifyMaterializing()` notification, which is forwarded to all registered plugins. The `DebugObjectManagerPlugin` aims to create a `DebugObject` form the provided target triple and object buffer. (Future implementations might create `DebugObject`s from a `LinkGraph` in other ways.) On success it will track it as the pending `DebugObject` for the `MaterializationResponsibility`. This patch only implements the `ELFDebugObject` for `x86-64` targets. It follows the RuntimeDyld approach for debug object setup: it captures a copy of the input object, parses all section headers and prepares to patch their load-address fields with their final addresses in target memory. It instructs the plugin to report the section load-addresses once they are available. The plugin overrides `modifyPassConfig()` and installs a JITLink post-allocation pass to capture them. Once JITLink emitted the finalized executable, the plugin emits and registers the `DebugObject`. For emission it requests a new `JITLinkMemoryManager::Allocation` with a single read-only segment, copies the object with patched section load-addresses over to working memory and triggers finalization to target memory. For registration, it notifies the `DebugObjectRegistrar` provided in the constructor and stores the previously pending`DebugObject` as registered for the corresponding MaterializationResponsibility. The `DebugObjectRegistrar` registers the `DebugObject` with the target process. `llvm-jitlink` uses the `TPCDebugObjectRegistrar`, which calls `llvm_orc_registerJITLoaderGDBWrapper()` in the target process via `TargetProcessControl` to emit a `jit_code_entry` compatible with the GDB JIT interface [1]. So far the implementation only supports registration and no removal. It appears to me that it wouldn't raise any new design questions, so I left this as an addition for the near future. [1] https://sourceware.org/gdb/current/onlinedocs/gdb/JIT-Interface.html Reviewed By: lhames Differential Revision: https://reviews.llvm.org/D97335
68 lines
2.2 KiB
C++
68 lines
2.2 KiB
C++
//===- TPCDebugObjectRegistrar.h - TPC-based debug registration -*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// TargetProcessControl based registration of debug objects.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_EXECUTIONENGINE_ORC_TPCDEBUGOBJECTREGISTRAR_H
|
|
#define LLVM_EXECUTIONENGINE_ORC_TPCDEBUGOBJECTREGISTRAR_H
|
|
|
|
#include "llvm/ExecutionEngine/JITSymbol.h"
|
|
#include "llvm/ExecutionEngine/Orc/TargetProcessControl.h"
|
|
#include "llvm/Support/Error.h"
|
|
#include "llvm/Support/Memory.h"
|
|
|
|
#include <cstdint>
|
|
#include <memory>
|
|
#include <vector>
|
|
|
|
namespace llvm {
|
|
namespace orc {
|
|
|
|
/// Abstract interface for registering debug objects in the target process.
|
|
class DebugObjectRegistrar {
|
|
public:
|
|
virtual Error registerDebugObject(sys::MemoryBlock) = 0;
|
|
virtual ~DebugObjectRegistrar() {}
|
|
};
|
|
|
|
/// Use TargetProcessControl to register debug objects locally or in a remote
|
|
/// target process.
|
|
class TPCDebugObjectRegistrar : public DebugObjectRegistrar {
|
|
public:
|
|
using SerializeBlockInfoFn =
|
|
std::vector<uint8_t> (*)(sys::MemoryBlock TargetMemBlock);
|
|
|
|
TPCDebugObjectRegistrar(TargetProcessControl &TPC,
|
|
JITTargetAddress RegisterFn,
|
|
SerializeBlockInfoFn SerializeBlockInfo)
|
|
: TPC(TPC), RegisterFn(RegisterFn),
|
|
SerializeBlockInfo(SerializeBlockInfo) {}
|
|
|
|
Error registerDebugObject(sys::MemoryBlock TargetMem) override {
|
|
return TPC.runWrapper(RegisterFn, SerializeBlockInfo(TargetMem))
|
|
.takeError();
|
|
}
|
|
|
|
private:
|
|
TargetProcessControl &TPC;
|
|
JITTargetAddress RegisterFn;
|
|
SerializeBlockInfoFn SerializeBlockInfo;
|
|
};
|
|
|
|
/// Create a TargetProcessControl-based DebugObjectRegistrar that emits debug
|
|
/// objects to the GDB JIT interface.
|
|
Expected<std::unique_ptr<TPCDebugObjectRegistrar>>
|
|
createJITLoaderGDBRegistrar(TargetProcessControl &TPC);
|
|
|
|
} // end namespace orc
|
|
} // end namespace llvm
|
|
|
|
#endif // LLVM_EXECUTIONENGINE_ORC_TDEBUGOBJECTREGISTRAR_H
|