blob: 407a79194f9636298b81766e008066797fc37d7a [file] [log] [blame]
Steven Moreland5553ac42020-11-11 02:14:45 +00001/*
2 * Copyright (C) 2020 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Andrei Homescu9d8adb12022-08-02 04:38:30 +000017#include <aidl/IBinderRpcTest.h>
Frederick Maylea12b0962022-06-25 01:13:22 +000018#include <android-base/stringprintf.h>
Steven Moreland5553ac42020-11-11 02:14:45 +000019
Steven Morelandc1635952021-04-01 16:20:47 +000020#include <chrono>
21#include <cstdlib>
22#include <iostream>
23#include <thread>
Steven Moreland659416d2021-05-11 00:47:50 +000024#include <type_traits>
Steven Morelandc1635952021-04-01 16:20:47 +000025
Andrei Homescu2a298012022-06-15 01:08:54 +000026#include <dlfcn.h>
Yifan Hong1deca4b2021-09-10 16:16:44 -070027#include <poll.h>
Steven Morelandc1635952021-04-01 16:20:47 +000028#include <sys/prctl.h>
Andrei Homescu992a4052022-06-28 21:26:18 +000029#include <sys/socket.h>
Steven Morelandc1635952021-04-01 16:20:47 +000030
Andrei Homescu68a55612022-08-02 01:25:15 +000031#ifdef __ANDROID_VENDOR__
32#include <binder/RpcTransportTipcAndroid.h>
33#include <trusty/tipc.h>
34#endif // __ANDROID_VENDOR__
35
Andrei Homescu2a298012022-06-15 01:08:54 +000036#include "binderRpcTestCommon.h"
Andrei Homescu96834632022-10-14 00:49:49 +000037#include "binderRpcTestFixture.h"
Steven Moreland5553ac42020-11-11 02:14:45 +000038
Yifan Hong1a235852021-05-13 16:07:47 -070039using namespace std::chrono_literals;
Yifan Hong67519322021-09-13 18:51:16 -070040using namespace std::placeholders;
Yifan Hong1deca4b2021-09-10 16:16:44 -070041using testing::AssertionFailure;
42using testing::AssertionResult;
43using testing::AssertionSuccess;
Yifan Hong1a235852021-05-13 16:07:47 -070044
Steven Moreland5553ac42020-11-11 02:14:45 +000045namespace android {
46
Andrei Homescu12106de2022-04-27 04:42:21 +000047#ifdef BINDER_TEST_NO_SHARED_LIBS
48constexpr bool kEnableSharedLibs = false;
49#else
50constexpr bool kEnableSharedLibs = true;
51#endif
52
Andrei Homescu68a55612022-08-02 01:25:15 +000053#ifdef __ANDROID_VENDOR__
54constexpr char kTrustyIpcDevice[] = "/dev/trusty-ipc-dev0";
55#endif
56
Frederick Maylea12b0962022-06-25 01:13:22 +000057static std::string WaitStatusToString(int wstatus) {
58 if (WIFEXITED(wstatus)) {
59 return base::StringPrintf("exit status %d", WEXITSTATUS(wstatus));
60 }
61 if (WIFSIGNALED(wstatus)) {
62 return base::StringPrintf("term signal %d", WTERMSIG(wstatus));
63 }
64 return base::StringPrintf("unexpected state %d", wstatus);
65}
66
Steven Moreland276d8df2022-09-28 23:56:39 +000067static void debugBacktrace(pid_t pid) {
68 std::cerr << "TAKING BACKTRACE FOR PID " << pid << std::endl;
69 system((std::string("debuggerd -b ") + std::to_string(pid)).c_str());
70}
71
Steven Moreland5553ac42020-11-11 02:14:45 +000072class Process {
73public:
Andrei Homescu96834632022-10-14 00:49:49 +000074 Process(Process&& other)
75 : mCustomExitStatusCheck(std::move(other.mCustomExitStatusCheck)),
76 mReadEnd(std::move(other.mReadEnd)),
77 mWriteEnd(std::move(other.mWriteEnd)) {
78 // The default move constructor doesn't clear mPid after moving it,
79 // which we need to do because the destructor checks for mPid!=0
80 mPid = other.mPid;
81 other.mPid = 0;
82 }
Yifan Hong1deca4b2021-09-10 16:16:44 -070083 Process(const std::function<void(android::base::borrowed_fd /* writeEnd */,
84 android::base::borrowed_fd /* readEnd */)>& f) {
85 android::base::unique_fd childWriteEnd;
86 android::base::unique_fd childReadEnd;
Andrei Homescu2a298012022-06-15 01:08:54 +000087 CHECK(android::base::Pipe(&mReadEnd, &childWriteEnd, 0)) << strerror(errno);
88 CHECK(android::base::Pipe(&childReadEnd, &mWriteEnd, 0)) << strerror(errno);
Steven Moreland5553ac42020-11-11 02:14:45 +000089 if (0 == (mPid = fork())) {
90 // racey: assume parent doesn't crash before this is set
91 prctl(PR_SET_PDEATHSIG, SIGHUP);
92
Yifan Hong1deca4b2021-09-10 16:16:44 -070093 f(childWriteEnd, childReadEnd);
Steven Morelandaf4ca712021-05-24 23:22:08 +000094
95 exit(0);
Steven Moreland5553ac42020-11-11 02:14:45 +000096 }
97 }
98 ~Process() {
99 if (mPid != 0) {
Frederick Maylea12b0962022-06-25 01:13:22 +0000100 int wstatus;
101 waitpid(mPid, &wstatus, 0);
102 if (mCustomExitStatusCheck) {
103 mCustomExitStatusCheck(wstatus);
104 } else {
105 EXPECT_TRUE(WIFEXITED(wstatus) && WEXITSTATUS(wstatus) == 0)
106 << "server process failed: " << WaitStatusToString(wstatus);
107 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000108 }
109 }
Yifan Hong0f58fb92021-06-16 16:09:23 -0700110 android::base::borrowed_fd readEnd() { return mReadEnd; }
Yifan Hong1deca4b2021-09-10 16:16:44 -0700111 android::base::borrowed_fd writeEnd() { return mWriteEnd; }
Steven Moreland5553ac42020-11-11 02:14:45 +0000112
Frederick Maylea12b0962022-06-25 01:13:22 +0000113 void setCustomExitStatusCheck(std::function<void(int wstatus)> f) {
114 mCustomExitStatusCheck = std::move(f);
115 }
116
Frederick Mayle69a0c992022-05-26 20:38:39 +0000117 // Kill the process. Avoid if possible. Shutdown gracefully via an RPC instead.
118 void terminate() { kill(mPid, SIGTERM); }
119
Steven Moreland276d8df2022-09-28 23:56:39 +0000120 pid_t getPid() { return mPid; }
121
Steven Moreland5553ac42020-11-11 02:14:45 +0000122private:
Frederick Maylea12b0962022-06-25 01:13:22 +0000123 std::function<void(int wstatus)> mCustomExitStatusCheck;
Steven Moreland5553ac42020-11-11 02:14:45 +0000124 pid_t mPid = 0;
Yifan Hong0f58fb92021-06-16 16:09:23 -0700125 android::base::unique_fd mReadEnd;
Yifan Hong1deca4b2021-09-10 16:16:44 -0700126 android::base::unique_fd mWriteEnd;
Steven Moreland5553ac42020-11-11 02:14:45 +0000127};
128
129static std::string allocateSocketAddress() {
130 static size_t id = 0;
Steven Moreland4bfbf2e2021-04-14 22:15:16 +0000131 std::string temp = getenv("TMPDIR") ?: "/tmp";
Yifan Hong1deca4b2021-09-10 16:16:44 -0700132 auto ret = temp + "/binderRpcTest_" + std::to_string(id++);
133 unlink(ret.c_str());
134 return ret;
Steven Moreland5553ac42020-11-11 02:14:45 +0000135};
136
Steven Morelandda573042021-06-12 01:13:45 +0000137static unsigned int allocateVsockPort() {
Andrei Homescu2a298012022-06-15 01:08:54 +0000138 static unsigned int vsockPort = 34567;
Steven Morelandda573042021-06-12 01:13:45 +0000139 return vsockPort++;
140}
141
Alice Wang893a9912022-10-24 10:44:09 +0000142static base::unique_fd initUnixSocket(std::string addr) {
143 auto socket_addr = UnixSocketAddress(addr.c_str());
144 base::unique_fd fd(
145 TEMP_FAILURE_RETRY(socket(socket_addr.addr()->sa_family, SOCK_STREAM, AF_UNIX)));
146 CHECK(fd.ok());
147 CHECK_EQ(0, TEMP_FAILURE_RETRY(bind(fd.get(), socket_addr.addr(), socket_addr.addrSize())));
148 return fd;
149}
150
Andrei Homescu96834632022-10-14 00:49:49 +0000151// Destructors need to be defined, even if pure virtual
152ProcessSession::~ProcessSession() {}
153
154class LinuxProcessSession : public ProcessSession {
155public:
Steven Moreland5553ac42020-11-11 02:14:45 +0000156 // reference to process hosting a socket server
157 Process host;
158
Andrei Homescu96834632022-10-14 00:49:49 +0000159 LinuxProcessSession(LinuxProcessSession&&) = default;
160 LinuxProcessSession(Process&& host) : host(std::move(host)) {}
161 ~LinuxProcessSession() override {
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000162 for (auto& session : sessions) {
163 session.root = nullptr;
Steven Moreland736664b2021-05-01 04:27:25 +0000164 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000165
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000166 for (auto& info : sessions) {
167 sp<RpcSession>& session = info.session;
Steven Moreland736664b2021-05-01 04:27:25 +0000168
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000169 EXPECT_NE(nullptr, session);
170 EXPECT_NE(nullptr, session->state());
171 EXPECT_EQ(0, session->state()->countBinders()) << (session->state()->dump(), "dump:");
Steven Moreland736664b2021-05-01 04:27:25 +0000172
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000173 wp<RpcSession> weakSession = session;
174 session = nullptr;
Steven Moreland276d8df2022-09-28 23:56:39 +0000175
Steven Moreland57042712022-10-04 23:56:45 +0000176 // b/244325464 - 'getStrongCount' is printing '1' on failure here, which indicates the
177 // the object should not actually be promotable. By looping, we distinguish a race here
178 // from a bug causing the object to not be promotable.
179 for (size_t i = 0; i < 3; i++) {
180 sp<RpcSession> strongSession = weakSession.promote();
181 EXPECT_EQ(nullptr, strongSession)
182 << (debugBacktrace(host.getPid()), debugBacktrace(getpid()),
183 "Leaked sess: ")
184 << strongSession->getStrongCount() << " checked time " << i;
185
186 if (strongSession != nullptr) {
187 sleep(1);
188 }
189 }
Steven Moreland736664b2021-05-01 04:27:25 +0000190 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000191 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000192
Andrei Homescu96834632022-10-14 00:49:49 +0000193 void setCustomExitStatusCheck(std::function<void(int wstatus)> f) override {
194 host.setCustomExitStatusCheck(std::move(f));
Steven Moreland5553ac42020-11-11 02:14:45 +0000195 }
Andrei Homescu96834632022-10-14 00:49:49 +0000196
197 void terminate() override { host.terminate(); }
Steven Moreland5553ac42020-11-11 02:14:45 +0000198};
199
Yifan Hong1deca4b2021-09-10 16:16:44 -0700200static base::unique_fd connectTo(const RpcSocketAddress& addr) {
Steven Moreland4198a122021-08-03 17:37:58 -0700201 base::unique_fd serverFd(
202 TEMP_FAILURE_RETRY(socket(addr.addr()->sa_family, SOCK_STREAM | SOCK_CLOEXEC, 0)));
203 int savedErrno = errno;
Yifan Hong1deca4b2021-09-10 16:16:44 -0700204 CHECK(serverFd.ok()) << "Could not create socket " << addr.toString() << ": "
205 << strerror(savedErrno);
Steven Moreland4198a122021-08-03 17:37:58 -0700206
207 if (0 != TEMP_FAILURE_RETRY(connect(serverFd.get(), addr.addr(), addr.addrSize()))) {
208 int savedErrno = errno;
Yifan Hong1deca4b2021-09-10 16:16:44 -0700209 LOG(FATAL) << "Could not connect to socket " << addr.toString() << ": "
210 << strerror(savedErrno);
Steven Moreland4198a122021-08-03 17:37:58 -0700211 }
212 return serverFd;
213}
214
David Brazdil21c887c2022-09-23 12:25:18 +0100215static base::unique_fd connectToUnixBootstrap(const RpcTransportFd& transportFd) {
216 base::unique_fd sockClient, sockServer;
217 if (!base::Socketpair(SOCK_STREAM, &sockClient, &sockServer)) {
218 int savedErrno = errno;
219 LOG(FATAL) << "Failed socketpair(): " << strerror(savedErrno);
220 }
221
222 int zero = 0;
223 iovec iov{&zero, sizeof(zero)};
224 std::vector<std::variant<base::unique_fd, base::borrowed_fd>> fds;
225 fds.emplace_back(std::move(sockServer));
226
227 if (sendMessageOnSocket(transportFd, &iov, 1, &fds) < 0) {
228 int savedErrno = errno;
229 LOG(FATAL) << "Failed sendMessageOnSocket: " << strerror(savedErrno);
230 }
231 return std::move(sockClient);
232}
233
Andrei Homescu96834632022-10-14 00:49:49 +0000234std::string BinderRpc::PrintParamInfo(const testing::TestParamInfo<ParamType>& info) {
235 auto [type, security, clientVersion, serverVersion, singleThreaded, noKernel] = info.param;
236 auto ret = PrintToString(type) + "_" + newFactory(security)->toCString() + "_clientV" +
237 std::to_string(clientVersion) + "_serverV" + std::to_string(serverVersion);
238 if (singleThreaded) {
239 ret += "_single_threaded";
Steven Moreland5602a1a2023-03-06 19:25:46 +0000240 } else {
241 ret += "_multi_threaded";
Andrei Homescu96834632022-10-14 00:49:49 +0000242 }
243 if (noKernel) {
244 ret += "_no_kernel";
Steven Moreland5602a1a2023-03-06 19:25:46 +0000245 } else {
246 ret += "_with_kernel";
Andrei Homescu96834632022-10-14 00:49:49 +0000247 }
248 return ret;
249}
Andrei Homescu2a298012022-06-15 01:08:54 +0000250
Andrei Homescu96834632022-10-14 00:49:49 +0000251// This creates a new process serving an interface on a certain number of
252// threads.
253std::unique_ptr<ProcessSession> BinderRpc::createRpcTestSocketServerProcessEtc(
254 const BinderRpcOptions& options) {
255 CHECK_GE(options.numSessions, 1) << "Must have at least one session to a server";
Frederick Mayle69a0c992022-05-26 20:38:39 +0000256
Andrei Homescu96834632022-10-14 00:49:49 +0000257 SocketType socketType = std::get<0>(GetParam());
258 RpcSecurity rpcSecurity = std::get<1>(GetParam());
259 uint32_t clientVersion = std::get<2>(GetParam());
260 uint32_t serverVersion = std::get<3>(GetParam());
261 bool singleThreaded = std::get<4>(GetParam());
262 bool noKernel = std::get<5>(GetParam());
263
264 std::string path = android::base::GetExecutableDirectory();
265 auto servicePath = android::base::StringPrintf("%s/binder_rpc_test_service%s%s", path.c_str(),
266 singleThreaded ? "_single_threaded" : "",
267 noKernel ? "_no_kernel" : "");
268
Alice Wang1ef010b2022-11-14 09:09:25 +0000269 base::unique_fd bootstrapClientFd, socketFd;
270
Alice Wang893a9912022-10-24 10:44:09 +0000271 auto addr = allocateSocketAddress();
272 // Initializes the socket before the fork/exec.
273 if (socketType == SocketType::UNIX_RAW) {
274 socketFd = initUnixSocket(addr);
Alice Wang1ef010b2022-11-14 09:09:25 +0000275 } else if (socketType == SocketType::UNIX_BOOTSTRAP) {
276 // Do not set O_CLOEXEC, bootstrapServerFd needs to survive fork/exec.
277 // This is because we cannot pass ParcelFileDescriptor over a pipe.
278 if (!base::Socketpair(SOCK_STREAM, &bootstrapClientFd, &socketFd)) {
279 int savedErrno = errno;
280 LOG(FATAL) << "Failed socketpair(): " << strerror(savedErrno);
281 }
Alice Wang893a9912022-10-24 10:44:09 +0000282 }
Andrei Homescua858b0e2022-08-01 23:43:09 +0000283
Andrei Homescu96834632022-10-14 00:49:49 +0000284 auto ret = std::make_unique<LinuxProcessSession>(
285 Process([=](android::base::borrowed_fd writeEnd, android::base::borrowed_fd readEnd) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000286 if (socketType == SocketType::TIPC) {
287 // Trusty has a single persistent service
288 return;
289 }
290
Andrei Homescu96834632022-10-14 00:49:49 +0000291 auto writeFd = std::to_string(writeEnd.get());
292 auto readFd = std::to_string(readEnd.get());
293 execl(servicePath.c_str(), servicePath.c_str(), writeFd.c_str(), readFd.c_str(),
294 NULL);
295 }));
296
297 BinderRpcTestServerConfig serverConfig;
298 serverConfig.numThreads = options.numThreads;
299 serverConfig.socketType = static_cast<int32_t>(socketType);
300 serverConfig.rpcSecurity = static_cast<int32_t>(rpcSecurity);
301 serverConfig.serverVersion = serverVersion;
302 serverConfig.vsockPort = allocateVsockPort();
Alice Wang893a9912022-10-24 10:44:09 +0000303 serverConfig.addr = addr;
Alice Wang893a9912022-10-24 10:44:09 +0000304 serverConfig.socketFd = socketFd.get();
Andrei Homescu96834632022-10-14 00:49:49 +0000305 for (auto mode : options.serverSupportedFileDescriptorTransportModes) {
306 serverConfig.serverSupportedFileDescriptorTransportModes.push_back(
307 static_cast<int32_t>(mode));
308 }
Andrei Homescu68a55612022-08-02 01:25:15 +0000309 if (socketType != SocketType::TIPC) {
310 writeToFd(ret->host.writeEnd(), serverConfig);
311 }
Andrei Homescu96834632022-10-14 00:49:49 +0000312
313 std::vector<sp<RpcSession>> sessions;
314 auto certVerifier = std::make_shared<RpcCertificateVerifierSimple>();
315 for (size_t i = 0; i < options.numSessions; i++) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000316 std::unique_ptr<RpcTransportCtxFactory> factory;
317 if (socketType == SocketType::TIPC) {
318#ifdef __ANDROID_VENDOR__
319 factory = RpcTransportCtxFactoryTipcAndroid::make();
320#else
321 LOG_ALWAYS_FATAL("TIPC socket type only supported on vendor");
322#endif
323 } else {
324 factory = newFactory(rpcSecurity, certVerifier);
325 }
326 sessions.emplace_back(RpcSession::make(std::move(factory)));
David Brazdil21c887c2022-09-23 12:25:18 +0100327 }
328
Andrei Homescu68a55612022-08-02 01:25:15 +0000329 BinderRpcTestServerInfo serverInfo;
330 if (socketType != SocketType::TIPC) {
331 serverInfo = readFromFd<BinderRpcTestServerInfo>(ret->host.readEnd());
332 BinderRpcTestClientInfo clientInfo;
333 for (const auto& session : sessions) {
334 auto& parcelableCert = clientInfo.certs.emplace_back();
335 parcelableCert.data = session->getCertificate(RpcCertificateFormat::PEM);
336 }
337 writeToFd(ret->host.writeEnd(), clientInfo);
Andrei Homescu96834632022-10-14 00:49:49 +0000338
Andrei Homescu68a55612022-08-02 01:25:15 +0000339 CHECK_LE(serverInfo.port, std::numeric_limits<unsigned int>::max());
340 if (socketType == SocketType::INET) {
341 CHECK_NE(0, serverInfo.port);
342 }
Frederick Mayle69a0c992022-05-26 20:38:39 +0000343
Andrei Homescu68a55612022-08-02 01:25:15 +0000344 if (rpcSecurity == RpcSecurity::TLS) {
345 const auto& serverCert = serverInfo.cert.data;
346 CHECK_EQ(OK,
347 certVerifier->addTrustedPeerCertificate(RpcCertificateFormat::PEM,
348 serverCert));
349 }
Yifan Hong1deca4b2021-09-10 16:16:44 -0700350 }
351
Andrei Homescu96834632022-10-14 00:49:49 +0000352 status_t status;
Steven Moreland736664b2021-05-01 04:27:25 +0000353
Andrei Homescu96834632022-10-14 00:49:49 +0000354 for (const auto& session : sessions) {
355 CHECK(session->setProtocolVersion(clientVersion));
356 session->setMaxIncomingThreads(options.numIncomingConnections);
Steven Morelandfeb13e82023-03-01 01:25:33 +0000357 session->setMaxOutgoingConnections(options.numOutgoingConnections);
Andrei Homescu96834632022-10-14 00:49:49 +0000358 session->setFileDescriptorTransportMode(options.clientFileDescriptorTransportMode);
Steven Morelandc1635952021-04-01 16:20:47 +0000359
Andrei Homescu96834632022-10-14 00:49:49 +0000360 switch (socketType) {
361 case SocketType::PRECONNECTED:
362 status = session->setupPreconnectedClient({}, [=]() {
363 return connectTo(UnixSocketAddress(serverConfig.addr.c_str()));
364 });
Frederick Mayle69a0c992022-05-26 20:38:39 +0000365 break;
Alice Wang893a9912022-10-24 10:44:09 +0000366 case SocketType::UNIX_RAW:
Andrei Homescu96834632022-10-14 00:49:49 +0000367 case SocketType::UNIX:
368 status = session->setupUnixDomainClient(serverConfig.addr.c_str());
369 break;
370 case SocketType::UNIX_BOOTSTRAP:
371 status = session->setupUnixDomainSocketBootstrapClient(
372 base::unique_fd(dup(bootstrapClientFd.get())));
373 break;
374 case SocketType::VSOCK:
375 status = session->setupVsockClient(VMADDR_CID_LOCAL, serverConfig.vsockPort);
376 break;
377 case SocketType::INET:
378 status = session->setupInetClient("127.0.0.1", serverInfo.port);
379 break;
Andrei Homescu68a55612022-08-02 01:25:15 +0000380 case SocketType::TIPC:
381 status = session->setupPreconnectedClient({}, [=]() {
382#ifdef __ANDROID_VENDOR__
383 auto port = trustyIpcPort(serverVersion);
384 int tipcFd = tipc_connect(kTrustyIpcDevice, port.c_str());
385 return tipcFd >= 0 ? android::base::unique_fd(tipcFd)
386 : android::base::unique_fd();
387#else
388 LOG_ALWAYS_FATAL("Tried to connect to Trusty outside of vendor");
389 return android::base::unique_fd();
390#endif
391 });
392 break;
Andrei Homescu96834632022-10-14 00:49:49 +0000393 default:
394 LOG_ALWAYS_FATAL("Unknown socket type");
Steven Morelandc1635952021-04-01 16:20:47 +0000395 }
Andrei Homescu96834632022-10-14 00:49:49 +0000396 if (options.allowConnectFailure && status != OK) {
397 ret->sessions.clear();
398 break;
399 }
400 CHECK_EQ(status, OK) << "Could not connect: " << statusToString(status);
401 ret->sessions.push_back({session, session->getRootObject()});
Steven Morelandc1635952021-04-01 16:20:47 +0000402 }
Andrei Homescu96834632022-10-14 00:49:49 +0000403 return ret;
404}
Steven Morelandc1635952021-04-01 16:20:47 +0000405
Andrei Homescua858b0e2022-08-01 23:43:09 +0000406TEST_P(BinderRpc, ThreadPoolGreaterThanEqualRequested) {
407 if (clientOrServerSingleThreaded()) {
408 GTEST_SKIP() << "This test requires multiple threads";
409 }
410
Steven Moreland5553ac42020-11-11 02:14:45 +0000411 constexpr size_t kNumThreads = 10;
412
Steven Moreland4313d7e2021-07-15 23:41:22 +0000413 auto proc = createRpcTestSocketServerProcess({.numThreads = kNumThreads});
Steven Moreland5553ac42020-11-11 02:14:45 +0000414
415 EXPECT_OK(proc.rootIface->lock());
416
417 // block all but one thread taking locks
418 std::vector<std::thread> ts;
419 for (size_t i = 0; i < kNumThreads - 1; i++) {
420 ts.push_back(std::thread([&] { proc.rootIface->lockUnlock(); }));
421 }
422
Steven Morelandd6d816f2022-12-23 01:37:17 +0000423 usleep(100000); // give chance for calls on other threads
Steven Moreland5553ac42020-11-11 02:14:45 +0000424
425 // other calls still work
426 EXPECT_EQ(OK, proc.rootBinder->pingBinder());
427
Steven Morelandd6d816f2022-12-23 01:37:17 +0000428 constexpr size_t blockTimeMs = 100;
Steven Moreland5553ac42020-11-11 02:14:45 +0000429 size_t epochMsBefore = epochMillis();
430 // after this, we should never see a response within this time
431 EXPECT_OK(proc.rootIface->unlockInMsAsync(blockTimeMs));
432
433 // this call should be blocked for blockTimeMs
434 EXPECT_EQ(OK, proc.rootBinder->pingBinder());
435
436 size_t epochMsAfter = epochMillis();
437 EXPECT_GE(epochMsAfter, epochMsBefore + blockTimeMs) << epochMsBefore;
438
439 for (auto& t : ts) t.join();
440}
441
Andrei Homescu96834632022-10-14 00:49:49 +0000442static void testThreadPoolOverSaturated(sp<IBinderRpcTest> iface, size_t numCalls,
443 size_t sleepMs = 500) {
Steven Moreland5553ac42020-11-11 02:14:45 +0000444 size_t epochMsBefore = epochMillis();
445
446 std::vector<std::thread> ts;
Yifan Hong1f44f982021-10-08 17:16:47 -0700447 for (size_t i = 0; i < numCalls; i++) {
448 ts.push_back(std::thread([&] { iface->sleepMs(sleepMs); }));
Steven Moreland5553ac42020-11-11 02:14:45 +0000449 }
450
451 for (auto& t : ts) t.join();
452
453 size_t epochMsAfter = epochMillis();
454
Yifan Hong1f44f982021-10-08 17:16:47 -0700455 EXPECT_GE(epochMsAfter, epochMsBefore + 2 * sleepMs);
Steven Moreland5553ac42020-11-11 02:14:45 +0000456
457 // Potential flake, but make sure calls are handled in parallel.
Yifan Hong1f44f982021-10-08 17:16:47 -0700458 EXPECT_LE(epochMsAfter, epochMsBefore + 3 * sleepMs);
459}
460
Andrei Homescua858b0e2022-08-01 23:43:09 +0000461TEST_P(BinderRpc, ThreadPoolOverSaturated) {
462 if (clientOrServerSingleThreaded()) {
463 GTEST_SKIP() << "This test requires multiple threads";
464 }
465
Yifan Hong1f44f982021-10-08 17:16:47 -0700466 constexpr size_t kNumThreads = 10;
467 constexpr size_t kNumCalls = kNumThreads + 3;
468 auto proc = createRpcTestSocketServerProcess({.numThreads = kNumThreads});
469 testThreadPoolOverSaturated(proc.rootIface, kNumCalls);
470}
471
Andrei Homescua858b0e2022-08-01 23:43:09 +0000472TEST_P(BinderRpc, ThreadPoolLimitOutgoing) {
473 if (clientOrServerSingleThreaded()) {
474 GTEST_SKIP() << "This test requires multiple threads";
475 }
476
Yifan Hong1f44f982021-10-08 17:16:47 -0700477 constexpr size_t kNumThreads = 20;
478 constexpr size_t kNumOutgoingConnections = 10;
479 constexpr size_t kNumCalls = kNumOutgoingConnections + 3;
480 auto proc = createRpcTestSocketServerProcess(
481 {.numThreads = kNumThreads, .numOutgoingConnections = kNumOutgoingConnections});
482 testThreadPoolOverSaturated(proc.rootIface, kNumCalls);
Steven Moreland5553ac42020-11-11 02:14:45 +0000483}
484
Andrei Homescua858b0e2022-08-01 23:43:09 +0000485TEST_P(BinderRpc, ThreadingStressTest) {
486 if (clientOrServerSingleThreaded()) {
487 GTEST_SKIP() << "This test requires multiple threads";
488 }
489
Steven Moreland5553ac42020-11-11 02:14:45 +0000490 constexpr size_t kNumClientThreads = 10;
491 constexpr size_t kNumServerThreads = 10;
492 constexpr size_t kNumCalls = 100;
493
Steven Moreland4313d7e2021-07-15 23:41:22 +0000494 auto proc = createRpcTestSocketServerProcess({.numThreads = kNumServerThreads});
Steven Moreland5553ac42020-11-11 02:14:45 +0000495
496 std::vector<std::thread> threads;
497 for (size_t i = 0; i < kNumClientThreads; i++) {
498 threads.push_back(std::thread([&] {
499 for (size_t j = 0; j < kNumCalls; j++) {
500 sp<IBinder> out;
Steven Morelandc6046982021-04-20 00:49:42 +0000501 EXPECT_OK(proc.rootIface->repeatBinder(proc.rootBinder, &out));
Steven Moreland5553ac42020-11-11 02:14:45 +0000502 EXPECT_EQ(proc.rootBinder, out);
503 }
504 }));
505 }
506
507 for (auto& t : threads) t.join();
508}
509
Steven Moreland925ba0a2021-09-17 18:06:32 -0700510static void saturateThreadPool(size_t threadCount, const sp<IBinderRpcTest>& iface) {
511 std::vector<std::thread> threads;
512 for (size_t i = 0; i < threadCount; i++) {
513 threads.push_back(std::thread([&] { EXPECT_OK(iface->sleepMs(500)); }));
514 }
515 for (auto& t : threads) t.join();
516}
517
Andrei Homescua858b0e2022-08-01 23:43:09 +0000518TEST_P(BinderRpc, OnewayStressTest) {
519 if (clientOrServerSingleThreaded()) {
520 GTEST_SKIP() << "This test requires multiple threads";
521 }
522
Steven Morelandc6046982021-04-20 00:49:42 +0000523 constexpr size_t kNumClientThreads = 10;
524 constexpr size_t kNumServerThreads = 10;
Steven Moreland3c3ab8d2021-09-23 10:29:50 -0700525 constexpr size_t kNumCalls = 1000;
Steven Morelandc6046982021-04-20 00:49:42 +0000526
Steven Moreland4313d7e2021-07-15 23:41:22 +0000527 auto proc = createRpcTestSocketServerProcess({.numThreads = kNumServerThreads});
Steven Morelandc6046982021-04-20 00:49:42 +0000528
529 std::vector<std::thread> threads;
530 for (size_t i = 0; i < kNumClientThreads; i++) {
531 threads.push_back(std::thread([&] {
532 for (size_t j = 0; j < kNumCalls; j++) {
533 EXPECT_OK(proc.rootIface->sendString("a"));
534 }
Steven Morelandc6046982021-04-20 00:49:42 +0000535 }));
536 }
537
538 for (auto& t : threads) t.join();
Steven Moreland925ba0a2021-09-17 18:06:32 -0700539
540 saturateThreadPool(kNumServerThreads, proc.rootIface);
Steven Morelandc6046982021-04-20 00:49:42 +0000541}
542
Frederick Mayleb0221d12022-10-03 23:10:53 +0000543TEST_P(BinderRpc, OnewayCallQueueingWithFds) {
544 if (!supportsFdTransport()) {
545 GTEST_SKIP() << "Would fail trivially (which is tested elsewhere)";
546 }
547 if (clientOrServerSingleThreaded()) {
548 GTEST_SKIP() << "This test requires multiple threads";
549 }
550
Andrei Homescu5f2bc562023-02-25 04:59:43 +0000551 constexpr size_t kNumServerThreads = 3;
552
Frederick Mayleb0221d12022-10-03 23:10:53 +0000553 // This test forces a oneway transaction to be queued by issuing two
554 // `blockingSendFdOneway` calls, then drains the queue by issuing two
555 // `blockingRecvFd` calls.
556 //
557 // For more details about the queuing semantics see
558 // https://developer.android.com/reference/android/os/IBinder#FLAG_ONEWAY
559
560 auto proc = createRpcTestSocketServerProcess({
Andrei Homescu5f2bc562023-02-25 04:59:43 +0000561 .numThreads = kNumServerThreads,
Frederick Mayleb0221d12022-10-03 23:10:53 +0000562 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
563 .serverSupportedFileDescriptorTransportModes =
564 {RpcSession::FileDescriptorTransportMode::UNIX},
565 });
566
567 EXPECT_OK(proc.rootIface->blockingSendFdOneway(
568 android::os::ParcelFileDescriptor(mockFileDescriptor("a"))));
569 EXPECT_OK(proc.rootIface->blockingSendFdOneway(
570 android::os::ParcelFileDescriptor(mockFileDescriptor("b"))));
571
572 android::os::ParcelFileDescriptor fdA;
573 EXPECT_OK(proc.rootIface->blockingRecvFd(&fdA));
574 std::string result;
575 CHECK(android::base::ReadFdToString(fdA.get(), &result));
576 EXPECT_EQ(result, "a");
577
578 android::os::ParcelFileDescriptor fdB;
579 EXPECT_OK(proc.rootIface->blockingRecvFd(&fdB));
580 CHECK(android::base::ReadFdToString(fdB.get(), &result));
581 EXPECT_EQ(result, "b");
Andrei Homescu5f2bc562023-02-25 04:59:43 +0000582
583 saturateThreadPool(kNumServerThreads, proc.rootIface);
Frederick Mayleb0221d12022-10-03 23:10:53 +0000584}
585
Andrei Homescua858b0e2022-08-01 23:43:09 +0000586TEST_P(BinderRpc, OnewayCallQueueing) {
587 if (clientOrServerSingleThreaded()) {
588 GTEST_SKIP() << "This test requires multiple threads";
589 }
590
Steven Moreland5553ac42020-11-11 02:14:45 +0000591 constexpr size_t kNumSleeps = 10;
592 constexpr size_t kNumExtraServerThreads = 4;
593 constexpr size_t kSleepMs = 50;
594
595 // make sure calls to the same object happen on the same thread
Steven Moreland4313d7e2021-07-15 23:41:22 +0000596 auto proc = createRpcTestSocketServerProcess({.numThreads = 1 + kNumExtraServerThreads});
Steven Moreland5553ac42020-11-11 02:14:45 +0000597
598 EXPECT_OK(proc.rootIface->lock());
599
Steven Moreland1c678802021-09-17 16:48:47 -0700600 size_t epochMsBefore = epochMillis();
601
602 // all these *Async commands should be queued on the server sequentially,
603 // even though there are multiple threads.
604 for (size_t i = 0; i + 1 < kNumSleeps; i++) {
Steven Moreland5553ac42020-11-11 02:14:45 +0000605 proc.rootIface->sleepMsAsync(kSleepMs);
606 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000607 EXPECT_OK(proc.rootIface->unlockInMsAsync(kSleepMs));
608
Steven Moreland1c678802021-09-17 16:48:47 -0700609 // this can only return once the final async call has unlocked
Steven Moreland5553ac42020-11-11 02:14:45 +0000610 EXPECT_OK(proc.rootIface->lockUnlock());
Steven Moreland1c678802021-09-17 16:48:47 -0700611
Steven Moreland5553ac42020-11-11 02:14:45 +0000612 size_t epochMsAfter = epochMillis();
613
Frederick Mayle3fa815d2022-07-12 22:52:52 +0000614 EXPECT_GE(epochMsAfter, epochMsBefore + kSleepMs * kNumSleeps);
Steven Morelandf5174272021-05-25 00:39:28 +0000615
Steven Moreland925ba0a2021-09-17 18:06:32 -0700616 saturateThreadPool(1 + kNumExtraServerThreads, proc.rootIface);
Steven Moreland5553ac42020-11-11 02:14:45 +0000617}
618
Andrei Homescua858b0e2022-08-01 23:43:09 +0000619TEST_P(BinderRpc, OnewayCallExhaustion) {
620 if (clientOrServerSingleThreaded()) {
621 GTEST_SKIP() << "This test requires multiple threads";
622 }
623
Steven Morelandd45be622021-06-04 02:19:37 +0000624 constexpr size_t kNumClients = 2;
625 constexpr size_t kTooLongMs = 1000;
626
Steven Moreland4313d7e2021-07-15 23:41:22 +0000627 auto proc = createRpcTestSocketServerProcess({.numThreads = kNumClients, .numSessions = 2});
Steven Morelandd45be622021-06-04 02:19:37 +0000628
629 // Build up oneway calls on the second session to make sure it terminates
630 // and shuts down. The first session should be unaffected (proc destructor
631 // checks the first session).
Andrei Homescu96834632022-10-14 00:49:49 +0000632 auto iface = interface_cast<IBinderRpcTest>(proc.proc->sessions.at(1).root);
Steven Morelandd45be622021-06-04 02:19:37 +0000633
634 std::vector<std::thread> threads;
635 for (size_t i = 0; i < kNumClients; i++) {
636 // one of these threads will get stuck queueing a transaction once the
637 // socket fills up, the other will be able to fill up transactions on
638 // this object
639 threads.push_back(std::thread([&] {
640 while (iface->sleepMsAsync(kTooLongMs).isOk()) {
641 }
642 }));
643 }
644 for (auto& t : threads) t.join();
645
646 Status status = iface->sleepMsAsync(kTooLongMs);
647 EXPECT_EQ(DEAD_OBJECT, status.transactionError()) << status;
648
Steven Moreland798e0d12021-07-14 23:19:25 +0000649 // now that it has died, wait for the remote session to shutdown
650 std::vector<int32_t> remoteCounts;
651 do {
652 EXPECT_OK(proc.rootIface->countBinders(&remoteCounts));
653 } while (remoteCounts.size() == kNumClients);
654
Steven Morelandd45be622021-06-04 02:19:37 +0000655 // the second session should be shutdown in the other process by the time we
656 // are able to join above (it'll only be hung up once it finishes processing
657 // any pending commands). We need to erase this session from the record
658 // here, so that the destructor for our session won't check that this
659 // session is valid, but we still want it to test the other session.
Andrei Homescu96834632022-10-14 00:49:49 +0000660 proc.proc->sessions.erase(proc.proc->sessions.begin() + 1);
Steven Morelandd45be622021-06-04 02:19:37 +0000661}
662
Devin Moore66d5b7a2022-07-07 21:42:10 +0000663TEST_P(BinderRpc, SingleDeathRecipient) {
Andrei Homescua858b0e2022-08-01 23:43:09 +0000664 if (clientOrServerSingleThreaded()) {
Devin Moore66d5b7a2022-07-07 21:42:10 +0000665 GTEST_SKIP() << "This test requires multiple threads";
666 }
667 class MyDeathRec : public IBinder::DeathRecipient {
668 public:
669 void binderDied(const wp<IBinder>& /* who */) override {
670 dead = true;
671 mCv.notify_one();
672 }
673 std::mutex mMtx;
674 std::condition_variable mCv;
675 bool dead = false;
676 };
677
678 // Death recipient needs to have an incoming connection to be called
679 auto proc = createRpcTestSocketServerProcess(
680 {.numThreads = 1, .numSessions = 1, .numIncomingConnections = 1});
681
682 auto dr = sp<MyDeathRec>::make();
683 ASSERT_EQ(OK, proc.rootBinder->linkToDeath(dr, (void*)1, 0));
684
685 if (auto status = proc.rootIface->scheduleShutdown(); !status.isOk()) {
686 EXPECT_EQ(DEAD_OBJECT, status.transactionError()) << status;
687 }
688
689 std::unique_lock<std::mutex> lock(dr->mMtx);
Steven Morelanddd231e22022-09-08 19:47:49 +0000690 ASSERT_TRUE(dr->mCv.wait_for(lock, 100ms, [&]() { return dr->dead; }));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000691
692 // need to wait for the session to shutdown so we don't "Leak session"
Andrei Homescu96834632022-10-14 00:49:49 +0000693 EXPECT_TRUE(proc.proc->sessions.at(0).session->shutdownAndWait(true));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000694 proc.expectAlreadyShutdown = true;
695}
696
697TEST_P(BinderRpc, SingleDeathRecipientOnShutdown) {
Andrei Homescua858b0e2022-08-01 23:43:09 +0000698 if (clientOrServerSingleThreaded()) {
Devin Moore66d5b7a2022-07-07 21:42:10 +0000699 GTEST_SKIP() << "This test requires multiple threads";
700 }
701 class MyDeathRec : public IBinder::DeathRecipient {
702 public:
703 void binderDied(const wp<IBinder>& /* who */) override {
704 dead = true;
705 mCv.notify_one();
706 }
707 std::mutex mMtx;
708 std::condition_variable mCv;
709 bool dead = false;
710 };
711
712 // Death recipient needs to have an incoming connection to be called
713 auto proc = createRpcTestSocketServerProcess(
714 {.numThreads = 1, .numSessions = 1, .numIncomingConnections = 1});
715
716 auto dr = sp<MyDeathRec>::make();
717 EXPECT_EQ(OK, proc.rootBinder->linkToDeath(dr, (void*)1, 0));
718
719 // Explicitly calling shutDownAndWait will cause the death recipients
720 // to be called.
Andrei Homescu96834632022-10-14 00:49:49 +0000721 EXPECT_TRUE(proc.proc->sessions.at(0).session->shutdownAndWait(true));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000722
723 std::unique_lock<std::mutex> lock(dr->mMtx);
724 if (!dr->dead) {
Steven Morelanddd231e22022-09-08 19:47:49 +0000725 EXPECT_EQ(std::cv_status::no_timeout, dr->mCv.wait_for(lock, 100ms));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000726 }
727 EXPECT_TRUE(dr->dead) << "Failed to receive the death notification.";
728
Andrei Homescu96834632022-10-14 00:49:49 +0000729 proc.proc->terminate();
730 proc.proc->setCustomExitStatusCheck([](int wstatus) {
Devin Moore66d5b7a2022-07-07 21:42:10 +0000731 EXPECT_TRUE(WIFSIGNALED(wstatus) && WTERMSIG(wstatus) == SIGTERM)
732 << "server process failed incorrectly: " << WaitStatusToString(wstatus);
733 });
734 proc.expectAlreadyShutdown = true;
735}
736
Steven Moreland5ec743f2023-01-18 01:02:06 +0000737TEST_P(BinderRpc, DeathRecipientFailsWithoutIncoming) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000738 if (socketType() == SocketType::TIPC) {
739 // This should work, but Trusty takes too long to restart the service
740 GTEST_SKIP() << "Service death test not supported on Trusty";
741 }
Devin Moore66d5b7a2022-07-07 21:42:10 +0000742 class MyDeathRec : public IBinder::DeathRecipient {
743 public:
744 void binderDied(const wp<IBinder>& /* who */) override {}
745 };
746
747 auto proc = createRpcTestSocketServerProcess(
748 {.numThreads = 1, .numSessions = 1, .numIncomingConnections = 0});
749
750 auto dr = sp<MyDeathRec>::make();
Steven Moreland5ec743f2023-01-18 01:02:06 +0000751 EXPECT_EQ(INVALID_OPERATION, proc.rootBinder->linkToDeath(dr, (void*)1, 0));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000752}
753
754TEST_P(BinderRpc, UnlinkDeathRecipient) {
Andrei Homescua858b0e2022-08-01 23:43:09 +0000755 if (clientOrServerSingleThreaded()) {
Devin Moore66d5b7a2022-07-07 21:42:10 +0000756 GTEST_SKIP() << "This test requires multiple threads";
757 }
758 class MyDeathRec : public IBinder::DeathRecipient {
759 public:
760 void binderDied(const wp<IBinder>& /* who */) override {
761 GTEST_FAIL() << "This should not be called after unlinkToDeath";
762 }
763 };
764
765 // Death recipient needs to have an incoming connection to be called
766 auto proc = createRpcTestSocketServerProcess(
767 {.numThreads = 1, .numSessions = 1, .numIncomingConnections = 1});
768
769 auto dr = sp<MyDeathRec>::make();
770 ASSERT_EQ(OK, proc.rootBinder->linkToDeath(dr, (void*)1, 0));
771 ASSERT_EQ(OK, proc.rootBinder->unlinkToDeath(dr, (void*)1, 0, nullptr));
772
773 if (auto status = proc.rootIface->scheduleShutdown(); !status.isOk()) {
774 EXPECT_EQ(DEAD_OBJECT, status.transactionError()) << status;
775 }
776
777 // need to wait for the session to shutdown so we don't "Leak session"
Andrei Homescu96834632022-10-14 00:49:49 +0000778 EXPECT_TRUE(proc.proc->sessions.at(0).session->shutdownAndWait(true));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000779 proc.expectAlreadyShutdown = true;
780}
781
Steven Morelandc1635952021-04-01 16:20:47 +0000782TEST_P(BinderRpc, Die) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000783 if (socketType() == SocketType::TIPC) {
784 // This should work, but Trusty takes too long to restart the service
785 GTEST_SKIP() << "Service death test not supported on Trusty";
786 }
787
Steven Moreland5553ac42020-11-11 02:14:45 +0000788 for (bool doDeathCleanup : {true, false}) {
Steven Moreland4313d7e2021-07-15 23:41:22 +0000789 auto proc = createRpcTestSocketServerProcess({});
Steven Moreland5553ac42020-11-11 02:14:45 +0000790
791 // make sure there is some state during crash
792 // 1. we hold their binder
793 sp<IBinderRpcSession> session;
794 EXPECT_OK(proc.rootIface->openSession("happy", &session));
795 // 2. they hold our binder
796 sp<IBinder> binder = new BBinder();
797 EXPECT_OK(proc.rootIface->holdBinder(binder));
798
799 EXPECT_EQ(DEAD_OBJECT, proc.rootIface->die(doDeathCleanup).transactionError())
800 << "Do death cleanup: " << doDeathCleanup;
801
Andrei Homescu96834632022-10-14 00:49:49 +0000802 proc.proc->setCustomExitStatusCheck([](int wstatus) {
Frederick Maylea12b0962022-06-25 01:13:22 +0000803 EXPECT_TRUE(WIFEXITED(wstatus) && WEXITSTATUS(wstatus) == 1)
804 << "server process failed incorrectly: " << WaitStatusToString(wstatus);
805 });
Steven Morelandaf4ca712021-05-24 23:22:08 +0000806 proc.expectAlreadyShutdown = true;
Steven Moreland5553ac42020-11-11 02:14:45 +0000807 }
808}
809
Steven Morelandd7302072021-05-15 01:32:04 +0000810TEST_P(BinderRpc, UseKernelBinderCallingId) {
Andrei Homescu2a298012022-06-15 01:08:54 +0000811 // This test only works if the current process shared the internal state of
812 // ProcessState with the service across the call to fork(). Both the static
813 // libraries and libbinder.so have their own separate copies of all the
814 // globals, so the test only works when the test client and service both use
815 // libbinder.so (when using static libraries, even a client and service
816 // using the same kind of static library should have separate copies of the
817 // variables).
Andrei Homescua858b0e2022-08-01 23:43:09 +0000818 if (!kEnableSharedLibs || serverSingleThreaded() || noKernel()) {
Andrei Homescu12106de2022-04-27 04:42:21 +0000819 GTEST_SKIP() << "Test disabled because Binder kernel driver was disabled "
820 "at build time.";
821 }
822
Steven Moreland4313d7e2021-07-15 23:41:22 +0000823 auto proc = createRpcTestSocketServerProcess({});
Steven Morelandd7302072021-05-15 01:32:04 +0000824
Andrei Homescu2a298012022-06-15 01:08:54 +0000825 // we can't allocate IPCThreadState so actually the first time should
826 // succeed :(
827 EXPECT_OK(proc.rootIface->useKernelBinderCallingId());
Steven Morelandd7302072021-05-15 01:32:04 +0000828
829 // second time! we catch the error :)
830 EXPECT_EQ(DEAD_OBJECT, proc.rootIface->useKernelBinderCallingId().transactionError());
831
Andrei Homescu96834632022-10-14 00:49:49 +0000832 proc.proc->setCustomExitStatusCheck([](int wstatus) {
Frederick Maylea12b0962022-06-25 01:13:22 +0000833 EXPECT_TRUE(WIFSIGNALED(wstatus) && WTERMSIG(wstatus) == SIGABRT)
834 << "server process failed incorrectly: " << WaitStatusToString(wstatus);
835 });
Steven Morelandaf4ca712021-05-24 23:22:08 +0000836 proc.expectAlreadyShutdown = true;
Steven Morelandd7302072021-05-15 01:32:04 +0000837}
838
Frederick Mayle69a0c992022-05-26 20:38:39 +0000839TEST_P(BinderRpc, FileDescriptorTransportRejectNone) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000840 if (socketType() == SocketType::TIPC) {
841 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
842 }
843
Frederick Mayle69a0c992022-05-26 20:38:39 +0000844 auto proc = createRpcTestSocketServerProcess({
845 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::NONE,
846 .serverSupportedFileDescriptorTransportModes =
847 {RpcSession::FileDescriptorTransportMode::UNIX},
848 .allowConnectFailure = true,
849 });
Andrei Homescu96834632022-10-14 00:49:49 +0000850 EXPECT_TRUE(proc.proc->sessions.empty()) << "session connections should have failed";
851 proc.proc->terminate();
852 proc.proc->setCustomExitStatusCheck([](int wstatus) {
Frederick Mayle69a0c992022-05-26 20:38:39 +0000853 EXPECT_TRUE(WIFSIGNALED(wstatus) && WTERMSIG(wstatus) == SIGTERM)
854 << "server process failed incorrectly: " << WaitStatusToString(wstatus);
855 });
856 proc.expectAlreadyShutdown = true;
857}
858
859TEST_P(BinderRpc, FileDescriptorTransportRejectUnix) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000860 if (socketType() == SocketType::TIPC) {
861 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
862 }
863
Frederick Mayle69a0c992022-05-26 20:38:39 +0000864 auto proc = createRpcTestSocketServerProcess({
865 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
866 .serverSupportedFileDescriptorTransportModes =
867 {RpcSession::FileDescriptorTransportMode::NONE},
868 .allowConnectFailure = true,
869 });
Andrei Homescu96834632022-10-14 00:49:49 +0000870 EXPECT_TRUE(proc.proc->sessions.empty()) << "session connections should have failed";
871 proc.proc->terminate();
872 proc.proc->setCustomExitStatusCheck([](int wstatus) {
Frederick Mayle69a0c992022-05-26 20:38:39 +0000873 EXPECT_TRUE(WIFSIGNALED(wstatus) && WTERMSIG(wstatus) == SIGTERM)
874 << "server process failed incorrectly: " << WaitStatusToString(wstatus);
875 });
876 proc.expectAlreadyShutdown = true;
877}
878
879TEST_P(BinderRpc, FileDescriptorTransportOptionalUnix) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000880 if (socketType() == SocketType::TIPC) {
881 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
882 }
883
Frederick Mayle69a0c992022-05-26 20:38:39 +0000884 auto proc = createRpcTestSocketServerProcess({
885 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::NONE,
886 .serverSupportedFileDescriptorTransportModes =
887 {RpcSession::FileDescriptorTransportMode::NONE,
888 RpcSession::FileDescriptorTransportMode::UNIX},
889 });
890
891 android::os::ParcelFileDescriptor out;
892 auto status = proc.rootIface->echoAsFile("hello", &out);
893 EXPECT_EQ(status.transactionError(), FDS_NOT_ALLOWED) << status;
894}
895
896TEST_P(BinderRpc, ReceiveFile) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000897 if (socketType() == SocketType::TIPC) {
898 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
899 }
900
Frederick Mayle69a0c992022-05-26 20:38:39 +0000901 auto proc = createRpcTestSocketServerProcess({
902 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
903 .serverSupportedFileDescriptorTransportModes =
904 {RpcSession::FileDescriptorTransportMode::UNIX},
905 });
906
907 android::os::ParcelFileDescriptor out;
908 auto status = proc.rootIface->echoAsFile("hello", &out);
909 if (!supportsFdTransport()) {
910 EXPECT_EQ(status.transactionError(), BAD_VALUE) << status;
911 return;
912 }
913 ASSERT_TRUE(status.isOk()) << status;
914
915 std::string result;
916 CHECK(android::base::ReadFdToString(out.get(), &result));
917 EXPECT_EQ(result, "hello");
918}
919
920TEST_P(BinderRpc, SendFiles) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000921 if (socketType() == SocketType::TIPC) {
922 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
923 }
924
Frederick Mayle69a0c992022-05-26 20:38:39 +0000925 auto proc = createRpcTestSocketServerProcess({
926 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
927 .serverSupportedFileDescriptorTransportModes =
928 {RpcSession::FileDescriptorTransportMode::UNIX},
929 });
930
931 std::vector<android::os::ParcelFileDescriptor> files;
932 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("123")));
933 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("a")));
934 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("b")));
935 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("cd")));
936
937 android::os::ParcelFileDescriptor out;
938 auto status = proc.rootIface->concatFiles(files, &out);
939 if (!supportsFdTransport()) {
940 EXPECT_EQ(status.transactionError(), BAD_VALUE) << status;
941 return;
942 }
943 ASSERT_TRUE(status.isOk()) << status;
944
945 std::string result;
946 CHECK(android::base::ReadFdToString(out.get(), &result));
947 EXPECT_EQ(result, "123abcd");
948}
949
950TEST_P(BinderRpc, SendMaxFiles) {
951 if (!supportsFdTransport()) {
952 GTEST_SKIP() << "Would fail trivially (which is tested by BinderRpc::SendFiles)";
953 }
954
955 auto proc = createRpcTestSocketServerProcess({
956 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
957 .serverSupportedFileDescriptorTransportModes =
958 {RpcSession::FileDescriptorTransportMode::UNIX},
959 });
960
961 std::vector<android::os::ParcelFileDescriptor> files;
962 for (int i = 0; i < 253; i++) {
963 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("a")));
964 }
965
966 android::os::ParcelFileDescriptor out;
967 auto status = proc.rootIface->concatFiles(files, &out);
968 ASSERT_TRUE(status.isOk()) << status;
969
970 std::string result;
971 CHECK(android::base::ReadFdToString(out.get(), &result));
972 EXPECT_EQ(result, std::string(253, 'a'));
973}
974
975TEST_P(BinderRpc, SendTooManyFiles) {
976 if (!supportsFdTransport()) {
977 GTEST_SKIP() << "Would fail trivially (which is tested by BinderRpc::SendFiles)";
978 }
979
980 auto proc = createRpcTestSocketServerProcess({
981 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
982 .serverSupportedFileDescriptorTransportModes =
983 {RpcSession::FileDescriptorTransportMode::UNIX},
984 });
985
986 std::vector<android::os::ParcelFileDescriptor> files;
987 for (int i = 0; i < 254; i++) {
988 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("a")));
989 }
990
991 android::os::ParcelFileDescriptor out;
992 auto status = proc.rootIface->concatFiles(files, &out);
993 EXPECT_EQ(status.transactionError(), BAD_VALUE) << status;
994}
995
Andrei Homescufc221502022-10-08 03:51:17 +0000996TEST_P(BinderRpc, AppendInvalidFd) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000997 if (socketType() == SocketType::TIPC) {
998 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
999 }
1000
Andrei Homescufc221502022-10-08 03:51:17 +00001001 auto proc = createRpcTestSocketServerProcess({
1002 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
1003 .serverSupportedFileDescriptorTransportModes =
1004 {RpcSession::FileDescriptorTransportMode::UNIX},
1005 });
1006
1007 int badFd = fcntl(STDERR_FILENO, F_DUPFD_CLOEXEC, 0);
1008 ASSERT_NE(badFd, -1);
1009
1010 // Close the file descriptor so it becomes invalid for dup
1011 close(badFd);
1012
1013 Parcel p1;
1014 p1.markForBinder(proc.rootBinder);
1015 p1.writeInt32(3);
1016 EXPECT_EQ(OK, p1.writeFileDescriptor(badFd, false));
1017
1018 Parcel pRaw;
1019 pRaw.markForBinder(proc.rootBinder);
1020 EXPECT_EQ(OK, pRaw.appendFrom(&p1, 0, p1.dataSize()));
1021
1022 pRaw.setDataPosition(0);
1023 EXPECT_EQ(3, pRaw.readInt32());
1024 ASSERT_EQ(-1, pRaw.readFileDescriptor());
1025}
1026
Andrei Homescu68a55612022-08-02 01:25:15 +00001027#ifndef __ANDROID_VENDOR__ // No AIBinder_fromPlatformBinder on vendor
Steven Moreland37aff182021-03-26 02:04:16 +00001028TEST_P(BinderRpc, WorksWithLibbinderNdkPing) {
Andrei Homescu12106de2022-04-27 04:42:21 +00001029 if constexpr (!kEnableSharedLibs) {
1030 GTEST_SKIP() << "Test disabled because Binder was built as a static library";
1031 }
1032
Steven Moreland4313d7e2021-07-15 23:41:22 +00001033 auto proc = createRpcTestSocketServerProcess({});
Steven Moreland37aff182021-03-26 02:04:16 +00001034
1035 ndk::SpAIBinder binder = ndk::SpAIBinder(AIBinder_fromPlatformBinder(proc.rootBinder));
1036 ASSERT_NE(binder, nullptr);
1037
1038 ASSERT_EQ(STATUS_OK, AIBinder_ping(binder.get()));
1039}
1040
1041TEST_P(BinderRpc, WorksWithLibbinderNdkUserTransaction) {
Andrei Homescu12106de2022-04-27 04:42:21 +00001042 if constexpr (!kEnableSharedLibs) {
1043 GTEST_SKIP() << "Test disabled because Binder was built as a static library";
1044 }
1045
Steven Moreland4313d7e2021-07-15 23:41:22 +00001046 auto proc = createRpcTestSocketServerProcess({});
Steven Moreland37aff182021-03-26 02:04:16 +00001047
1048 ndk::SpAIBinder binder = ndk::SpAIBinder(AIBinder_fromPlatformBinder(proc.rootBinder));
1049 ASSERT_NE(binder, nullptr);
1050
1051 auto ndkBinder = aidl::IBinderRpcTest::fromBinder(binder);
1052 ASSERT_NE(ndkBinder, nullptr);
1053
1054 std::string out;
1055 ndk::ScopedAStatus status = ndkBinder->doubleString("aoeu", &out);
1056 ASSERT_TRUE(status.isOk()) << status.getDescription();
1057 ASSERT_EQ("aoeuaoeu", out);
1058}
Andrei Homescu68a55612022-08-02 01:25:15 +00001059#endif // __ANDROID_VENDOR__
Steven Moreland37aff182021-03-26 02:04:16 +00001060
Steven Moreland5553ac42020-11-11 02:14:45 +00001061ssize_t countFds() {
1062 DIR* dir = opendir("/proc/self/fd/");
1063 if (dir == nullptr) return -1;
1064 ssize_t ret = 0;
1065 dirent* ent;
1066 while ((ent = readdir(dir)) != nullptr) ret++;
1067 closedir(dir);
1068 return ret;
1069}
1070
Andrei Homescua858b0e2022-08-01 23:43:09 +00001071TEST_P(BinderRpc, Fds) {
1072 if (serverSingleThreaded()) {
1073 GTEST_SKIP() << "This test requires multiple threads";
1074 }
Andrei Homescu68a55612022-08-02 01:25:15 +00001075 if (socketType() == SocketType::TIPC) {
1076 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
1077 }
Andrei Homescua858b0e2022-08-01 23:43:09 +00001078
Steven Moreland5553ac42020-11-11 02:14:45 +00001079 ssize_t beforeFds = countFds();
1080 ASSERT_GE(beforeFds, 0);
1081 {
Steven Moreland4313d7e2021-07-15 23:41:22 +00001082 auto proc = createRpcTestSocketServerProcess({.numThreads = 10});
Steven Moreland5553ac42020-11-11 02:14:45 +00001083 ASSERT_EQ(OK, proc.rootBinder->pingBinder());
1084 }
1085 ASSERT_EQ(beforeFds, countFds()) << (system("ls -l /proc/self/fd/"), "fd leak?");
1086}
1087
Steven Morelandda573042021-06-12 01:13:45 +00001088static bool testSupportVsockLoopback() {
Yifan Hong702115c2021-06-24 15:39:18 -07001089 // We don't need to enable TLS to know if vsock is supported.
Steven Morelandda573042021-06-12 01:13:45 +00001090 unsigned int vsockPort = allocateVsockPort();
Steven Morelandda573042021-06-12 01:13:45 +00001091
Andrei Homescu992a4052022-06-28 21:26:18 +00001092 android::base::unique_fd serverFd(
1093 TEMP_FAILURE_RETRY(socket(AF_VSOCK, SOCK_STREAM | SOCK_CLOEXEC | SOCK_NONBLOCK, 0)));
1094 LOG_ALWAYS_FATAL_IF(serverFd == -1, "Could not create socket: %s", strerror(errno));
1095
1096 sockaddr_vm serverAddr{
1097 .svm_family = AF_VSOCK,
1098 .svm_port = vsockPort,
1099 .svm_cid = VMADDR_CID_ANY,
1100 };
1101 int ret = TEMP_FAILURE_RETRY(
1102 bind(serverFd.get(), reinterpret_cast<sockaddr*>(&serverAddr), sizeof(serverAddr)));
1103 LOG_ALWAYS_FATAL_IF(0 != ret, "Could not bind socket to port %u: %s", vsockPort,
1104 strerror(errno));
1105
1106 ret = TEMP_FAILURE_RETRY(listen(serverFd.get(), 1 /*backlog*/));
1107 LOG_ALWAYS_FATAL_IF(0 != ret, "Could not listen socket on port %u: %s", vsockPort,
1108 strerror(errno));
1109
1110 // Try to connect to the server using the VMADDR_CID_LOCAL cid
1111 // to see if the kernel supports it. It's safe to use a blocking
1112 // connect because vsock sockets have a 2 second connection timeout,
1113 // and they return ETIMEDOUT after that.
1114 android::base::unique_fd connectFd(
1115 TEMP_FAILURE_RETRY(socket(AF_VSOCK, SOCK_STREAM | SOCK_CLOEXEC | SOCK_NONBLOCK, 0)));
1116 LOG_ALWAYS_FATAL_IF(connectFd == -1, "Could not create socket for port %u: %s", vsockPort,
1117 strerror(errno));
1118
1119 bool success = false;
1120 sockaddr_vm connectAddr{
1121 .svm_family = AF_VSOCK,
1122 .svm_port = vsockPort,
1123 .svm_cid = VMADDR_CID_LOCAL,
1124 };
1125 ret = TEMP_FAILURE_RETRY(connect(connectFd.get(), reinterpret_cast<sockaddr*>(&connectAddr),
1126 sizeof(connectAddr)));
1127 if (ret != 0 && (errno == EAGAIN || errno == EINPROGRESS)) {
1128 android::base::unique_fd acceptFd;
1129 while (true) {
1130 pollfd pfd[]{
1131 {.fd = serverFd.get(), .events = POLLIN, .revents = 0},
1132 {.fd = connectFd.get(), .events = POLLOUT, .revents = 0},
1133 };
1134 ret = TEMP_FAILURE_RETRY(poll(pfd, arraysize(pfd), -1));
1135 LOG_ALWAYS_FATAL_IF(ret < 0, "Error polling: %s", strerror(errno));
1136
1137 if (pfd[0].revents & POLLIN) {
1138 sockaddr_vm acceptAddr;
1139 socklen_t acceptAddrLen = sizeof(acceptAddr);
1140 ret = TEMP_FAILURE_RETRY(accept4(serverFd.get(),
1141 reinterpret_cast<sockaddr*>(&acceptAddr),
1142 &acceptAddrLen, SOCK_CLOEXEC));
1143 LOG_ALWAYS_FATAL_IF(ret < 0, "Could not accept4 socket: %s", strerror(errno));
1144 LOG_ALWAYS_FATAL_IF(acceptAddrLen != static_cast<socklen_t>(sizeof(acceptAddr)),
1145 "Truncated address");
1146
1147 // Store the fd in acceptFd so we keep the connection alive
1148 // while polling connectFd
1149 acceptFd.reset(ret);
1150 }
1151
1152 if (pfd[1].revents & POLLOUT) {
1153 // Connect either succeeded or timed out
1154 int connectErrno;
1155 socklen_t connectErrnoLen = sizeof(connectErrno);
1156 int ret = getsockopt(connectFd.get(), SOL_SOCKET, SO_ERROR, &connectErrno,
1157 &connectErrnoLen);
1158 LOG_ALWAYS_FATAL_IF(ret == -1,
1159 "Could not getsockopt() after connect() "
1160 "on non-blocking socket: %s.",
1161 strerror(errno));
1162
1163 // We're done, this is all we wanted
1164 success = connectErrno == 0;
1165 break;
1166 }
1167 }
1168 } else {
1169 success = ret == 0;
1170 }
1171
1172 ALOGE("Detected vsock loopback supported: %s", success ? "yes" : "no");
1173
1174 return success;
Steven Morelandda573042021-06-12 01:13:45 +00001175}
1176
Yifan Hong1deca4b2021-09-10 16:16:44 -07001177static std::vector<SocketType> testSocketTypes(bool hasPreconnected = true) {
Alice Wang893a9912022-10-24 10:44:09 +00001178 std::vector<SocketType> ret = {SocketType::UNIX, SocketType::UNIX_BOOTSTRAP, SocketType::INET,
1179 SocketType::UNIX_RAW};
Yifan Hong1deca4b2021-09-10 16:16:44 -07001180
1181 if (hasPreconnected) ret.push_back(SocketType::PRECONNECTED);
Steven Morelandda573042021-06-12 01:13:45 +00001182
1183 static bool hasVsockLoopback = testSupportVsockLoopback();
1184
1185 if (hasVsockLoopback) {
1186 ret.push_back(SocketType::VSOCK);
1187 }
1188
1189 return ret;
1190}
1191
Andrei Homescu68a55612022-08-02 01:25:15 +00001192static std::vector<SocketType> testTipcSocketTypes() {
1193#ifdef __ANDROID_VENDOR__
1194 auto port = trustyIpcPort(RPC_WIRE_PROTOCOL_VERSION_EXPERIMENTAL);
1195 int tipcFd = tipc_connect(kTrustyIpcDevice, port.c_str());
1196 if (tipcFd >= 0) {
1197 close(tipcFd);
1198 return {SocketType::TIPC};
1199 }
1200#endif // __ANDROID_VENDOR__
1201
1202 // TIPC is not supported on this device, most likely
1203 // because /dev/trusty-ipc-dev0 is missing
1204 return {};
1205}
1206
Yifan Hong702115c2021-06-24 15:39:18 -07001207INSTANTIATE_TEST_CASE_P(PerSocket, BinderRpc,
1208 ::testing::Combine(::testing::ValuesIn(testSocketTypes()),
Frederick Mayledc07cf82022-05-26 20:30:12 +00001209 ::testing::ValuesIn(RpcSecurityValues()),
1210 ::testing::ValuesIn(testVersions()),
Andrei Homescu2a298012022-06-15 01:08:54 +00001211 ::testing::ValuesIn(testVersions()),
1212 ::testing::Values(false, true),
1213 ::testing::Values(false, true)),
Yifan Hong702115c2021-06-24 15:39:18 -07001214 BinderRpc::PrintParamInfo);
Steven Morelandc1635952021-04-01 16:20:47 +00001215
Andrei Homescu68a55612022-08-02 01:25:15 +00001216INSTANTIATE_TEST_CASE_P(Trusty, BinderRpc,
1217 ::testing::Combine(::testing::ValuesIn(testTipcSocketTypes()),
1218 ::testing::Values(RpcSecurity::RAW),
1219 ::testing::ValuesIn(testVersions()),
1220 ::testing::ValuesIn(testVersions()),
1221 ::testing::Values(true), ::testing::Values(true)),
1222 BinderRpc::PrintParamInfo);
1223
Yifan Hong702115c2021-06-24 15:39:18 -07001224class BinderRpcServerRootObject
1225 : public ::testing::TestWithParam<std::tuple<bool, bool, RpcSecurity>> {};
Yifan Hong4ffb0c72021-05-07 18:35:14 -07001226
1227TEST_P(BinderRpcServerRootObject, WeakRootObject) {
1228 using SetFn = std::function<void(RpcServer*, sp<IBinder>)>;
1229 auto setRootObject = [](bool isStrong) -> SetFn {
1230 return isStrong ? SetFn(&RpcServer::setRootObject) : SetFn(&RpcServer::setRootObjectWeak);
1231 };
1232
Yifan Hong702115c2021-06-24 15:39:18 -07001233 auto [isStrong1, isStrong2, rpcSecurity] = GetParam();
1234 auto server = RpcServer::make(newFactory(rpcSecurity));
Yifan Hong4ffb0c72021-05-07 18:35:14 -07001235 auto binder1 = sp<BBinder>::make();
1236 IBinder* binderRaw1 = binder1.get();
1237 setRootObject(isStrong1)(server.get(), binder1);
1238 EXPECT_EQ(binderRaw1, server->getRootObject());
1239 binder1.clear();
1240 EXPECT_EQ((isStrong1 ? binderRaw1 : nullptr), server->getRootObject());
1241
1242 auto binder2 = sp<BBinder>::make();
1243 IBinder* binderRaw2 = binder2.get();
1244 setRootObject(isStrong2)(server.get(), binder2);
1245 EXPECT_EQ(binderRaw2, server->getRootObject());
1246 binder2.clear();
1247 EXPECT_EQ((isStrong2 ? binderRaw2 : nullptr), server->getRootObject());
1248}
1249
1250INSTANTIATE_TEST_CASE_P(BinderRpc, BinderRpcServerRootObject,
Yifan Hong702115c2021-06-24 15:39:18 -07001251 ::testing::Combine(::testing::Bool(), ::testing::Bool(),
1252 ::testing::ValuesIn(RpcSecurityValues())));
Yifan Hong4ffb0c72021-05-07 18:35:14 -07001253
Yifan Hong1a235852021-05-13 16:07:47 -07001254class OneOffSignal {
1255public:
1256 // If notify() was previously called, or is called within |duration|, return true; else false.
1257 template <typename R, typename P>
1258 bool wait(std::chrono::duration<R, P> duration) {
1259 std::unique_lock<std::mutex> lock(mMutex);
1260 return mCv.wait_for(lock, duration, [this] { return mValue; });
1261 }
1262 void notify() {
1263 std::unique_lock<std::mutex> lock(mMutex);
1264 mValue = true;
1265 lock.unlock();
1266 mCv.notify_all();
1267 }
1268
1269private:
1270 std::mutex mMutex;
1271 std::condition_variable mCv;
1272 bool mValue = false;
1273};
1274
Yifan Hong194acf22021-06-29 18:44:56 -07001275TEST(BinderRpc, Java) {
1276#if !defined(__ANDROID__)
1277 GTEST_SKIP() << "This test is only run on Android. Though it can technically run on host on"
1278 "createRpcDelegateServiceManager() with a device attached, such test belongs "
1279 "to binderHostDeviceTest. Hence, just disable this test on host.";
1280#endif // !__ANDROID__
Andrei Homescu12106de2022-04-27 04:42:21 +00001281 if constexpr (!kEnableKernelIpc) {
1282 GTEST_SKIP() << "Test disabled because Binder kernel driver was disabled "
1283 "at build time.";
1284 }
1285
Yifan Hong194acf22021-06-29 18:44:56 -07001286 sp<IServiceManager> sm = defaultServiceManager();
1287 ASSERT_NE(nullptr, sm);
1288 // Any Java service with non-empty getInterfaceDescriptor() would do.
1289 // Let's pick batteryproperties.
1290 auto binder = sm->checkService(String16("batteryproperties"));
1291 ASSERT_NE(nullptr, binder);
1292 auto descriptor = binder->getInterfaceDescriptor();
1293 ASSERT_GE(descriptor.size(), 0);
1294 ASSERT_EQ(OK, binder->pingBinder());
1295
1296 auto rpcServer = RpcServer::make();
Yifan Hong194acf22021-06-29 18:44:56 -07001297 unsigned int port;
Steven Moreland2372f9d2021-08-05 15:42:01 -07001298 ASSERT_EQ(OK, rpcServer->setupInetServer(kLocalInetAddress, 0, &port));
Yifan Hong194acf22021-06-29 18:44:56 -07001299 auto socket = rpcServer->releaseServer();
1300
1301 auto keepAlive = sp<BBinder>::make();
Yifan Hongfe4b83f2021-11-08 16:29:53 -08001302 auto setRpcClientDebugStatus = binder->setRpcClientDebug(std::move(socket), keepAlive);
1303
Yifan Honge3caaf22022-01-12 14:46:56 -08001304 if (!android::base::GetBoolProperty("ro.debuggable", false) ||
1305 android::base::GetProperty("ro.build.type", "") == "user") {
Yifan Hongfe4b83f2021-11-08 16:29:53 -08001306 ASSERT_EQ(INVALID_OPERATION, setRpcClientDebugStatus)
Yifan Honge3caaf22022-01-12 14:46:56 -08001307 << "setRpcClientDebug should return INVALID_OPERATION on non-debuggable or user "
1308 "builds, but get "
Yifan Hongfe4b83f2021-11-08 16:29:53 -08001309 << statusToString(setRpcClientDebugStatus);
1310 GTEST_SKIP();
1311 }
1312
1313 ASSERT_EQ(OK, setRpcClientDebugStatus);
Yifan Hong194acf22021-06-29 18:44:56 -07001314
1315 auto rpcSession = RpcSession::make();
Steven Moreland2372f9d2021-08-05 15:42:01 -07001316 ASSERT_EQ(OK, rpcSession->setupInetClient("127.0.0.1", port));
Yifan Hong194acf22021-06-29 18:44:56 -07001317 auto rpcBinder = rpcSession->getRootObject();
1318 ASSERT_NE(nullptr, rpcBinder);
1319
1320 ASSERT_EQ(OK, rpcBinder->pingBinder());
1321
1322 ASSERT_EQ(descriptor, rpcBinder->getInterfaceDescriptor())
1323 << "getInterfaceDescriptor should not crash system_server";
1324 ASSERT_EQ(OK, rpcBinder->pingBinder());
1325}
1326
Andrei Homescu8d7f4bd2022-08-03 05:46:17 +00001327class BinderRpcServerOnly : public ::testing::TestWithParam<std::tuple<RpcSecurity, uint32_t>> {
1328public:
1329 static std::string PrintTestParam(const ::testing::TestParamInfo<ParamType>& info) {
1330 return std::string(newFactory(std::get<0>(info.param))->toCString()) + "_serverV" +
1331 std::to_string(std::get<1>(info.param));
1332 }
1333};
1334
1335TEST_P(BinderRpcServerOnly, SetExternalServerTest) {
1336 base::unique_fd sink(TEMP_FAILURE_RETRY(open("/dev/null", O_RDWR)));
1337 int sinkFd = sink.get();
1338 auto server = RpcServer::make(newFactory(std::get<0>(GetParam())));
1339 server->setProtocolVersion(std::get<1>(GetParam()));
1340 ASSERT_FALSE(server->hasServer());
1341 ASSERT_EQ(OK, server->setupExternalServer(std::move(sink)));
1342 ASSERT_TRUE(server->hasServer());
1343 base::unique_fd retrieved = server->releaseServer();
1344 ASSERT_FALSE(server->hasServer());
1345 ASSERT_EQ(sinkFd, retrieved.get());
1346}
1347
1348TEST_P(BinderRpcServerOnly, Shutdown) {
1349 if constexpr (!kEnableRpcThreads) {
1350 GTEST_SKIP() << "Test skipped because threads were disabled at build time";
1351 }
1352
1353 auto addr = allocateSocketAddress();
1354 auto server = RpcServer::make(newFactory(std::get<0>(GetParam())));
1355 server->setProtocolVersion(std::get<1>(GetParam()));
1356 ASSERT_EQ(OK, server->setupUnixDomainServer(addr.c_str()));
1357 auto joinEnds = std::make_shared<OneOffSignal>();
1358
1359 // If things are broken and the thread never stops, don't block other tests. Because the thread
1360 // may run after the test finishes, it must not access the stack memory of the test. Hence,
1361 // shared pointers are passed.
1362 std::thread([server, joinEnds] {
1363 server->join();
1364 joinEnds->notify();
1365 }).detach();
1366
1367 bool shutdown = false;
1368 for (int i = 0; i < 10 && !shutdown; i++) {
Steven Morelanddd231e22022-09-08 19:47:49 +00001369 usleep(30 * 1000); // 30ms; total 300ms
Andrei Homescu8d7f4bd2022-08-03 05:46:17 +00001370 if (server->shutdown()) shutdown = true;
1371 }
1372 ASSERT_TRUE(shutdown) << "server->shutdown() never returns true";
1373
1374 ASSERT_TRUE(joinEnds->wait(2s))
1375 << "After server->shutdown() returns true, join() did not stop after 2s";
1376}
1377
Frederick Mayledc07cf82022-05-26 20:30:12 +00001378INSTANTIATE_TEST_CASE_P(BinderRpc, BinderRpcServerOnly,
1379 ::testing::Combine(::testing::ValuesIn(RpcSecurityValues()),
1380 ::testing::ValuesIn(testVersions())),
1381 BinderRpcServerOnly::PrintTestParam);
Yifan Hong702115c2021-06-24 15:39:18 -07001382
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001383class RpcTransportTestUtils {
Yifan Hong1deca4b2021-09-10 16:16:44 -07001384public:
Frederick Mayledc07cf82022-05-26 20:30:12 +00001385 // Only parameterized only server version because `RpcSession` is bypassed
1386 // in the client half of the tests.
1387 using Param =
1388 std::tuple<SocketType, RpcSecurity, std::optional<RpcCertificateFormat>, uint32_t>;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001389 using ConnectToServer = std::function<base::unique_fd()>;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001390
1391 // A server that handles client socket connections.
1392 class Server {
1393 public:
David Brazdil21c887c2022-09-23 12:25:18 +01001394 using AcceptConnection = std::function<base::unique_fd(Server*)>;
1395
Yifan Hong1deca4b2021-09-10 16:16:44 -07001396 explicit Server() {}
1397 Server(Server&&) = default;
Yifan Honge07d2732021-09-13 21:59:14 -07001398 ~Server() { shutdownAndWait(); }
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001399 [[nodiscard]] AssertionResult setUp(
1400 const Param& param,
1401 std::unique_ptr<RpcAuth> auth = std::make_unique<RpcAuthSelfSigned>()) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001402 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = param;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001403 auto rpcServer = RpcServer::make(newFactory(rpcSecurity));
Frederick Mayledc07cf82022-05-26 20:30:12 +00001404 rpcServer->setProtocolVersion(serverVersion);
Yifan Hong1deca4b2021-09-10 16:16:44 -07001405 switch (socketType) {
1406 case SocketType::PRECONNECTED: {
1407 return AssertionFailure() << "Not supported by this test";
1408 } break;
1409 case SocketType::UNIX: {
1410 auto addr = allocateSocketAddress();
1411 auto status = rpcServer->setupUnixDomainServer(addr.c_str());
1412 if (status != OK) {
1413 return AssertionFailure()
1414 << "setupUnixDomainServer: " << statusToString(status);
1415 }
1416 mConnectToServer = [addr] {
1417 return connectTo(UnixSocketAddress(addr.c_str()));
1418 };
1419 } break;
David Brazdil21c887c2022-09-23 12:25:18 +01001420 case SocketType::UNIX_BOOTSTRAP: {
1421 base::unique_fd bootstrapFdClient, bootstrapFdServer;
1422 if (!base::Socketpair(SOCK_STREAM, &bootstrapFdClient, &bootstrapFdServer)) {
1423 return AssertionFailure() << "Socketpair() failed";
1424 }
1425 auto status = rpcServer->setupUnixDomainSocketBootstrapServer(
1426 std::move(bootstrapFdServer));
1427 if (status != OK) {
1428 return AssertionFailure() << "setupUnixDomainSocketBootstrapServer: "
1429 << statusToString(status);
1430 }
1431 mBootstrapSocket = RpcTransportFd(std::move(bootstrapFdClient));
1432 mAcceptConnection = &Server::recvmsgServerConnection;
1433 mConnectToServer = [this] { return connectToUnixBootstrap(mBootstrapSocket); };
1434 } break;
Alice Wang893a9912022-10-24 10:44:09 +00001435 case SocketType::UNIX_RAW: {
1436 auto addr = allocateSocketAddress();
1437 auto status = rpcServer->setupRawSocketServer(initUnixSocket(addr));
1438 if (status != OK) {
1439 return AssertionFailure()
1440 << "setupRawSocketServer: " << statusToString(status);
1441 }
1442 mConnectToServer = [addr] {
1443 return connectTo(UnixSocketAddress(addr.c_str()));
1444 };
1445 } break;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001446 case SocketType::VSOCK: {
1447 auto port = allocateVsockPort();
David Brazdila47dfda2022-11-22 22:52:19 +00001448 auto status = rpcServer->setupVsockServer(VMADDR_CID_LOCAL, port);
Yifan Hong1deca4b2021-09-10 16:16:44 -07001449 if (status != OK) {
1450 return AssertionFailure() << "setupVsockServer: " << statusToString(status);
1451 }
1452 mConnectToServer = [port] {
1453 return connectTo(VsockSocketAddress(VMADDR_CID_LOCAL, port));
1454 };
1455 } break;
1456 case SocketType::INET: {
1457 unsigned int port;
1458 auto status = rpcServer->setupInetServer(kLocalInetAddress, 0, &port);
1459 if (status != OK) {
1460 return AssertionFailure() << "setupInetServer: " << statusToString(status);
1461 }
1462 mConnectToServer = [port] {
1463 const char* addr = kLocalInetAddress;
1464 auto aiStart = InetSocketAddress::getAddrInfo(addr, port);
1465 if (aiStart == nullptr) return base::unique_fd{};
1466 for (auto ai = aiStart.get(); ai != nullptr; ai = ai->ai_next) {
1467 auto fd = connectTo(
1468 InetSocketAddress(ai->ai_addr, ai->ai_addrlen, addr, port));
1469 if (fd.ok()) return fd;
1470 }
1471 ALOGE("None of the socket address resolved for %s:%u can be connected",
1472 addr, port);
1473 return base::unique_fd{};
1474 };
Andrei Homescu68a55612022-08-02 01:25:15 +00001475 } break;
1476 case SocketType::TIPC: {
1477 LOG_ALWAYS_FATAL("RpcTransportTest should not be enabled for TIPC");
1478 } break;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001479 }
1480 mFd = rpcServer->releaseServer();
Pawan49d74cb2022-08-03 21:19:11 +00001481 if (!mFd.fd.ok()) return AssertionFailure() << "releaseServer returns invalid fd";
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001482 mCtx = newFactory(rpcSecurity, mCertVerifier, std::move(auth))->newServerCtx();
Yifan Hong1deca4b2021-09-10 16:16:44 -07001483 if (mCtx == nullptr) return AssertionFailure() << "newServerCtx";
1484 mSetup = true;
1485 return AssertionSuccess();
1486 }
1487 RpcTransportCtx* getCtx() const { return mCtx.get(); }
1488 std::shared_ptr<RpcCertificateVerifierSimple> getCertVerifier() const {
1489 return mCertVerifier;
1490 }
1491 ConnectToServer getConnectToServerFn() { return mConnectToServer; }
1492 void start() {
1493 LOG_ALWAYS_FATAL_IF(!mSetup, "Call Server::setup first!");
1494 mThread = std::make_unique<std::thread>(&Server::run, this);
1495 }
David Brazdil21c887c2022-09-23 12:25:18 +01001496
1497 base::unique_fd acceptServerConnection() {
1498 return base::unique_fd(TEMP_FAILURE_RETRY(
1499 accept4(mFd.fd.get(), nullptr, nullptr, SOCK_CLOEXEC | SOCK_NONBLOCK)));
1500 }
1501
1502 base::unique_fd recvmsgServerConnection() {
1503 std::vector<std::variant<base::unique_fd, base::borrowed_fd>> fds;
1504 int buf;
1505 iovec iov{&buf, sizeof(buf)};
1506
1507 if (receiveMessageFromSocket(mFd, &iov, 1, &fds) < 0) {
1508 int savedErrno = errno;
1509 LOG(FATAL) << "Failed receiveMessage: " << strerror(savedErrno);
1510 }
1511 if (fds.size() != 1) {
1512 LOG(FATAL) << "Expected one FD from receiveMessage(), got " << fds.size();
1513 }
1514 return std::move(std::get<base::unique_fd>(fds[0]));
1515 }
1516
Yifan Hong1deca4b2021-09-10 16:16:44 -07001517 void run() {
1518 LOG_ALWAYS_FATAL_IF(!mSetup, "Call Server::setup first!");
1519
1520 std::vector<std::thread> threads;
1521 while (OK == mFdTrigger->triggerablePoll(mFd, POLLIN)) {
David Brazdil21c887c2022-09-23 12:25:18 +01001522 base::unique_fd acceptedFd = mAcceptConnection(this);
Yifan Hong1deca4b2021-09-10 16:16:44 -07001523 threads.emplace_back(&Server::handleOne, this, std::move(acceptedFd));
1524 }
1525
1526 for (auto& thread : threads) thread.join();
1527 }
1528 void handleOne(android::base::unique_fd acceptedFd) {
1529 ASSERT_TRUE(acceptedFd.ok());
Pawan3e0061c2022-08-26 21:08:34 +00001530 RpcTransportFd transportFd(std::move(acceptedFd));
Pawan49d74cb2022-08-03 21:19:11 +00001531 auto serverTransport = mCtx->newTransport(std::move(transportFd), mFdTrigger.get());
Yifan Hong1deca4b2021-09-10 16:16:44 -07001532 if (serverTransport == nullptr) return; // handshake failed
Yifan Hong67519322021-09-13 18:51:16 -07001533 ASSERT_TRUE(mPostConnect(serverTransport.get(), mFdTrigger.get()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001534 }
Yifan Honge07d2732021-09-13 21:59:14 -07001535 void shutdownAndWait() {
Yifan Hong67519322021-09-13 18:51:16 -07001536 shutdown();
1537 join();
1538 }
1539 void shutdown() { mFdTrigger->trigger(); }
1540
1541 void setPostConnect(
1542 std::function<AssertionResult(RpcTransport*, FdTrigger* fdTrigger)> fn) {
1543 mPostConnect = std::move(fn);
Yifan Hong1deca4b2021-09-10 16:16:44 -07001544 }
1545
1546 private:
1547 std::unique_ptr<std::thread> mThread;
1548 ConnectToServer mConnectToServer;
David Brazdil21c887c2022-09-23 12:25:18 +01001549 AcceptConnection mAcceptConnection = &Server::acceptServerConnection;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001550 std::unique_ptr<FdTrigger> mFdTrigger = FdTrigger::make();
David Brazdil21c887c2022-09-23 12:25:18 +01001551 RpcTransportFd mFd, mBootstrapSocket;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001552 std::unique_ptr<RpcTransportCtx> mCtx;
1553 std::shared_ptr<RpcCertificateVerifierSimple> mCertVerifier =
1554 std::make_shared<RpcCertificateVerifierSimple>();
1555 bool mSetup = false;
Yifan Hong67519322021-09-13 18:51:16 -07001556 // The function invoked after connection and handshake. By default, it is
1557 // |defaultPostConnect| that sends |kMessage| to the client.
1558 std::function<AssertionResult(RpcTransport*, FdTrigger* fdTrigger)> mPostConnect =
1559 Server::defaultPostConnect;
1560
1561 void join() {
1562 if (mThread != nullptr) {
1563 mThread->join();
1564 mThread = nullptr;
1565 }
1566 }
1567
1568 static AssertionResult defaultPostConnect(RpcTransport* serverTransport,
1569 FdTrigger* fdTrigger) {
1570 std::string message(kMessage);
Andrei Homescua39e4ed2021-12-10 08:41:54 +00001571 iovec messageIov{message.data(), message.size()};
Devin Moore695368f2022-06-03 22:29:14 +00001572 auto status = serverTransport->interruptableWriteFully(fdTrigger, &messageIov, 1,
Frederick Mayle69a0c992022-05-26 20:38:39 +00001573 std::nullopt, nullptr);
Yifan Hong67519322021-09-13 18:51:16 -07001574 if (status != OK) return AssertionFailure() << statusToString(status);
1575 return AssertionSuccess();
1576 }
Yifan Hong1deca4b2021-09-10 16:16:44 -07001577 };
1578
1579 class Client {
1580 public:
1581 explicit Client(ConnectToServer connectToServer) : mConnectToServer(connectToServer) {}
1582 Client(Client&&) = default;
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001583 [[nodiscard]] AssertionResult setUp(const Param& param) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001584 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = param;
1585 (void)serverVersion;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001586 mFdTrigger = FdTrigger::make();
1587 mCtx = newFactory(rpcSecurity, mCertVerifier)->newClientCtx();
1588 if (mCtx == nullptr) return AssertionFailure() << "newClientCtx";
1589 return AssertionSuccess();
1590 }
1591 RpcTransportCtx* getCtx() const { return mCtx.get(); }
1592 std::shared_ptr<RpcCertificateVerifierSimple> getCertVerifier() const {
1593 return mCertVerifier;
1594 }
Yifan Hong67519322021-09-13 18:51:16 -07001595 // connect() and do handshake
1596 bool setUpTransport() {
1597 mFd = mConnectToServer();
Pawan49d74cb2022-08-03 21:19:11 +00001598 if (!mFd.fd.ok()) return AssertionFailure() << "Cannot connect to server";
Yifan Hong67519322021-09-13 18:51:16 -07001599 mClientTransport = mCtx->newTransport(std::move(mFd), mFdTrigger.get());
1600 return mClientTransport != nullptr;
1601 }
1602 AssertionResult readMessage(const std::string& expectedMessage = kMessage) {
1603 LOG_ALWAYS_FATAL_IF(mClientTransport == nullptr, "setUpTransport not called or failed");
1604 std::string readMessage(expectedMessage.size(), '\0');
Andrei Homescua39e4ed2021-12-10 08:41:54 +00001605 iovec readMessageIov{readMessage.data(), readMessage.size()};
Devin Moore695368f2022-06-03 22:29:14 +00001606 status_t readStatus =
1607 mClientTransport->interruptableReadFully(mFdTrigger.get(), &readMessageIov, 1,
Frederick Mayleffe9ac22022-06-30 02:07:36 +00001608 std::nullopt, nullptr);
Yifan Hong67519322021-09-13 18:51:16 -07001609 if (readStatus != OK) {
1610 return AssertionFailure() << statusToString(readStatus);
1611 }
1612 if (readMessage != expectedMessage) {
1613 return AssertionFailure()
1614 << "Expected " << expectedMessage << ", actual " << readMessage;
1615 }
1616 return AssertionSuccess();
1617 }
Yifan Hong1deca4b2021-09-10 16:16:44 -07001618 void run(bool handshakeOk = true, bool readOk = true) {
Yifan Hong67519322021-09-13 18:51:16 -07001619 if (!setUpTransport()) {
Yifan Hong1deca4b2021-09-10 16:16:44 -07001620 ASSERT_FALSE(handshakeOk) << "newTransport returns nullptr, but it shouldn't";
1621 return;
1622 }
1623 ASSERT_TRUE(handshakeOk) << "newTransport does not return nullptr, but it should";
Yifan Hong67519322021-09-13 18:51:16 -07001624 ASSERT_EQ(readOk, readMessage());
Yifan Hong1deca4b2021-09-10 16:16:44 -07001625 }
1626
Pawan49d74cb2022-08-03 21:19:11 +00001627 bool isTransportWaiting() { return mClientTransport->isWaiting(); }
1628
Yifan Hong1deca4b2021-09-10 16:16:44 -07001629 private:
1630 ConnectToServer mConnectToServer;
Pawan3e0061c2022-08-26 21:08:34 +00001631 RpcTransportFd mFd;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001632 std::unique_ptr<FdTrigger> mFdTrigger = FdTrigger::make();
1633 std::unique_ptr<RpcTransportCtx> mCtx;
1634 std::shared_ptr<RpcCertificateVerifierSimple> mCertVerifier =
1635 std::make_shared<RpcCertificateVerifierSimple>();
Yifan Hong67519322021-09-13 18:51:16 -07001636 std::unique_ptr<RpcTransport> mClientTransport;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001637 };
1638
1639 // Make A trust B.
1640 template <typename A, typename B>
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001641 static status_t trust(RpcSecurity rpcSecurity,
1642 std::optional<RpcCertificateFormat> certificateFormat, const A& a,
1643 const B& b) {
Yifan Hong1deca4b2021-09-10 16:16:44 -07001644 if (rpcSecurity != RpcSecurity::TLS) return OK;
Yifan Hong22211f82021-09-14 12:32:25 -07001645 LOG_ALWAYS_FATAL_IF(!certificateFormat.has_value());
1646 auto bCert = b->getCtx()->getCertificate(*certificateFormat);
1647 return a->getCertVerifier()->addTrustedPeerCertificate(*certificateFormat, bCert);
Yifan Hong1deca4b2021-09-10 16:16:44 -07001648 }
1649
1650 static constexpr const char* kMessage = "hello";
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001651};
1652
1653class RpcTransportTest : public testing::TestWithParam<RpcTransportTestUtils::Param> {
1654public:
1655 using Server = RpcTransportTestUtils::Server;
1656 using Client = RpcTransportTestUtils::Client;
1657 static inline std::string PrintParamInfo(const testing::TestParamInfo<ParamType>& info) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001658 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = info.param;
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001659 auto ret = PrintToString(socketType) + "_" + newFactory(rpcSecurity)->toCString();
1660 if (certificateFormat.has_value()) ret += "_" + PrintToString(*certificateFormat);
Frederick Mayledc07cf82022-05-26 20:30:12 +00001661 ret += "_serverV" + std::to_string(serverVersion);
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001662 return ret;
1663 }
1664 static std::vector<ParamType> getRpcTranportTestParams() {
1665 std::vector<ParamType> ret;
Frederick Mayledc07cf82022-05-26 20:30:12 +00001666 for (auto serverVersion : testVersions()) {
1667 for (auto socketType : testSocketTypes(false /* hasPreconnected */)) {
1668 for (auto rpcSecurity : RpcSecurityValues()) {
1669 switch (rpcSecurity) {
1670 case RpcSecurity::RAW: {
1671 ret.emplace_back(socketType, rpcSecurity, std::nullopt, serverVersion);
1672 } break;
1673 case RpcSecurity::TLS: {
1674 ret.emplace_back(socketType, rpcSecurity, RpcCertificateFormat::PEM,
1675 serverVersion);
1676 ret.emplace_back(socketType, rpcSecurity, RpcCertificateFormat::DER,
1677 serverVersion);
1678 } break;
1679 }
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001680 }
1681 }
1682 }
1683 return ret;
1684 }
1685 template <typename A, typename B>
1686 status_t trust(const A& a, const B& b) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001687 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = GetParam();
1688 (void)serverVersion;
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001689 return RpcTransportTestUtils::trust(rpcSecurity, certificateFormat, a, b);
1690 }
Andrei Homescu12106de2022-04-27 04:42:21 +00001691 void SetUp() override {
1692 if constexpr (!kEnableRpcThreads) {
1693 GTEST_SKIP() << "Test skipped because threads were disabled at build time";
1694 }
1695 }
Yifan Hong1deca4b2021-09-10 16:16:44 -07001696};
1697
1698TEST_P(RpcTransportTest, GoodCertificate) {
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001699 auto server = std::make_unique<Server>();
1700 ASSERT_TRUE(server->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001701
1702 Client client(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001703 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001704
1705 ASSERT_EQ(OK, trust(&client, server));
1706 ASSERT_EQ(OK, trust(server, &client));
1707
1708 server->start();
1709 client.run();
1710}
1711
1712TEST_P(RpcTransportTest, MultipleClients) {
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001713 auto server = std::make_unique<Server>();
1714 ASSERT_TRUE(server->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001715
1716 std::vector<Client> clients;
1717 for (int i = 0; i < 2; i++) {
1718 auto& client = clients.emplace_back(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001719 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001720 ASSERT_EQ(OK, trust(&client, server));
1721 ASSERT_EQ(OK, trust(server, &client));
1722 }
1723
1724 server->start();
1725 for (auto& client : clients) client.run();
1726}
1727
1728TEST_P(RpcTransportTest, UntrustedServer) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001729 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = GetParam();
1730 (void)serverVersion;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001731
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001732 auto untrustedServer = std::make_unique<Server>();
1733 ASSERT_TRUE(untrustedServer->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001734
1735 Client client(untrustedServer->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001736 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001737
1738 ASSERT_EQ(OK, trust(untrustedServer, &client));
1739
1740 untrustedServer->start();
1741
1742 // For TLS, this should reject the certificate. For RAW sockets, it should pass because
1743 // the client can't verify the server's identity.
1744 bool handshakeOk = rpcSecurity != RpcSecurity::TLS;
1745 client.run(handshakeOk);
1746}
1747TEST_P(RpcTransportTest, MaliciousServer) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001748 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = GetParam();
1749 (void)serverVersion;
1750
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001751 auto validServer = std::make_unique<Server>();
1752 ASSERT_TRUE(validServer->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001753
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001754 auto maliciousServer = std::make_unique<Server>();
1755 ASSERT_TRUE(maliciousServer->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001756
1757 Client client(maliciousServer->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001758 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001759
1760 ASSERT_EQ(OK, trust(&client, validServer));
1761 ASSERT_EQ(OK, trust(validServer, &client));
1762 ASSERT_EQ(OK, trust(maliciousServer, &client));
1763
1764 maliciousServer->start();
1765
1766 // For TLS, this should reject the certificate. For RAW sockets, it should pass because
1767 // the client can't verify the server's identity.
1768 bool handshakeOk = rpcSecurity != RpcSecurity::TLS;
1769 client.run(handshakeOk);
1770}
1771
1772TEST_P(RpcTransportTest, UntrustedClient) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001773 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = GetParam();
1774 (void)serverVersion;
1775
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001776 auto server = std::make_unique<Server>();
1777 ASSERT_TRUE(server->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001778
1779 Client client(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001780 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001781
1782 ASSERT_EQ(OK, trust(&client, server));
1783
1784 server->start();
1785
1786 // For TLS, Client should be able to verify server's identity, so client should see
1787 // do_handshake() successfully executed. However, server shouldn't be able to verify client's
1788 // identity and should drop the connection, so client shouldn't be able to read anything.
1789 bool readOk = rpcSecurity != RpcSecurity::TLS;
1790 client.run(true, readOk);
1791}
1792
1793TEST_P(RpcTransportTest, MaliciousClient) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001794 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = GetParam();
1795 (void)serverVersion;
1796
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001797 auto server = std::make_unique<Server>();
1798 ASSERT_TRUE(server->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001799
1800 Client validClient(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001801 ASSERT_TRUE(validClient.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001802 Client maliciousClient(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001803 ASSERT_TRUE(maliciousClient.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001804
1805 ASSERT_EQ(OK, trust(&validClient, server));
1806 ASSERT_EQ(OK, trust(&maliciousClient, server));
1807
1808 server->start();
1809
1810 // See UntrustedClient.
1811 bool readOk = rpcSecurity != RpcSecurity::TLS;
1812 maliciousClient.run(true, readOk);
1813}
1814
Yifan Hong67519322021-09-13 18:51:16 -07001815TEST_P(RpcTransportTest, Trigger) {
1816 std::string msg2 = ", world!";
1817 std::mutex writeMutex;
1818 std::condition_variable writeCv;
1819 bool shouldContinueWriting = false;
1820 auto serverPostConnect = [&](RpcTransport* serverTransport, FdTrigger* fdTrigger) {
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001821 std::string message(RpcTransportTestUtils::kMessage);
Andrei Homescua39e4ed2021-12-10 08:41:54 +00001822 iovec messageIov{message.data(), message.size()};
Frederick Mayle69a0c992022-05-26 20:38:39 +00001823 auto status = serverTransport->interruptableWriteFully(fdTrigger, &messageIov, 1,
1824 std::nullopt, nullptr);
Yifan Hong67519322021-09-13 18:51:16 -07001825 if (status != OK) return AssertionFailure() << statusToString(status);
1826
1827 {
1828 std::unique_lock<std::mutex> lock(writeMutex);
1829 if (!writeCv.wait_for(lock, 3s, [&] { return shouldContinueWriting; })) {
1830 return AssertionFailure() << "write barrier not cleared in time!";
1831 }
1832 }
1833
Andrei Homescua39e4ed2021-12-10 08:41:54 +00001834 iovec msg2Iov{msg2.data(), msg2.size()};
Frederick Mayle69a0c992022-05-26 20:38:39 +00001835 status = serverTransport->interruptableWriteFully(fdTrigger, &msg2Iov, 1, std::nullopt,
1836 nullptr);
Steven Morelandc591b472021-09-16 13:56:11 -07001837 if (status != DEAD_OBJECT)
Yifan Hong67519322021-09-13 18:51:16 -07001838 return AssertionFailure() << "When FdTrigger is shut down, interruptableWriteFully "
Steven Morelandc591b472021-09-16 13:56:11 -07001839 "should return DEAD_OBJECT, but it is "
Yifan Hong67519322021-09-13 18:51:16 -07001840 << statusToString(status);
1841 return AssertionSuccess();
1842 };
1843
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001844 auto server = std::make_unique<Server>();
1845 ASSERT_TRUE(server->setUp(GetParam()));
Yifan Hong67519322021-09-13 18:51:16 -07001846
1847 // Set up client
1848 Client client(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001849 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong67519322021-09-13 18:51:16 -07001850
1851 // Exchange keys
1852 ASSERT_EQ(OK, trust(&client, server));
1853 ASSERT_EQ(OK, trust(server, &client));
1854
1855 server->setPostConnect(serverPostConnect);
1856
Yifan Hong67519322021-09-13 18:51:16 -07001857 server->start();
1858 // connect() to server and do handshake
1859 ASSERT_TRUE(client.setUpTransport());
Yifan Hong22211f82021-09-14 12:32:25 -07001860 // read the first message. This ensures that server has finished handshake and start handling
1861 // client fd. Server thread should pause at writeCv.wait_for().
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001862 ASSERT_TRUE(client.readMessage(RpcTransportTestUtils::kMessage));
Yifan Hong67519322021-09-13 18:51:16 -07001863 // Trigger server shutdown after server starts handling client FD. This ensures that the second
1864 // write is on an FdTrigger that has been shut down.
1865 server->shutdown();
1866 // Continues server thread to write the second message.
1867 {
Yifan Hong22211f82021-09-14 12:32:25 -07001868 std::lock_guard<std::mutex> lock(writeMutex);
Yifan Hong67519322021-09-13 18:51:16 -07001869 shouldContinueWriting = true;
Yifan Hong67519322021-09-13 18:51:16 -07001870 }
Yifan Hong22211f82021-09-14 12:32:25 -07001871 writeCv.notify_all();
Yifan Hong67519322021-09-13 18:51:16 -07001872 // After this line, server thread unblocks and attempts to write the second message, but
Steven Morelandc591b472021-09-16 13:56:11 -07001873 // shutdown is triggered, so write should failed with DEAD_OBJECT. See |serverPostConnect|.
Yifan Hong67519322021-09-13 18:51:16 -07001874 // On the client side, second read fails with DEAD_OBJECT
1875 ASSERT_FALSE(client.readMessage(msg2));
1876}
1877
Pawan49d74cb2022-08-03 21:19:11 +00001878TEST_P(RpcTransportTest, CheckWaitingForRead) {
1879 std::mutex readMutex;
1880 std::condition_variable readCv;
1881 bool shouldContinueReading = false;
1882 // Server will write data on transport once its started
1883 auto serverPostConnect = [&](RpcTransport* serverTransport, FdTrigger* fdTrigger) {
1884 std::string message(RpcTransportTestUtils::kMessage);
1885 iovec messageIov{message.data(), message.size()};
1886 auto status = serverTransport->interruptableWriteFully(fdTrigger, &messageIov, 1,
1887 std::nullopt, nullptr);
1888 if (status != OK) return AssertionFailure() << statusToString(status);
1889
1890 {
1891 std::unique_lock<std::mutex> lock(readMutex);
1892 shouldContinueReading = true;
1893 lock.unlock();
1894 readCv.notify_all();
1895 }
1896 return AssertionSuccess();
1897 };
1898
1899 // Setup Server and client
1900 auto server = std::make_unique<Server>();
1901 ASSERT_TRUE(server->setUp(GetParam()));
1902
1903 Client client(server->getConnectToServerFn());
1904 ASSERT_TRUE(client.setUp(GetParam()));
1905
1906 ASSERT_EQ(OK, trust(&client, server));
1907 ASSERT_EQ(OK, trust(server, &client));
1908 server->setPostConnect(serverPostConnect);
1909
1910 server->start();
1911 ASSERT_TRUE(client.setUpTransport());
1912 {
1913 // Wait till server writes data
1914 std::unique_lock<std::mutex> lock(readMutex);
1915 ASSERT_TRUE(readCv.wait_for(lock, 3s, [&] { return shouldContinueReading; }));
1916 }
1917
1918 // Since there is no read polling here, we will get polling count 0
1919 ASSERT_FALSE(client.isTransportWaiting());
1920 ASSERT_TRUE(client.readMessage(RpcTransportTestUtils::kMessage));
1921 // Thread should increment polling count, read and decrement polling count
1922 // Again, polling count should be zero here
1923 ASSERT_FALSE(client.isTransportWaiting());
1924
1925 server->shutdown();
1926}
1927
Yifan Hong1deca4b2021-09-10 16:16:44 -07001928INSTANTIATE_TEST_CASE_P(BinderRpc, RpcTransportTest,
Yifan Hong22211f82021-09-14 12:32:25 -07001929 ::testing::ValuesIn(RpcTransportTest::getRpcTranportTestParams()),
Yifan Hong1deca4b2021-09-10 16:16:44 -07001930 RpcTransportTest::PrintParamInfo);
1931
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001932class RpcTransportTlsKeyTest
Frederick Mayledc07cf82022-05-26 20:30:12 +00001933 : public testing::TestWithParam<
1934 std::tuple<SocketType, RpcCertificateFormat, RpcKeyFormat, uint32_t>> {
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001935public:
1936 template <typename A, typename B>
1937 status_t trust(const A& a, const B& b) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001938 auto [socketType, certificateFormat, keyFormat, serverVersion] = GetParam();
1939 (void)serverVersion;
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001940 return RpcTransportTestUtils::trust(RpcSecurity::TLS, certificateFormat, a, b);
1941 }
1942 static std::string PrintParamInfo(const testing::TestParamInfo<ParamType>& info) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001943 auto [socketType, certificateFormat, keyFormat, serverVersion] = info.param;
1944 return PrintToString(socketType) + "_certificate_" + PrintToString(certificateFormat) +
1945 "_key_" + PrintToString(keyFormat) + "_serverV" + std::to_string(serverVersion);
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001946 };
1947};
1948
1949TEST_P(RpcTransportTlsKeyTest, PreSignedCertificate) {
Andrei Homescu12106de2022-04-27 04:42:21 +00001950 if constexpr (!kEnableRpcThreads) {
1951 GTEST_SKIP() << "Test skipped because threads were disabled at build time";
1952 }
1953
Frederick Mayledc07cf82022-05-26 20:30:12 +00001954 auto [socketType, certificateFormat, keyFormat, serverVersion] = GetParam();
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001955
1956 std::vector<uint8_t> pkeyData, certData;
1957 {
1958 auto pkey = makeKeyPairForSelfSignedCert();
1959 ASSERT_NE(nullptr, pkey);
1960 auto cert = makeSelfSignedCert(pkey.get(), kCertValidSeconds);
1961 ASSERT_NE(nullptr, cert);
1962 pkeyData = serializeUnencryptedPrivatekey(pkey.get(), keyFormat);
1963 certData = serializeCertificate(cert.get(), certificateFormat);
1964 }
1965
1966 auto desPkey = deserializeUnencryptedPrivatekey(pkeyData, keyFormat);
1967 auto desCert = deserializeCertificate(certData, certificateFormat);
1968 auto auth = std::make_unique<RpcAuthPreSigned>(std::move(desPkey), std::move(desCert));
Frederick Mayledc07cf82022-05-26 20:30:12 +00001969 auto utilsParam = std::make_tuple(socketType, RpcSecurity::TLS,
1970 std::make_optional(certificateFormat), serverVersion);
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001971
1972 auto server = std::make_unique<RpcTransportTestUtils::Server>();
1973 ASSERT_TRUE(server->setUp(utilsParam, std::move(auth)));
1974
1975 RpcTransportTestUtils::Client client(server->getConnectToServerFn());
1976 ASSERT_TRUE(client.setUp(utilsParam));
1977
1978 ASSERT_EQ(OK, trust(&client, server));
1979 ASSERT_EQ(OK, trust(server, &client));
1980
1981 server->start();
1982 client.run();
1983}
1984
1985INSTANTIATE_TEST_CASE_P(
1986 BinderRpc, RpcTransportTlsKeyTest,
1987 testing::Combine(testing::ValuesIn(testSocketTypes(false /* hasPreconnected*/)),
1988 testing::Values(RpcCertificateFormat::PEM, RpcCertificateFormat::DER),
Frederick Mayledc07cf82022-05-26 20:30:12 +00001989 testing::Values(RpcKeyFormat::PEM, RpcKeyFormat::DER),
1990 testing::ValuesIn(testVersions())),
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001991 RpcTransportTlsKeyTest::PrintParamInfo);
1992
Steven Morelandc1635952021-04-01 16:20:47 +00001993} // namespace android
1994
1995int main(int argc, char** argv) {
Steven Moreland5553ac42020-11-11 02:14:45 +00001996 ::testing::InitGoogleTest(&argc, argv);
1997 android::base::InitLogging(argv, android::base::StderrLogger, android::base::DefaultAborter);
Steven Morelanda83191d2021-10-27 10:14:53 -07001998
Steven Moreland5553ac42020-11-11 02:14:45 +00001999 return RUN_ALL_TESTS();
2000}