1 //===----- RemoteTargetExternal.h - LLVM out-of-process JIT execution -----===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Definition of the RemoteTargetExternal class which executes JITed code in a
11 // separate process from where it was built.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLI_REMOTETARGETEXTERNAL_H
16 #define LLI_REMOTETARGETEXTERNAL_H
18 #include "llvm/Config/config.h"
20 #include "llvm/ADT/SmallVector.h"
21 #include "llvm/ADT/StringRef.h"
22 #include "llvm/Support/DataTypes.h"
23 #include "llvm/Support/Memory.h"
27 #include "RemoteTarget.h"
28 #include "RemoteTargetMessage.h"
32 class RemoteTargetExternal : public RemoteTarget {
34 /// Allocate space in the remote target address space.
36 /// @param Size Amount of space, in bytes, to allocate.
37 /// @param Alignment Required minimum alignment for allocated space.
38 /// @param[out] Address Remote address of the allocated memory.
40 /// @returns False on success. On failure, ErrorMsg is updated with
41 /// descriptive text of the encountered error.
42 virtual bool allocateSpace(size_t Size,
46 /// Load data into the target address space.
48 /// @param Address Destination address in the target process.
49 /// @param Data Source address in the host process.
50 /// @param Size Number of bytes to copy.
52 /// @returns False on success. On failure, ErrorMsg is updated with
53 /// descriptive text of the encountered error.
54 virtual bool loadData(uint64_t Address, const void *Data, size_t Size);
56 /// Load code into the target address space and prepare it for execution.
58 /// @param Address Destination address in the target process.
59 /// @param Data Source address in the host process.
60 /// @param Size Number of bytes to copy.
62 /// @returns False on success. On failure, ErrorMsg is updated with
63 /// descriptive text of the encountered error.
64 virtual bool loadCode(uint64_t Address, const void *Data, size_t Size);
66 /// Execute code in the target process. The called function is required
67 /// to be of signature int "(*)(void)".
69 /// @param Address Address of the loaded function in the target
71 /// @param[out] RetVal The integer return value of the called function.
73 /// @returns False on success. On failure, ErrorMsg is updated with
74 /// descriptive text of the encountered error.
75 virtual bool executeCode(uint64_t Address, int &RetVal);
77 /// Minimum alignment for memory permissions. Used to seperate code and
78 /// data regions to make sure data doesn't get marked as code or vice
81 /// @returns Page alignment return value. Default of 4k.
82 virtual unsigned getPageAlignment() { return 4096; }
84 /// Start the remote process.
85 virtual void create();
87 /// Terminate the remote process.
90 RemoteTargetExternal(std::string &Name) : RemoteTarget(), ChildName(Name) {}
91 virtual ~RemoteTargetExternal();
94 std::string ChildName;
96 // This will get filled in as a point to an OS-specific structure.
99 void SendAllocateSpace(uint32_t Alignment, uint32_t Size);
100 void SendLoadSection(uint64_t Addr,
104 void SendExecute(uint64_t Addr);
105 void SendTerminate();
107 void Receive(LLIMessageType Msg);
108 void Receive(LLIMessageType Msg, int &Data);
109 void Receive(LLIMessageType Msg, uint64_t &Data);
111 int WriteBytes(const void *Data, size_t Size);
112 int ReadBytes(void *Data, size_t Size);
116 } // end namespace llvm
118 #endif // LLI_REMOTETARGETEXTERNAL_H