LLVM 17.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#include <vector>
25
26namespace llvm {
27namespace orc {
28
29class ExecutionSession;
30
31/// Abstract interface for registering debug objects in the executor process.
33public:
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
47private:
49 ExecutorAddr RegisterFn;
50};
51
52/// Create a ExecutorProcessControl-based DebugObjectRegistrar that emits debug
53/// objects to the GDB JIT interface. This will use the EPC's lookupSymbols
54/// method to find the registration/deregistration funciton addresses by name.
55///
56/// If RegistrationFunctionsDylib is non-None then it will be searched to find
57/// the registration functions. If it is None then the process dylib will be
58/// loaded to find the registration functions.
60 ExecutionSession &ES,
61 std::optional<ExecutorAddr> RegistrationFunctionDylib = std::nullopt);
62
63} // end namespace orc
64} // end namespace llvm
65
66#endif // LLVM_EXECUTIONENGINE_ORC_EPCDEBUGOBJECTREGISTRAR_H
Lightweight error class with error context and mandatory checking.
Definition: Error.h:156
Tagged union holding either a T or a Error.
Definition: Error.h:470
Abstract interface for registering debug objects in the executor process.
virtual Error registerDebugObject(ExecutorAddrRange TargetMem)=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) override
An ExecutionSession represents a running JIT program.
Definition: Core.h:1373
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.