diff options
author | shadchin <shadchin@yandex-team.ru> | 2022-02-10 16:44:39 +0300 |
---|---|---|
committer | Daniil Cherednik <dcherednik@yandex-team.ru> | 2022-02-10 16:44:39 +0300 |
commit | e9656aae26e0358d5378e5b63dcac5c8dbe0e4d0 (patch) | |
tree | 64175d5cadab313b3e7039ebaa06c5bc3295e274 /contrib/libs/llvm12/include/llvm/ExecutionEngine/Orc/TargetProcessControl.h | |
parent | 2598ef1d0aee359b4b6d5fdd1758916d5907d04f (diff) | |
download | ydb-e9656aae26e0358d5378e5b63dcac5c8dbe0e4d0.tar.gz |
Restoring authorship annotation for <shadchin@yandex-team.ru>. Commit 2 of 2.
Diffstat (limited to 'contrib/libs/llvm12/include/llvm/ExecutionEngine/Orc/TargetProcessControl.h')
-rw-r--r-- | contrib/libs/llvm12/include/llvm/ExecutionEngine/Orc/TargetProcessControl.h | 458 |
1 files changed, 229 insertions, 229 deletions
diff --git a/contrib/libs/llvm12/include/llvm/ExecutionEngine/Orc/TargetProcessControl.h b/contrib/libs/llvm12/include/llvm/ExecutionEngine/Orc/TargetProcessControl.h index 2c2e62ae64..952bcc2a33 100644 --- a/contrib/libs/llvm12/include/llvm/ExecutionEngine/Orc/TargetProcessControl.h +++ b/contrib/libs/llvm12/include/llvm/ExecutionEngine/Orc/TargetProcessControl.h @@ -1,229 +1,229 @@ -#pragma once - -#ifdef __GNUC__ -#pragma GCC diagnostic push -#pragma GCC diagnostic ignored "-Wunused-parameter" -#endif - -//===--- TargetProcessControl.h - Target process control APIs ---*- 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 -// -//===----------------------------------------------------------------------===// -// -// Utilities for interacting with target processes. -// -//===----------------------------------------------------------------------===// - -#ifndef LLVM_EXECUTIONENGINE_ORC_TARGETPROCESSCONTROL_H -#define LLVM_EXECUTIONENGINE_ORC_TARGETPROCESSCONTROL_H - -#include "llvm/ADT/Optional.h" -#include "llvm/ADT/StringRef.h" -#include "llvm/ADT/Triple.h" -#include "llvm/ExecutionEngine/JITLink/JITLinkMemoryManager.h" -#include "llvm/ExecutionEngine/Orc/Core.h" -#include "llvm/ExecutionEngine/Orc/Shared/TargetProcessControlTypes.h" -#include "llvm/Support/DynamicLibrary.h" -#include "llvm/Support/MSVCErrorWorkarounds.h" - -#include <future> -#include <vector> - -namespace llvm { -namespace orc { - -/// TargetProcessControl supports interaction with a JIT target process. -class TargetProcessControl { -public: - /// APIs for manipulating memory in the target process. - class MemoryAccess { - public: - /// Callback function for asynchronous writes. - using WriteResultFn = unique_function<void(Error)>; - - virtual ~MemoryAccess(); - - virtual void writeUInt8s(ArrayRef<tpctypes::UInt8Write> Ws, - WriteResultFn OnWriteComplete) = 0; - - virtual void writeUInt16s(ArrayRef<tpctypes::UInt16Write> Ws, - WriteResultFn OnWriteComplete) = 0; - - virtual void writeUInt32s(ArrayRef<tpctypes::UInt32Write> Ws, - WriteResultFn OnWriteComplete) = 0; - - virtual void writeUInt64s(ArrayRef<tpctypes::UInt64Write> Ws, - WriteResultFn OnWriteComplete) = 0; - - virtual void writeBuffers(ArrayRef<tpctypes::BufferWrite> Ws, - WriteResultFn OnWriteComplete) = 0; - - Error writeUInt8s(ArrayRef<tpctypes::UInt8Write> Ws) { - std::promise<MSVCPError> ResultP; - auto ResultF = ResultP.get_future(); - writeUInt8s(Ws, [&](Error Err) { ResultP.set_value(std::move(Err)); }); - return ResultF.get(); - } - - Error writeUInt16s(ArrayRef<tpctypes::UInt16Write> Ws) { - std::promise<MSVCPError> ResultP; - auto ResultF = ResultP.get_future(); - writeUInt16s(Ws, [&](Error Err) { ResultP.set_value(std::move(Err)); }); - return ResultF.get(); - } - - Error writeUInt32s(ArrayRef<tpctypes::UInt32Write> Ws) { - std::promise<MSVCPError> ResultP; - auto ResultF = ResultP.get_future(); - writeUInt32s(Ws, [&](Error Err) { ResultP.set_value(std::move(Err)); }); - return ResultF.get(); - } - - Error writeUInt64s(ArrayRef<tpctypes::UInt64Write> Ws) { - std::promise<MSVCPError> ResultP; - auto ResultF = ResultP.get_future(); - writeUInt64s(Ws, [&](Error Err) { ResultP.set_value(std::move(Err)); }); - return ResultF.get(); - } - - Error writeBuffers(ArrayRef<tpctypes::BufferWrite> Ws) { - std::promise<MSVCPError> ResultP; - auto ResultF = ResultP.get_future(); - writeBuffers(Ws, [&](Error Err) { ResultP.set_value(std::move(Err)); }); - return ResultF.get(); - } - }; - - /// A pair of a dylib and a set of symbols to be looked up. - struct LookupRequest { - LookupRequest(tpctypes::DylibHandle Handle, const SymbolLookupSet &Symbols) - : Handle(Handle), Symbols(Symbols) {} - tpctypes::DylibHandle Handle; - const SymbolLookupSet &Symbols; - }; - - virtual ~TargetProcessControl(); - - /// Intern a symbol name in the SymbolStringPool. - SymbolStringPtr intern(StringRef SymName) { return SSP->intern(SymName); } - - /// Return a shared pointer to the SymbolStringPool for this instance. - std::shared_ptr<SymbolStringPool> getSymbolStringPool() const { return SSP; } - - /// Return the Triple for the target process. - const Triple &getTargetTriple() const { return TargetTriple; } - - /// Get the page size for the target process. - unsigned getPageSize() const { return PageSize; } - - /// Return a MemoryAccess object for the target process. - MemoryAccess &getMemoryAccess() const { return *MemAccess; } - - /// Return a JITLinkMemoryManager for the target process. - jitlink::JITLinkMemoryManager &getMemMgr() const { return *MemMgr; } - - /// Load the dynamic library at the given path and return a handle to it. - /// If LibraryPath is null this function will return the global handle for - /// the target process. - virtual Expected<tpctypes::DylibHandle> loadDylib(const char *DylibPath) = 0; - - /// Search for symbols in the target process. - /// - /// The result of the lookup is a 2-dimentional array of target addresses - /// that correspond to the lookup order. If a required symbol is not - /// found then this method will return an error. If a weakly referenced - /// symbol is not found then it be assigned a '0' value in the result. - /// that correspond to the lookup order. - virtual Expected<std::vector<tpctypes::LookupResult>> - lookupSymbols(ArrayRef<LookupRequest> Request) = 0; - - /// Run function with a main-like signature. - virtual Expected<int32_t> runAsMain(JITTargetAddress MainFnAddr, - ArrayRef<std::string> Args) = 0; - - /// Run a wrapper function with signature: - /// - /// \code{.cpp} - /// CWrapperFunctionResult fn(uint8_t *Data, uint64_t Size); - /// \endcode{.cpp} - /// - virtual Expected<tpctypes::WrapperFunctionResult> - runWrapper(JITTargetAddress WrapperFnAddr, ArrayRef<uint8_t> ArgBuffer) = 0; - - /// Disconnect from the target process. - /// - /// This should be called after the JIT session is shut down. - virtual Error disconnect() = 0; - -protected: - TargetProcessControl(std::shared_ptr<SymbolStringPool> SSP) - : SSP(std::move(SSP)) {} - - std::shared_ptr<SymbolStringPool> SSP; - Triple TargetTriple; - unsigned PageSize = 0; - MemoryAccess *MemAccess = nullptr; - jitlink::JITLinkMemoryManager *MemMgr = nullptr; -}; - -/// A TargetProcessControl implementation targeting the current process. -class SelfTargetProcessControl : public TargetProcessControl, - private TargetProcessControl::MemoryAccess { -public: - SelfTargetProcessControl( - std::shared_ptr<SymbolStringPool> SSP, Triple TargetTriple, - unsigned PageSize, std::unique_ptr<jitlink::JITLinkMemoryManager> MemMgr); - - /// Create a SelfTargetProcessControl with the given memory manager. - /// If no memory manager is given a jitlink::InProcessMemoryManager will - /// be used by default. - static Expected<std::unique_ptr<SelfTargetProcessControl>> - Create(std::shared_ptr<SymbolStringPool> SSP, - std::unique_ptr<jitlink::JITLinkMemoryManager> MemMgr = nullptr); - - Expected<tpctypes::DylibHandle> loadDylib(const char *DylibPath) override; - - Expected<std::vector<tpctypes::LookupResult>> - lookupSymbols(ArrayRef<LookupRequest> Request) override; - - Expected<int32_t> runAsMain(JITTargetAddress MainFnAddr, - ArrayRef<std::string> Args) override; - - Expected<tpctypes::WrapperFunctionResult> - runWrapper(JITTargetAddress WrapperFnAddr, - ArrayRef<uint8_t> ArgBuffer) override; - - Error disconnect() override; - -private: - void writeUInt8s(ArrayRef<tpctypes::UInt8Write> Ws, - WriteResultFn OnWriteComplete) override; - - void writeUInt16s(ArrayRef<tpctypes::UInt16Write> Ws, - WriteResultFn OnWriteComplete) override; - - void writeUInt32s(ArrayRef<tpctypes::UInt32Write> Ws, - WriteResultFn OnWriteComplete) override; - - void writeUInt64s(ArrayRef<tpctypes::UInt64Write> Ws, - WriteResultFn OnWriteComplete) override; - - void writeBuffers(ArrayRef<tpctypes::BufferWrite> Ws, - WriteResultFn OnWriteComplete) override; - - std::unique_ptr<jitlink::JITLinkMemoryManager> OwnedMemMgr; - char GlobalManglingPrefix = 0; - std::vector<std::unique_ptr<sys::DynamicLibrary>> DynamicLibraries; -}; - -} // end namespace orc -} // end namespace llvm - -#endif // LLVM_EXECUTIONENGINE_ORC_TARGETPROCESSCONTROL_H - -#ifdef __GNUC__ -#pragma GCC diagnostic pop -#endif +#pragma once + +#ifdef __GNUC__ +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wunused-parameter" +#endif + +//===--- TargetProcessControl.h - Target process control APIs ---*- 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 +// +//===----------------------------------------------------------------------===// +// +// Utilities for interacting with target processes. +// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_EXECUTIONENGINE_ORC_TARGETPROCESSCONTROL_H +#define LLVM_EXECUTIONENGINE_ORC_TARGETPROCESSCONTROL_H + +#include "llvm/ADT/Optional.h" +#include "llvm/ADT/StringRef.h" +#include "llvm/ADT/Triple.h" +#include "llvm/ExecutionEngine/JITLink/JITLinkMemoryManager.h" +#include "llvm/ExecutionEngine/Orc/Core.h" +#include "llvm/ExecutionEngine/Orc/Shared/TargetProcessControlTypes.h" +#include "llvm/Support/DynamicLibrary.h" +#include "llvm/Support/MSVCErrorWorkarounds.h" + +#include <future> +#include <vector> + +namespace llvm { +namespace orc { + +/// TargetProcessControl supports interaction with a JIT target process. +class TargetProcessControl { +public: + /// APIs for manipulating memory in the target process. + class MemoryAccess { + public: + /// Callback function for asynchronous writes. + using WriteResultFn = unique_function<void(Error)>; + + virtual ~MemoryAccess(); + + virtual void writeUInt8s(ArrayRef<tpctypes::UInt8Write> Ws, + WriteResultFn OnWriteComplete) = 0; + + virtual void writeUInt16s(ArrayRef<tpctypes::UInt16Write> Ws, + WriteResultFn OnWriteComplete) = 0; + + virtual void writeUInt32s(ArrayRef<tpctypes::UInt32Write> Ws, + WriteResultFn OnWriteComplete) = 0; + + virtual void writeUInt64s(ArrayRef<tpctypes::UInt64Write> Ws, + WriteResultFn OnWriteComplete) = 0; + + virtual void writeBuffers(ArrayRef<tpctypes::BufferWrite> Ws, + WriteResultFn OnWriteComplete) = 0; + + Error writeUInt8s(ArrayRef<tpctypes::UInt8Write> Ws) { + std::promise<MSVCPError> ResultP; + auto ResultF = ResultP.get_future(); + writeUInt8s(Ws, [&](Error Err) { ResultP.set_value(std::move(Err)); }); + return ResultF.get(); + } + + Error writeUInt16s(ArrayRef<tpctypes::UInt16Write> Ws) { + std::promise<MSVCPError> ResultP; + auto ResultF = ResultP.get_future(); + writeUInt16s(Ws, [&](Error Err) { ResultP.set_value(std::move(Err)); }); + return ResultF.get(); + } + + Error writeUInt32s(ArrayRef<tpctypes::UInt32Write> Ws) { + std::promise<MSVCPError> ResultP; + auto ResultF = ResultP.get_future(); + writeUInt32s(Ws, [&](Error Err) { ResultP.set_value(std::move(Err)); }); + return ResultF.get(); + } + + Error writeUInt64s(ArrayRef<tpctypes::UInt64Write> Ws) { + std::promise<MSVCPError> ResultP; + auto ResultF = ResultP.get_future(); + writeUInt64s(Ws, [&](Error Err) { ResultP.set_value(std::move(Err)); }); + return ResultF.get(); + } + + Error writeBuffers(ArrayRef<tpctypes::BufferWrite> Ws) { + std::promise<MSVCPError> ResultP; + auto ResultF = ResultP.get_future(); + writeBuffers(Ws, [&](Error Err) { ResultP.set_value(std::move(Err)); }); + return ResultF.get(); + } + }; + + /// A pair of a dylib and a set of symbols to be looked up. + struct LookupRequest { + LookupRequest(tpctypes::DylibHandle Handle, const SymbolLookupSet &Symbols) + : Handle(Handle), Symbols(Symbols) {} + tpctypes::DylibHandle Handle; + const SymbolLookupSet &Symbols; + }; + + virtual ~TargetProcessControl(); + + /// Intern a symbol name in the SymbolStringPool. + SymbolStringPtr intern(StringRef SymName) { return SSP->intern(SymName); } + + /// Return a shared pointer to the SymbolStringPool for this instance. + std::shared_ptr<SymbolStringPool> getSymbolStringPool() const { return SSP; } + + /// Return the Triple for the target process. + const Triple &getTargetTriple() const { return TargetTriple; } + + /// Get the page size for the target process. + unsigned getPageSize() const { return PageSize; } + + /// Return a MemoryAccess object for the target process. + MemoryAccess &getMemoryAccess() const { return *MemAccess; } + + /// Return a JITLinkMemoryManager for the target process. + jitlink::JITLinkMemoryManager &getMemMgr() const { return *MemMgr; } + + /// Load the dynamic library at the given path and return a handle to it. + /// If LibraryPath is null this function will return the global handle for + /// the target process. + virtual Expected<tpctypes::DylibHandle> loadDylib(const char *DylibPath) = 0; + + /// Search for symbols in the target process. + /// + /// The result of the lookup is a 2-dimentional array of target addresses + /// that correspond to the lookup order. If a required symbol is not + /// found then this method will return an error. If a weakly referenced + /// symbol is not found then it be assigned a '0' value in the result. + /// that correspond to the lookup order. + virtual Expected<std::vector<tpctypes::LookupResult>> + lookupSymbols(ArrayRef<LookupRequest> Request) = 0; + + /// Run function with a main-like signature. + virtual Expected<int32_t> runAsMain(JITTargetAddress MainFnAddr, + ArrayRef<std::string> Args) = 0; + + /// Run a wrapper function with signature: + /// + /// \code{.cpp} + /// CWrapperFunctionResult fn(uint8_t *Data, uint64_t Size); + /// \endcode{.cpp} + /// + virtual Expected<tpctypes::WrapperFunctionResult> + runWrapper(JITTargetAddress WrapperFnAddr, ArrayRef<uint8_t> ArgBuffer) = 0; + + /// Disconnect from the target process. + /// + /// This should be called after the JIT session is shut down. + virtual Error disconnect() = 0; + +protected: + TargetProcessControl(std::shared_ptr<SymbolStringPool> SSP) + : SSP(std::move(SSP)) {} + + std::shared_ptr<SymbolStringPool> SSP; + Triple TargetTriple; + unsigned PageSize = 0; + MemoryAccess *MemAccess = nullptr; + jitlink::JITLinkMemoryManager *MemMgr = nullptr; +}; + +/// A TargetProcessControl implementation targeting the current process. +class SelfTargetProcessControl : public TargetProcessControl, + private TargetProcessControl::MemoryAccess { +public: + SelfTargetProcessControl( + std::shared_ptr<SymbolStringPool> SSP, Triple TargetTriple, + unsigned PageSize, std::unique_ptr<jitlink::JITLinkMemoryManager> MemMgr); + + /// Create a SelfTargetProcessControl with the given memory manager. + /// If no memory manager is given a jitlink::InProcessMemoryManager will + /// be used by default. + static Expected<std::unique_ptr<SelfTargetProcessControl>> + Create(std::shared_ptr<SymbolStringPool> SSP, + std::unique_ptr<jitlink::JITLinkMemoryManager> MemMgr = nullptr); + + Expected<tpctypes::DylibHandle> loadDylib(const char *DylibPath) override; + + Expected<std::vector<tpctypes::LookupResult>> + lookupSymbols(ArrayRef<LookupRequest> Request) override; + + Expected<int32_t> runAsMain(JITTargetAddress MainFnAddr, + ArrayRef<std::string> Args) override; + + Expected<tpctypes::WrapperFunctionResult> + runWrapper(JITTargetAddress WrapperFnAddr, + ArrayRef<uint8_t> ArgBuffer) override; + + Error disconnect() override; + +private: + void writeUInt8s(ArrayRef<tpctypes::UInt8Write> Ws, + WriteResultFn OnWriteComplete) override; + + void writeUInt16s(ArrayRef<tpctypes::UInt16Write> Ws, + WriteResultFn OnWriteComplete) override; + + void writeUInt32s(ArrayRef<tpctypes::UInt32Write> Ws, + WriteResultFn OnWriteComplete) override; + + void writeUInt64s(ArrayRef<tpctypes::UInt64Write> Ws, + WriteResultFn OnWriteComplete) override; + + void writeBuffers(ArrayRef<tpctypes::BufferWrite> Ws, + WriteResultFn OnWriteComplete) override; + + std::unique_ptr<jitlink::JITLinkMemoryManager> OwnedMemMgr; + char GlobalManglingPrefix = 0; + std::vector<std::unique_ptr<sys::DynamicLibrary>> DynamicLibraries; +}; + +} // end namespace orc +} // end namespace llvm + +#endif // LLVM_EXECUTIONENGINE_ORC_TARGETPROCESSCONTROL_H + +#ifdef __GNUC__ +#pragma GCC diagnostic pop +#endif |