LLVM 20.0.0git
EPCDebugObjectRegistrar.h
Go to the documentation of this file.
1//===- EPCDebugObjectRegistrar.h - EPC-based debug registration -*- C++ -*-===//
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// ExecutorProcessControl based registration of debug objects.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_EXECUTIONENGINE_ORC_EPCDEBUGOBJECTREGISTRAR_H
14#define LLVM_EXECUTIONENGINE_ORC_EPCDEBUGOBJECTREGISTRAR_H
15
19#include "llvm/Support/Error.h"
20#include "llvm/Support/Memory.h"
21
22#include <cstdint>
23#include <memory>
24
25namespace llvm {
26namespace orc {
27
28class ExecutionSession;
29
30/// Abstract interface for registering debug objects in the executor process.
32public:
34 bool AutoRegisterCode) = 0;
35 virtual ~DebugObjectRegistrar() = default;
36};
37
38/// Use ExecutorProcessControl to register debug objects locally or in a remote
39/// executor process.
41public:
43 : ES(ES), RegisterFn(RegisterFn) {}
44
46 bool AutoRegisterCode) override;
47
48private:
50 ExecutorAddr RegisterFn;
51};
52
53/// Create a ExecutorProcessControl-based DebugObjectRegistrar that emits debug
54/// objects to the GDB JIT interface. This will use the EPC's lookupSymbols
55/// method to find the registration/deregistration function addresses by name.
56///
57/// If RegistrationFunctionsDylib is non-None then it will be searched to find
58/// the registration functions. If it is None then the process dylib will be
59/// loaded to find the registration functions.
61 ExecutionSession &ES,
62 std::optional<ExecutorAddr> RegistrationFunctionDylib = std::nullopt);
63
64} // end namespace orc
65} // end namespace llvm
66
67#endif // LLVM_EXECUTIONENGINE_ORC_EPCDEBUGOBJECTREGISTRAR_H
Lightweight error class with error context and mandatory checking.
Definition: Error.h:160
Tagged union holding either a T or a Error.
Definition: Error.h:481
Abstract interface for registering debug objects in the executor process.
virtual Error registerDebugObject(ExecutorAddrRange TargetMem, bool AutoRegisterCode)=0
virtual ~DebugObjectRegistrar()=default
Use ExecutorProcessControl to register debug objects locally or in a remote executor process.
EPCDebugObjectRegistrar(ExecutionSession &ES, ExecutorAddr RegisterFn)
Error registerDebugObject(ExecutorAddrRange TargetMem, bool AutoRegisterCode) override
An ExecutionSession represents a running JIT program.
Definition: Core.h:1431
Represents an address in the executor process.
Expected< std::unique_ptr< EPCDebugObjectRegistrar > > createJITLoaderGDBRegistrar(ExecutionSession &ES, std::optional< ExecutorAddr > RegistrationFunctionDylib=std::nullopt)
Create a ExecutorProcessControl-based DebugObjectRegistrar that emits debug objects to the GDB JIT in...
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
Represents an address range in the exceutor process.