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 16 #include "llvm/ExecutionEngine/JITSymbol.h" 17 #include "llvm/ExecutionEngine/Orc/Shared/ExecutorAddress.h" 18 #include "llvm/ExecutionEngine/Orc/Shared/WrapperFunctionUtils.h" 19 #include "llvm/Support/Error.h" 20 #include "llvm/Support/Memory.h" 21 22 #include <cstdint> 23 #include <memory> 24 #include <vector> 25 26 namespace llvm { 27 namespace orc { 28 29 class ExecutionSession; 30 31 /// Abstract interface for registering debug objects in the executor process. 32 class DebugObjectRegistrar { 33 public: 34 virtual Error registerDebugObject(ExecutorAddrRange TargetMem, 35 bool AutoRegisterCode) = 0; 36 virtual ~DebugObjectRegistrar() = default; 37 }; 38 39 /// Use ExecutorProcessControl to register debug objects locally or in a remote 40 /// executor process. 41 class EPCDebugObjectRegistrar : public DebugObjectRegistrar { 42 public: 43 EPCDebugObjectRegistrar(ExecutionSession &ES, ExecutorAddr RegisterFn) 44 : ES(ES), RegisterFn(RegisterFn) {} 45 46 Error registerDebugObject(ExecutorAddrRange TargetMem, 47 bool AutoRegisterCode) override; 48 49 private: 50 ExecutionSession &ES; 51 ExecutorAddr RegisterFn; 52 }; 53 54 /// Create a ExecutorProcessControl-based DebugObjectRegistrar that emits debug 55 /// objects to the GDB JIT interface. This will use the EPC's lookupSymbols 56 /// method to find the registration/deregistration function addresses by name. 57 /// 58 /// If RegistrationFunctionsDylib is non-None then it will be searched to find 59 /// the registration functions. If it is None then the process dylib will be 60 /// loaded to find the registration functions. 61 Expected<std::unique_ptr<EPCDebugObjectRegistrar>> createJITLoaderGDBRegistrar( 62 ExecutionSession &ES, 63 std::optional<ExecutorAddr> RegistrationFunctionDylib = std::nullopt); 64 65 } // end namespace orc 66 } // end namespace llvm 67 68 #endif // LLVM_EXECUTIONENGINE_ORC_EPCDEBUGOBJECTREGISTRAR_H 69