1//===- llvm-jitlink-executor.cpp - Out-of-proc executor for llvm-jitlink -===//
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// Simple out-of-process executor for llvm-jitlink.
10//
11//===----------------------------------------------------------------------===//
12
13#include "llvm/ADT/StringRef.h"
14#include "llvm/Config/llvm-config.h" // for LLVM_ON_UNIX, LLVM_ENABLE_THREADS
15#include "llvm/ExecutionEngine/Orc/TargetProcess/DefaultHostBootstrapValues.h"
16#include "llvm/ExecutionEngine/Orc/TargetProcess/ExecutorSharedMemoryMapperService.h"
17#include "llvm/ExecutionEngine/Orc/TargetProcess/JITLoaderGDB.h"
18#include "llvm/ExecutionEngine/Orc/TargetProcess/RegisterEHFrames.h"
19#include "llvm/ExecutionEngine/Orc/TargetProcess/SimpleExecutorMemoryManager.h"
20#include "llvm/ExecutionEngine/Orc/TargetProcess/SimpleRemoteEPCServer.h"
21#include "llvm/ExecutionEngine/Orc/TargetProcess/UnwindInfoManager.h"
22#include "llvm/Support/Compiler.h"
23#include "llvm/Support/Debug.h"
24#include "llvm/Support/DynamicLibrary.h"
25#include "llvm/Support/Error.h"
26#include "llvm/Support/MathExtras.h"
27#include "llvm/Support/raw_ostream.h"
28#include <cstring>
29#include <sstream>
30
31#ifdef LLVM_ON_UNIX
32
33#include <netdb.h>
34#include <netinet/in.h>
35#include <sys/socket.h>
36
37#endif
38
39using namespace llvm;
40using namespace llvm::orc;
41
42ExitOnError ExitOnErr;
43
44LLVM_ATTRIBUTE_USED void linkComponents() {
45 errs() << (void *)&llvm_orc_registerEHFrameSectionAllocAction
46 << (void *)&llvm_orc_deregisterEHFrameSectionAllocAction
47 << (void *)&llvm_orc_registerJITLoaderGDBAllocAction;
48}
49
50void printErrorAndExit(Twine ErrMsg) {
51#ifndef NDEBUG
52 const char *DebugOption = "[debug] ";
53#else
54 const char *DebugOption = "";
55#endif
56
57 errs() << "error: " << ErrMsg.str() << "\n\n"
58 << "Usage:\n"
59 << " llvm-jitlink-executor " << DebugOption
60 << "[test-jitloadergdb] filedescs=<infd>,<outfd> [args...]\n"
61 << " llvm-jitlink-executor " << DebugOption
62 << "[test-jitloadergdb] listen=<host>:<port> [args...]\n";
63 exit(status: 1);
64}
65
66int openListener(std::string Host, std::string PortStr) {
67#ifndef LLVM_ON_UNIX
68 // FIXME: Add TCP support for Windows.
69 printErrorAndExit("listen option not supported");
70 return 0;
71#else
72 addrinfo Hints{};
73 Hints.ai_family = AF_INET;
74 Hints.ai_socktype = SOCK_STREAM;
75 Hints.ai_flags = AI_PASSIVE;
76
77 addrinfo *AI;
78 if (int EC = getaddrinfo(name: nullptr, service: PortStr.c_str(), req: &Hints, pai: &AI)) {
79 errs() << "Error setting up bind address: " << gai_strerror(ecode: EC) << "\n";
80 exit(status: 1);
81 }
82
83 // Create a socket from first addrinfo structure returned by getaddrinfo.
84 int SockFD;
85 if ((SockFD = socket(domain: AI->ai_family, type: AI->ai_socktype, protocol: AI->ai_protocol)) < 0) {
86 errs() << "Error creating socket: " << std::strerror(errno) << "\n";
87 exit(status: 1);
88 }
89
90 // Avoid "Address already in use" errors.
91 const int Yes = 1;
92 if (setsockopt(fd: SockFD, SOL_SOCKET, SO_REUSEADDR, optval: &Yes, optlen: sizeof(int)) == -1) {
93 errs() << "Error calling setsockopt: " << std::strerror(errno) << "\n";
94 exit(status: 1);
95 }
96
97 // Bind the socket to the desired port.
98 if (bind(fd: SockFD, addr: AI->ai_addr, len: AI->ai_addrlen) < 0) {
99 errs() << "Error on binding: " << std::strerror(errno) << "\n";
100 exit(status: 1);
101 }
102
103 // Listen for incomming connections.
104 static constexpr int ConnectionQueueLen = 1;
105 listen(fd: SockFD, n: ConnectionQueueLen);
106
107#if defined(_AIX)
108 assert(Hi_32(AI->ai_addrlen) == 0 && "Field is a size_t on 64-bit AIX");
109 socklen_t AddrLen = Lo_32(AI->ai_addrlen);
110 return accept(SockFD, AI->ai_addr, &AddrLen);
111#else
112 return accept(fd: SockFD, addr: AI->ai_addr, addr_len: &AI->ai_addrlen);
113#endif
114
115#endif // LLVM_ON_UNIX
116}
117
118#if LLVM_ENABLE_THREADS
119
120// JITLink debug support plugins put information about JITed code in this GDB
121// JIT Interface global from OrcTargetProcess.
122extern "C" LLVM_ABI struct jit_descriptor __jit_debug_descriptor;
123
124static void *findLastDebugDescriptorEntryPtr() {
125 struct jit_code_entry *Last = __jit_debug_descriptor.first_entry;
126 while (Last && Last->next_entry)
127 Last = Last->next_entry;
128 return Last;
129}
130
131#endif
132
133int main(int argc, char *argv[]) {
134#if LLVM_ENABLE_THREADS
135
136 ExitOnErr.setBanner(std::string(argv[0]) + ": ");
137
138 unsigned FirstProgramArg = 1;
139 int InFD = 0;
140 int OutFD = 0;
141
142 if (argc < 2)
143 printErrorAndExit(ErrMsg: "insufficient arguments");
144
145 StringRef NextArg = argv[FirstProgramArg++];
146#ifndef NDEBUG
147 if (NextArg == "debug") {
148 DebugFlag = true;
149 NextArg = argv[FirstProgramArg++];
150 }
151#endif
152
153 std::vector<StringRef> TestOutputFlags;
154 while (NextArg.starts_with(Prefix: "test-")) {
155 TestOutputFlags.push_back(x: NextArg);
156 NextArg = argv[FirstProgramArg++];
157 }
158
159 if (llvm::is_contained(Range&: TestOutputFlags, Element: "test-jitloadergdb"))
160 fprintf(stderr, format: "__jit_debug_descriptor.last_entry = 0x%016" PRIx64 "\n",
161 pointerToJITTargetAddress(Ptr: findLastDebugDescriptorEntryPtr()));
162
163 StringRef SpecifierType, Specifier;
164 std::tie(args&: SpecifierType, args&: Specifier) = NextArg.split(Separator: '=');
165 if (SpecifierType == "filedescs") {
166 StringRef FD1Str, FD2Str;
167 std::tie(args&: FD1Str, args&: FD2Str) = Specifier.split(Separator: ',');
168 if (FD1Str.getAsInteger(Radix: 10, Result&: InFD))
169 printErrorAndExit(ErrMsg: FD1Str + " is not a valid file descriptor");
170 if (FD2Str.getAsInteger(Radix: 10, Result&: OutFD))
171 printErrorAndExit(ErrMsg: FD2Str + " is not a valid file descriptor");
172 } else if (SpecifierType == "listen") {
173 StringRef Host, PortStr;
174 std::tie(args&: Host, args&: PortStr) = Specifier.split(Separator: ':');
175
176 int Port = 0;
177 if (PortStr.getAsInteger(Radix: 10, Result&: Port))
178 printErrorAndExit(ErrMsg: "port number '" + PortStr + "' is not a valid integer");
179
180 InFD = OutFD = openListener(Host: Host.str(), PortStr: PortStr.str());
181 } else
182 printErrorAndExit(ErrMsg: "invalid specifier type \"" + SpecifierType + "\"");
183
184 auto Server =
185 ExitOnErr(SimpleRemoteEPCServer::Create<FDSimpleRemoteEPCTransport>(
186 SetupFunction: [](SimpleRemoteEPCServer::Setup &S) -> Error {
187 S.setDispatcher(
188 std::make_unique<SimpleRemoteEPCServer::ThreadDispatcher>());
189 S.bootstrapSymbols() =
190 SimpleRemoteEPCServer::defaultBootstrapSymbols();
191 addDefaultBootstrapValuesForHostProcess(BootstrapMap&: S.bootstrapMap(),
192 BootstrapSymbols&: S.bootstrapSymbols());
193#ifdef __APPLE__
194 if (UnwindInfoManager::TryEnable())
195 UnwindInfoManager::addBootstrapSymbols(S.bootstrapSymbols());
196#endif // __APPLE__
197 S.services().push_back(
198 x: std::make_unique<rt_bootstrap::SimpleExecutorMemoryManager>());
199 S.services().push_back(
200 x: std::make_unique<
201 rt_bootstrap::ExecutorSharedMemoryMapperService>());
202 return Error::success();
203 },
204 TransportTCtorArgs&: InFD, TransportTCtorArgs&: OutFD));
205
206 ExitOnErr(Server->waitForDisconnect());
207
208 if (llvm::is_contained(Range&: TestOutputFlags, Element: "test-jitloadergdb"))
209 fprintf(stderr, format: "__jit_debug_descriptor.last_entry = 0x%016" PRIx64 "\n",
210 pointerToJITTargetAddress(Ptr: findLastDebugDescriptorEntryPtr()));
211
212 return 0;
213
214#else
215 errs() << argv[0]
216 << " error: this tool requires threads, but LLVM was "
217 "built with LLVM_ENABLE_THREADS=Off\n";
218 return 1;
219#endif
220}
221