blob: b86eb949281a79af066f393037062c7a079da3ae [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
Tomasz Wasilczyk38a22ee2023-10-19 20:04:46 +000017#ifndef __ANDROID_VENDOR__
18// only used on NDK tests outside of vendor
Andrei Homescu9d8adb12022-08-02 04:38:30 +000019#include <aidl/IBinderRpcTest.h>
Tomasz Wasilczyk38a22ee2023-10-19 20:04:46 +000020#endif
Steven Moreland5553ac42020-11-11 02:14:45 +000021
Steven Morelandc1635952021-04-01 16:20:47 +000022#include <chrono>
23#include <cstdlib>
24#include <iostream>
25#include <thread>
Steven Moreland659416d2021-05-11 00:47:50 +000026#include <type_traits>
Steven Morelandc1635952021-04-01 16:20:47 +000027
Andrei Homescu2a298012022-06-15 01:08:54 +000028#include <dlfcn.h>
Yifan Hong1deca4b2021-09-10 16:16:44 -070029#include <poll.h>
Steven Morelandc1635952021-04-01 16:20:47 +000030#include <sys/prctl.h>
Andrei Homescu992a4052022-06-28 21:26:18 +000031#include <sys/socket.h>
Steven Morelandc1635952021-04-01 16:20:47 +000032
Andrei Homescud65666d2023-03-03 07:28:02 +000033#ifdef BINDER_RPC_TO_TRUSTY_TEST
Andrei Homescu68a55612022-08-02 01:25:15 +000034#include <binder/RpcTransportTipcAndroid.h>
35#include <trusty/tipc.h>
Andrei Homescud65666d2023-03-03 07:28:02 +000036#endif // BINDER_RPC_TO_TRUSTY_TEST
Andrei Homescu68a55612022-08-02 01:25:15 +000037
Tomasz Wasilczyk657c2bc2023-11-07 06:57:42 -080038#include "../Utils.h"
Andrei Homescu2a298012022-06-15 01:08:54 +000039#include "binderRpcTestCommon.h"
Andrei Homescu96834632022-10-14 00:49:49 +000040#include "binderRpcTestFixture.h"
Steven Moreland5553ac42020-11-11 02:14:45 +000041
Yifan Hong1a235852021-05-13 16:07:47 -070042using namespace std::chrono_literals;
Yifan Hong67519322021-09-13 18:51:16 -070043using namespace std::placeholders;
Yifan Hong1deca4b2021-09-10 16:16:44 -070044using testing::AssertionFailure;
45using testing::AssertionResult;
46using testing::AssertionSuccess;
Yifan Hong1a235852021-05-13 16:07:47 -070047
Steven Moreland5553ac42020-11-11 02:14:45 +000048namespace android {
49
Andrei Homescu12106de2022-04-27 04:42:21 +000050#ifdef BINDER_TEST_NO_SHARED_LIBS
51constexpr bool kEnableSharedLibs = false;
52#else
53constexpr bool kEnableSharedLibs = true;
54#endif
55
Andrei Homescud65666d2023-03-03 07:28:02 +000056#ifdef BINDER_RPC_TO_TRUSTY_TEST
Andrei Homescu68a55612022-08-02 01:25:15 +000057constexpr char kTrustyIpcDevice[] = "/dev/trusty-ipc-dev0";
58#endif
59
Frederick Maylea12b0962022-06-25 01:13:22 +000060static std::string WaitStatusToString(int wstatus) {
61 if (WIFEXITED(wstatus)) {
Tomasz Wasilczyk3caae302023-10-12 20:57:02 +000062 return std::format("exit status {}", WEXITSTATUS(wstatus));
Frederick Maylea12b0962022-06-25 01:13:22 +000063 }
64 if (WIFSIGNALED(wstatus)) {
Tomasz Wasilczyk3caae302023-10-12 20:57:02 +000065 return std::format("term signal {}", WTERMSIG(wstatus));
Frederick Maylea12b0962022-06-25 01:13:22 +000066 }
Tomasz Wasilczyk3caae302023-10-12 20:57:02 +000067 return std::format("unexpected state {}", wstatus);
Frederick Maylea12b0962022-06-25 01:13:22 +000068}
69
Steven Moreland276d8df2022-09-28 23:56:39 +000070static void debugBacktrace(pid_t pid) {
71 std::cerr << "TAKING BACKTRACE FOR PID " << pid << std::endl;
72 system((std::string("debuggerd -b ") + std::to_string(pid)).c_str());
73}
74
Steven Moreland5553ac42020-11-11 02:14:45 +000075class Process {
76public:
Andrei Homescu96834632022-10-14 00:49:49 +000077 Process(Process&& other)
78 : mCustomExitStatusCheck(std::move(other.mCustomExitStatusCheck)),
79 mReadEnd(std::move(other.mReadEnd)),
80 mWriteEnd(std::move(other.mWriteEnd)) {
81 // The default move constructor doesn't clear mPid after moving it,
82 // which we need to do because the destructor checks for mPid!=0
83 mPid = other.mPid;
84 other.mPid = 0;
85 }
Yifan Hong1deca4b2021-09-10 16:16:44 -070086 Process(const std::function<void(android::base::borrowed_fd /* writeEnd */,
87 android::base::borrowed_fd /* readEnd */)>& f) {
88 android::base::unique_fd childWriteEnd;
89 android::base::unique_fd childReadEnd;
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -070090 if (!android::base::Pipe(&mReadEnd, &childWriteEnd, 0)) PLOGF("child write pipe failed");
91 if (!android::base::Pipe(&childReadEnd, &mWriteEnd, 0)) PLOGF("child read pipe failed");
Steven Moreland5553ac42020-11-11 02:14:45 +000092 if (0 == (mPid = fork())) {
93 // racey: assume parent doesn't crash before this is set
94 prctl(PR_SET_PDEATHSIG, SIGHUP);
95
Yifan Hong1deca4b2021-09-10 16:16:44 -070096 f(childWriteEnd, childReadEnd);
Steven Morelandaf4ca712021-05-24 23:22:08 +000097
98 exit(0);
Steven Moreland5553ac42020-11-11 02:14:45 +000099 }
100 }
101 ~Process() {
102 if (mPid != 0) {
Frederick Maylea12b0962022-06-25 01:13:22 +0000103 int wstatus;
104 waitpid(mPid, &wstatus, 0);
105 if (mCustomExitStatusCheck) {
106 mCustomExitStatusCheck(wstatus);
107 } else {
108 EXPECT_TRUE(WIFEXITED(wstatus) && WEXITSTATUS(wstatus) == 0)
109 << "server process failed: " << WaitStatusToString(wstatus);
110 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000111 }
112 }
Yifan Hong0f58fb92021-06-16 16:09:23 -0700113 android::base::borrowed_fd readEnd() { return mReadEnd; }
Yifan Hong1deca4b2021-09-10 16:16:44 -0700114 android::base::borrowed_fd writeEnd() { return mWriteEnd; }
Steven Moreland5553ac42020-11-11 02:14:45 +0000115
Frederick Maylea12b0962022-06-25 01:13:22 +0000116 void setCustomExitStatusCheck(std::function<void(int wstatus)> f) {
117 mCustomExitStatusCheck = std::move(f);
118 }
119
Frederick Mayle69a0c992022-05-26 20:38:39 +0000120 // Kill the process. Avoid if possible. Shutdown gracefully via an RPC instead.
121 void terminate() { kill(mPid, SIGTERM); }
122
Steven Moreland276d8df2022-09-28 23:56:39 +0000123 pid_t getPid() { return mPid; }
124
Steven Moreland5553ac42020-11-11 02:14:45 +0000125private:
Frederick Maylea12b0962022-06-25 01:13:22 +0000126 std::function<void(int wstatus)> mCustomExitStatusCheck;
Steven Moreland5553ac42020-11-11 02:14:45 +0000127 pid_t mPid = 0;
Yifan Hong0f58fb92021-06-16 16:09:23 -0700128 android::base::unique_fd mReadEnd;
Yifan Hong1deca4b2021-09-10 16:16:44 -0700129 android::base::unique_fd mWriteEnd;
Steven Moreland5553ac42020-11-11 02:14:45 +0000130};
131
132static std::string allocateSocketAddress() {
133 static size_t id = 0;
Steven Moreland4bfbf2e2021-04-14 22:15:16 +0000134 std::string temp = getenv("TMPDIR") ?: "/tmp";
Steven Morelanddfb05ad2023-03-07 17:00:53 +0000135 auto ret = temp + "/binderRpcTest_" + std::to_string(getpid()) + "_" + std::to_string(id++);
Yifan Hong1deca4b2021-09-10 16:16:44 -0700136 unlink(ret.c_str());
137 return ret;
Steven Moreland5553ac42020-11-11 02:14:45 +0000138};
139
Steven Morelandda573042021-06-12 01:13:45 +0000140static unsigned int allocateVsockPort() {
Andrei Homescu2a298012022-06-15 01:08:54 +0000141 static unsigned int vsockPort = 34567;
Steven Morelandda573042021-06-12 01:13:45 +0000142 return vsockPort++;
143}
144
Alice Wang893a9912022-10-24 10:44:09 +0000145static base::unique_fd initUnixSocket(std::string addr) {
146 auto socket_addr = UnixSocketAddress(addr.c_str());
147 base::unique_fd fd(
148 TEMP_FAILURE_RETRY(socket(socket_addr.addr()->sa_family, SOCK_STREAM, AF_UNIX)));
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -0700149 if (!fd.ok()) PLOGF("initUnixSocket failed to create socket");
150 if (0 != TEMP_FAILURE_RETRY(bind(fd.get(), socket_addr.addr(), socket_addr.addrSize()))) {
151 PLOGF("initUnixSocket failed to bind");
152 }
Alice Wang893a9912022-10-24 10:44:09 +0000153 return fd;
154}
155
Andrei Homescu96834632022-10-14 00:49:49 +0000156// Destructors need to be defined, even if pure virtual
157ProcessSession::~ProcessSession() {}
158
159class LinuxProcessSession : public ProcessSession {
160public:
Steven Moreland5553ac42020-11-11 02:14:45 +0000161 // reference to process hosting a socket server
162 Process host;
163
Andrei Homescu96834632022-10-14 00:49:49 +0000164 LinuxProcessSession(LinuxProcessSession&&) = default;
165 LinuxProcessSession(Process&& host) : host(std::move(host)) {}
166 ~LinuxProcessSession() override {
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000167 for (auto& session : sessions) {
168 session.root = nullptr;
Steven Moreland736664b2021-05-01 04:27:25 +0000169 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000170
Steven Moreland67f85902023-03-15 01:13:49 +0000171 for (size_t sessionNum = 0; sessionNum < sessions.size(); sessionNum++) {
172 auto& info = sessions.at(sessionNum);
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000173 sp<RpcSession>& session = info.session;
Steven Moreland736664b2021-05-01 04:27:25 +0000174
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000175 EXPECT_NE(nullptr, session);
176 EXPECT_NE(nullptr, session->state());
177 EXPECT_EQ(0, session->state()->countBinders()) << (session->state()->dump(), "dump:");
Steven Moreland736664b2021-05-01 04:27:25 +0000178
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000179 wp<RpcSession> weakSession = session;
180 session = nullptr;
Steven Moreland276d8df2022-09-28 23:56:39 +0000181
Steven Moreland57042712022-10-04 23:56:45 +0000182 // b/244325464 - 'getStrongCount' is printing '1' on failure here, which indicates the
183 // the object should not actually be promotable. By looping, we distinguish a race here
184 // from a bug causing the object to not be promotable.
185 for (size_t i = 0; i < 3; i++) {
186 sp<RpcSession> strongSession = weakSession.promote();
187 EXPECT_EQ(nullptr, strongSession)
Steven Moreland67f85902023-03-15 01:13:49 +0000188 << "For session " << sessionNum << ". "
Steven Moreland57042712022-10-04 23:56:45 +0000189 << (debugBacktrace(host.getPid()), debugBacktrace(getpid()),
190 "Leaked sess: ")
191 << strongSession->getStrongCount() << " checked time " << i;
192
193 if (strongSession != nullptr) {
194 sleep(1);
195 }
196 }
Steven Moreland736664b2021-05-01 04:27:25 +0000197 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000198 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000199
Andrei Homescu96834632022-10-14 00:49:49 +0000200 void setCustomExitStatusCheck(std::function<void(int wstatus)> f) override {
201 host.setCustomExitStatusCheck(std::move(f));
Steven Moreland5553ac42020-11-11 02:14:45 +0000202 }
Andrei Homescu96834632022-10-14 00:49:49 +0000203
204 void terminate() override { host.terminate(); }
Steven Moreland5553ac42020-11-11 02:14:45 +0000205};
206
Yifan Hong1deca4b2021-09-10 16:16:44 -0700207static base::unique_fd connectTo(const RpcSocketAddress& addr) {
Steven Moreland4198a122021-08-03 17:37:58 -0700208 base::unique_fd serverFd(
209 TEMP_FAILURE_RETRY(socket(addr.addr()->sa_family, SOCK_STREAM | SOCK_CLOEXEC, 0)));
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -0700210 if (!serverFd.ok()) {
211 PLOGF("Could not create socket %s", addr.toString().c_str());
212 }
Steven Moreland4198a122021-08-03 17:37:58 -0700213
214 if (0 != TEMP_FAILURE_RETRY(connect(serverFd.get(), addr.addr(), addr.addrSize()))) {
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -0700215 PLOGF("Could not connect to socket %s", addr.toString().c_str());
Steven Moreland4198a122021-08-03 17:37:58 -0700216 }
217 return serverFd;
218}
219
Andrei Homescud65666d2023-03-03 07:28:02 +0000220#ifndef BINDER_RPC_TO_TRUSTY_TEST
David Brazdil21c887c2022-09-23 12:25:18 +0100221static base::unique_fd connectToUnixBootstrap(const RpcTransportFd& transportFd) {
222 base::unique_fd sockClient, sockServer;
223 if (!base::Socketpair(SOCK_STREAM, &sockClient, &sockServer)) {
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -0700224 PLOGF("Failed socketpair()");
David Brazdil21c887c2022-09-23 12:25:18 +0100225 }
226
227 int zero = 0;
228 iovec iov{&zero, sizeof(zero)};
229 std::vector<std::variant<base::unique_fd, base::borrowed_fd>> fds;
230 fds.emplace_back(std::move(sockServer));
231
Tomasz Wasilczyk0d9dec22023-10-06 20:28:49 +0000232 if (binder::os::sendMessageOnSocket(transportFd, &iov, 1, &fds) < 0) {
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -0700233 PLOGF("Failed sendMessageOnSocket");
David Brazdil21c887c2022-09-23 12:25:18 +0100234 }
235 return std::move(sockClient);
236}
Andrei Homescud65666d2023-03-03 07:28:02 +0000237#endif // BINDER_RPC_TO_TRUSTY_TEST
David Brazdil21c887c2022-09-23 12:25:18 +0100238
Andrei Homescuf30148c2023-03-10 00:31:45 +0000239std::unique_ptr<RpcTransportCtxFactory> BinderRpc::newFactory(RpcSecurity rpcSecurity) {
240 return newTlsFactory(rpcSecurity);
Andrei Homescu96834632022-10-14 00:49:49 +0000241}
Andrei Homescu2a298012022-06-15 01:08:54 +0000242
Andrei Homescu96834632022-10-14 00:49:49 +0000243// This creates a new process serving an interface on a certain number of
244// threads.
245std::unique_ptr<ProcessSession> BinderRpc::createRpcTestSocketServerProcessEtc(
246 const BinderRpcOptions& options) {
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -0700247 LOG_ALWAYS_FATAL_IF(options.numSessions < 1, "Must have at least one session to a server");
Frederick Mayle69a0c992022-05-26 20:38:39 +0000248
Steven Moreland67f85902023-03-15 01:13:49 +0000249 if (options.numIncomingConnectionsBySession.size() != 0) {
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -0700250 LOG_ALWAYS_FATAL_IF(options.numIncomingConnectionsBySession.size() != options.numSessions,
251 "%s: %zu != %zu", __func__,
252 options.numIncomingConnectionsBySession.size(), options.numSessions);
Steven Moreland67f85902023-03-15 01:13:49 +0000253 }
254
Steven Morelandb469f432023-07-28 22:13:47 +0000255 SocketType socketType = GetParam().type;
256 RpcSecurity rpcSecurity = GetParam().security;
257 uint32_t clientVersion = GetParam().clientVersion;
258 uint32_t serverVersion = GetParam().serverVersion;
259 bool singleThreaded = GetParam().singleThreaded;
260 bool noKernel = GetParam().noKernel;
Andrei Homescu96834632022-10-14 00:49:49 +0000261
262 std::string path = android::base::GetExecutableDirectory();
Tomasz Wasilczyk3caae302023-10-12 20:57:02 +0000263 auto servicePath =
264 std::format("{}/binder_rpc_test_service{}{}", path,
265 singleThreaded ? "_single_threaded" : "", noKernel ? "_no_kernel" : "");
Andrei Homescu96834632022-10-14 00:49:49 +0000266
Alice Wang1ef010b2022-11-14 09:09:25 +0000267 base::unique_fd bootstrapClientFd, socketFd;
268
Alice Wang893a9912022-10-24 10:44:09 +0000269 auto addr = allocateSocketAddress();
270 // Initializes the socket before the fork/exec.
271 if (socketType == SocketType::UNIX_RAW) {
272 socketFd = initUnixSocket(addr);
Alice Wang1ef010b2022-11-14 09:09:25 +0000273 } else if (socketType == SocketType::UNIX_BOOTSTRAP) {
274 // Do not set O_CLOEXEC, bootstrapServerFd needs to survive fork/exec.
275 // This is because we cannot pass ParcelFileDescriptor over a pipe.
276 if (!base::Socketpair(SOCK_STREAM, &bootstrapClientFd, &socketFd)) {
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -0700277 PLOGF("Failed socketpair()");
Alice Wang1ef010b2022-11-14 09:09:25 +0000278 }
Alice Wang893a9912022-10-24 10:44:09 +0000279 }
Andrei Homescua858b0e2022-08-01 23:43:09 +0000280
Andrei Homescu96834632022-10-14 00:49:49 +0000281 auto ret = std::make_unique<LinuxProcessSession>(
282 Process([=](android::base::borrowed_fd writeEnd, android::base::borrowed_fd readEnd) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000283 if (socketType == SocketType::TIPC) {
284 // Trusty has a single persistent service
285 return;
286 }
287
Andrei Homescu96834632022-10-14 00:49:49 +0000288 auto writeFd = std::to_string(writeEnd.get());
289 auto readFd = std::to_string(readEnd.get());
290 execl(servicePath.c_str(), servicePath.c_str(), writeFd.c_str(), readFd.c_str(),
291 NULL);
292 }));
293
294 BinderRpcTestServerConfig serverConfig;
295 serverConfig.numThreads = options.numThreads;
296 serverConfig.socketType = static_cast<int32_t>(socketType);
297 serverConfig.rpcSecurity = static_cast<int32_t>(rpcSecurity);
298 serverConfig.serverVersion = serverVersion;
299 serverConfig.vsockPort = allocateVsockPort();
Alice Wang893a9912022-10-24 10:44:09 +0000300 serverConfig.addr = addr;
Alice Wang893a9912022-10-24 10:44:09 +0000301 serverConfig.socketFd = socketFd.get();
Andrei Homescu96834632022-10-14 00:49:49 +0000302 for (auto mode : options.serverSupportedFileDescriptorTransportModes) {
303 serverConfig.serverSupportedFileDescriptorTransportModes.push_back(
304 static_cast<int32_t>(mode));
305 }
Andrei Homescu68a55612022-08-02 01:25:15 +0000306 if (socketType != SocketType::TIPC) {
307 writeToFd(ret->host.writeEnd(), serverConfig);
308 }
Andrei Homescu96834632022-10-14 00:49:49 +0000309
310 std::vector<sp<RpcSession>> sessions;
311 auto certVerifier = std::make_shared<RpcCertificateVerifierSimple>();
312 for (size_t i = 0; i < options.numSessions; i++) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000313 std::unique_ptr<RpcTransportCtxFactory> factory;
314 if (socketType == SocketType::TIPC) {
Andrei Homescud65666d2023-03-03 07:28:02 +0000315#ifdef BINDER_RPC_TO_TRUSTY_TEST
Andrei Homescu68a55612022-08-02 01:25:15 +0000316 factory = RpcTransportCtxFactoryTipcAndroid::make();
317#else
318 LOG_ALWAYS_FATAL("TIPC socket type only supported on vendor");
319#endif
320 } else {
Andrei Homescuf30148c2023-03-10 00:31:45 +0000321 factory = newTlsFactory(rpcSecurity, certVerifier);
Andrei Homescu68a55612022-08-02 01:25:15 +0000322 }
323 sessions.emplace_back(RpcSession::make(std::move(factory)));
David Brazdil21c887c2022-09-23 12:25:18 +0100324 }
325
Andrei Homescu68a55612022-08-02 01:25:15 +0000326 BinderRpcTestServerInfo serverInfo;
327 if (socketType != SocketType::TIPC) {
328 serverInfo = readFromFd<BinderRpcTestServerInfo>(ret->host.readEnd());
329 BinderRpcTestClientInfo clientInfo;
330 for (const auto& session : sessions) {
331 auto& parcelableCert = clientInfo.certs.emplace_back();
332 parcelableCert.data = session->getCertificate(RpcCertificateFormat::PEM);
333 }
334 writeToFd(ret->host.writeEnd(), clientInfo);
Andrei Homescu96834632022-10-14 00:49:49 +0000335
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -0700336 LOG_ALWAYS_FATAL_IF(serverInfo.port > std::numeric_limits<unsigned int>::max());
Andrei Homescu68a55612022-08-02 01:25:15 +0000337 if (socketType == SocketType::INET) {
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -0700338 LOG_ALWAYS_FATAL_IF(0 == serverInfo.port);
Andrei Homescu68a55612022-08-02 01:25:15 +0000339 }
Frederick Mayle69a0c992022-05-26 20:38:39 +0000340
Andrei Homescu68a55612022-08-02 01:25:15 +0000341 if (rpcSecurity == RpcSecurity::TLS) {
342 const auto& serverCert = serverInfo.cert.data;
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -0700343 LOG_ALWAYS_FATAL_IF(
344 OK !=
345 certVerifier->addTrustedPeerCertificate(RpcCertificateFormat::PEM, serverCert));
Andrei Homescu68a55612022-08-02 01:25:15 +0000346 }
Yifan Hong1deca4b2021-09-10 16:16:44 -0700347 }
348
Andrei Homescu96834632022-10-14 00:49:49 +0000349 status_t status;
Steven Moreland736664b2021-05-01 04:27:25 +0000350
Steven Moreland67f85902023-03-15 01:13:49 +0000351 for (size_t i = 0; i < sessions.size(); i++) {
352 const auto& session = sessions.at(i);
353
354 size_t numIncoming = options.numIncomingConnectionsBySession.size() > 0
355 ? options.numIncomingConnectionsBySession.at(i)
356 : 0;
357
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -0700358 LOG_ALWAYS_FATAL_IF(!session->setProtocolVersion(clientVersion));
Steven Moreland67f85902023-03-15 01:13:49 +0000359 session->setMaxIncomingThreads(numIncoming);
Steven Morelandfeb13e82023-03-01 01:25:33 +0000360 session->setMaxOutgoingConnections(options.numOutgoingConnections);
Andrei Homescu96834632022-10-14 00:49:49 +0000361 session->setFileDescriptorTransportMode(options.clientFileDescriptorTransportMode);
Steven Morelandc1635952021-04-01 16:20:47 +0000362
Andrei Homescu96834632022-10-14 00:49:49 +0000363 switch (socketType) {
364 case SocketType::PRECONNECTED:
365 status = session->setupPreconnectedClient({}, [=]() {
366 return connectTo(UnixSocketAddress(serverConfig.addr.c_str()));
367 });
Frederick Mayle69a0c992022-05-26 20:38:39 +0000368 break;
Alice Wang893a9912022-10-24 10:44:09 +0000369 case SocketType::UNIX_RAW:
Andrei Homescu96834632022-10-14 00:49:49 +0000370 case SocketType::UNIX:
371 status = session->setupUnixDomainClient(serverConfig.addr.c_str());
372 break;
373 case SocketType::UNIX_BOOTSTRAP:
374 status = session->setupUnixDomainSocketBootstrapClient(
375 base::unique_fd(dup(bootstrapClientFd.get())));
376 break;
377 case SocketType::VSOCK:
378 status = session->setupVsockClient(VMADDR_CID_LOCAL, serverConfig.vsockPort);
379 break;
380 case SocketType::INET:
381 status = session->setupInetClient("127.0.0.1", serverInfo.port);
382 break;
Andrei Homescu68a55612022-08-02 01:25:15 +0000383 case SocketType::TIPC:
384 status = session->setupPreconnectedClient({}, [=]() {
Andrei Homescud65666d2023-03-03 07:28:02 +0000385#ifdef BINDER_RPC_TO_TRUSTY_TEST
Andrei Homescu68a55612022-08-02 01:25:15 +0000386 auto port = trustyIpcPort(serverVersion);
Andrei Homescu4bea21772023-03-21 23:28:33 +0000387 for (size_t i = 0; i < 5; i++) {
388 // Try to connect several times,
389 // in case the service is slow to start
390 int tipcFd = tipc_connect(kTrustyIpcDevice, port.c_str());
391 if (tipcFd >= 0) {
392 return android::base::unique_fd(tipcFd);
393 }
394 usleep(50000);
395 }
396 return android::base::unique_fd();
Andrei Homescu68a55612022-08-02 01:25:15 +0000397#else
398 LOG_ALWAYS_FATAL("Tried to connect to Trusty outside of vendor");
399 return android::base::unique_fd();
400#endif
401 });
402 break;
Andrei Homescu96834632022-10-14 00:49:49 +0000403 default:
404 LOG_ALWAYS_FATAL("Unknown socket type");
Steven Morelandc1635952021-04-01 16:20:47 +0000405 }
Andrei Homescu96834632022-10-14 00:49:49 +0000406 if (options.allowConnectFailure && status != OK) {
407 ret->sessions.clear();
408 break;
409 }
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -0700410 LOG_ALWAYS_FATAL_IF(status != OK, "Could not connect: %s", statusToString(status).c_str());
Andrei Homescu96834632022-10-14 00:49:49 +0000411 ret->sessions.push_back({session, session->getRootObject()});
Steven Morelandc1635952021-04-01 16:20:47 +0000412 }
Andrei Homescu96834632022-10-14 00:49:49 +0000413 return ret;
414}
Steven Morelandc1635952021-04-01 16:20:47 +0000415
Andrei Homescua858b0e2022-08-01 23:43:09 +0000416TEST_P(BinderRpc, ThreadPoolGreaterThanEqualRequested) {
417 if (clientOrServerSingleThreaded()) {
418 GTEST_SKIP() << "This test requires multiple threads";
419 }
420
Steven Moreland5553ac42020-11-11 02:14:45 +0000421 constexpr size_t kNumThreads = 10;
422
Steven Moreland4313d7e2021-07-15 23:41:22 +0000423 auto proc = createRpcTestSocketServerProcess({.numThreads = kNumThreads});
Steven Moreland5553ac42020-11-11 02:14:45 +0000424
425 EXPECT_OK(proc.rootIface->lock());
426
427 // block all but one thread taking locks
428 std::vector<std::thread> ts;
429 for (size_t i = 0; i < kNumThreads - 1; i++) {
430 ts.push_back(std::thread([&] { proc.rootIface->lockUnlock(); }));
431 }
432
Steven Morelandd6d816f2022-12-23 01:37:17 +0000433 usleep(100000); // give chance for calls on other threads
Steven Moreland5553ac42020-11-11 02:14:45 +0000434
435 // other calls still work
436 EXPECT_EQ(OK, proc.rootBinder->pingBinder());
437
Steven Morelandd6d816f2022-12-23 01:37:17 +0000438 constexpr size_t blockTimeMs = 100;
Steven Moreland5553ac42020-11-11 02:14:45 +0000439 size_t epochMsBefore = epochMillis();
440 // after this, we should never see a response within this time
441 EXPECT_OK(proc.rootIface->unlockInMsAsync(blockTimeMs));
442
443 // this call should be blocked for blockTimeMs
444 EXPECT_EQ(OK, proc.rootBinder->pingBinder());
445
446 size_t epochMsAfter = epochMillis();
447 EXPECT_GE(epochMsAfter, epochMsBefore + blockTimeMs) << epochMsBefore;
448
449 for (auto& t : ts) t.join();
450}
451
Steven Moreland27f620a2023-03-06 19:44:36 +0000452static void testThreadPoolOverSaturated(sp<IBinderRpcTest> iface, size_t numCalls, size_t sleepMs) {
Steven Moreland5553ac42020-11-11 02:14:45 +0000453 size_t epochMsBefore = epochMillis();
454
455 std::vector<std::thread> ts;
Yifan Hong1f44f982021-10-08 17:16:47 -0700456 for (size_t i = 0; i < numCalls; i++) {
457 ts.push_back(std::thread([&] { iface->sleepMs(sleepMs); }));
Steven Moreland5553ac42020-11-11 02:14:45 +0000458 }
459
460 for (auto& t : ts) t.join();
461
462 size_t epochMsAfter = epochMillis();
463
Yifan Hong1f44f982021-10-08 17:16:47 -0700464 EXPECT_GE(epochMsAfter, epochMsBefore + 2 * sleepMs);
Steven Moreland5553ac42020-11-11 02:14:45 +0000465
Steven Moreland9c203222023-05-31 21:26:41 +0000466 // Potential flake, but make sure calls are handled in parallel. Due
467 // to past flakes, this only checks that the amount of time taken has
468 // some parallelism. Other tests such as ThreadPoolGreaterThanEqualRequested
469 // check this more exactly.
470 EXPECT_LE(epochMsAfter, epochMsBefore + (numCalls - 1) * sleepMs);
Yifan Hong1f44f982021-10-08 17:16:47 -0700471}
472
Andrei Homescua858b0e2022-08-01 23:43:09 +0000473TEST_P(BinderRpc, ThreadPoolOverSaturated) {
474 if (clientOrServerSingleThreaded()) {
475 GTEST_SKIP() << "This test requires multiple threads";
476 }
477
Yifan Hong1f44f982021-10-08 17:16:47 -0700478 constexpr size_t kNumThreads = 10;
479 constexpr size_t kNumCalls = kNumThreads + 3;
480 auto proc = createRpcTestSocketServerProcess({.numThreads = kNumThreads});
Steven Moreland73aa6f82023-03-15 21:49:07 +0000481
482 // b/272429574 - below 500ms, the test fails
483 testThreadPoolOverSaturated(proc.rootIface, kNumCalls, 500 /*ms*/);
Yifan Hong1f44f982021-10-08 17:16:47 -0700484}
485
Andrei Homescua858b0e2022-08-01 23:43:09 +0000486TEST_P(BinderRpc, ThreadPoolLimitOutgoing) {
487 if (clientOrServerSingleThreaded()) {
488 GTEST_SKIP() << "This test requires multiple threads";
489 }
490
Yifan Hong1f44f982021-10-08 17:16:47 -0700491 constexpr size_t kNumThreads = 20;
492 constexpr size_t kNumOutgoingConnections = 10;
493 constexpr size_t kNumCalls = kNumOutgoingConnections + 3;
494 auto proc = createRpcTestSocketServerProcess(
495 {.numThreads = kNumThreads, .numOutgoingConnections = kNumOutgoingConnections});
Steven Moreland73aa6f82023-03-15 21:49:07 +0000496
497 // b/272429574 - below 500ms, the test fails
498 testThreadPoolOverSaturated(proc.rootIface, kNumCalls, 500 /*ms*/);
Steven Moreland5553ac42020-11-11 02:14:45 +0000499}
500
Andrei Homescua858b0e2022-08-01 23:43:09 +0000501TEST_P(BinderRpc, ThreadingStressTest) {
502 if (clientOrServerSingleThreaded()) {
503 GTEST_SKIP() << "This test requires multiple threads";
504 }
505
Steven Moreland27f620a2023-03-06 19:44:36 +0000506 constexpr size_t kNumClientThreads = 5;
507 constexpr size_t kNumServerThreads = 5;
508 constexpr size_t kNumCalls = 50;
Steven Moreland5553ac42020-11-11 02:14:45 +0000509
Steven Moreland4313d7e2021-07-15 23:41:22 +0000510 auto proc = createRpcTestSocketServerProcess({.numThreads = kNumServerThreads});
Steven Moreland5553ac42020-11-11 02:14:45 +0000511
512 std::vector<std::thread> threads;
513 for (size_t i = 0; i < kNumClientThreads; i++) {
514 threads.push_back(std::thread([&] {
515 for (size_t j = 0; j < kNumCalls; j++) {
516 sp<IBinder> out;
Steven Morelandc6046982021-04-20 00:49:42 +0000517 EXPECT_OK(proc.rootIface->repeatBinder(proc.rootBinder, &out));
Steven Moreland5553ac42020-11-11 02:14:45 +0000518 EXPECT_EQ(proc.rootBinder, out);
519 }
520 }));
521 }
522
523 for (auto& t : threads) t.join();
524}
525
Steven Moreland925ba0a2021-09-17 18:06:32 -0700526static void saturateThreadPool(size_t threadCount, const sp<IBinderRpcTest>& iface) {
527 std::vector<std::thread> threads;
528 for (size_t i = 0; i < threadCount; i++) {
529 threads.push_back(std::thread([&] { EXPECT_OK(iface->sleepMs(500)); }));
530 }
531 for (auto& t : threads) t.join();
532}
533
Andrei Homescua858b0e2022-08-01 23:43:09 +0000534TEST_P(BinderRpc, OnewayStressTest) {
535 if (clientOrServerSingleThreaded()) {
536 GTEST_SKIP() << "This test requires multiple threads";
537 }
538
Steven Morelandc6046982021-04-20 00:49:42 +0000539 constexpr size_t kNumClientThreads = 10;
540 constexpr size_t kNumServerThreads = 10;
Steven Moreland3c3ab8d2021-09-23 10:29:50 -0700541 constexpr size_t kNumCalls = 1000;
Steven Morelandc6046982021-04-20 00:49:42 +0000542
Steven Moreland4313d7e2021-07-15 23:41:22 +0000543 auto proc = createRpcTestSocketServerProcess({.numThreads = kNumServerThreads});
Steven Morelandc6046982021-04-20 00:49:42 +0000544
545 std::vector<std::thread> threads;
546 for (size_t i = 0; i < kNumClientThreads; i++) {
547 threads.push_back(std::thread([&] {
548 for (size_t j = 0; j < kNumCalls; j++) {
549 EXPECT_OK(proc.rootIface->sendString("a"));
550 }
Steven Morelandc6046982021-04-20 00:49:42 +0000551 }));
552 }
553
554 for (auto& t : threads) t.join();
Steven Moreland925ba0a2021-09-17 18:06:32 -0700555
556 saturateThreadPool(kNumServerThreads, proc.rootIface);
Steven Morelandc6046982021-04-20 00:49:42 +0000557}
558
Frederick Mayleb0221d12022-10-03 23:10:53 +0000559TEST_P(BinderRpc, OnewayCallQueueingWithFds) {
560 if (!supportsFdTransport()) {
561 GTEST_SKIP() << "Would fail trivially (which is tested elsewhere)";
562 }
563 if (clientOrServerSingleThreaded()) {
564 GTEST_SKIP() << "This test requires multiple threads";
565 }
566
Andrei Homescu5f2bc562023-02-25 04:59:43 +0000567 constexpr size_t kNumServerThreads = 3;
568
Frederick Mayleb0221d12022-10-03 23:10:53 +0000569 // This test forces a oneway transaction to be queued by issuing two
570 // `blockingSendFdOneway` calls, then drains the queue by issuing two
571 // `blockingRecvFd` calls.
572 //
573 // For more details about the queuing semantics see
574 // https://developer.android.com/reference/android/os/IBinder#FLAG_ONEWAY
575
576 auto proc = createRpcTestSocketServerProcess({
Andrei Homescu5f2bc562023-02-25 04:59:43 +0000577 .numThreads = kNumServerThreads,
Frederick Mayleb0221d12022-10-03 23:10:53 +0000578 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
579 .serverSupportedFileDescriptorTransportModes =
580 {RpcSession::FileDescriptorTransportMode::UNIX},
581 });
582
583 EXPECT_OK(proc.rootIface->blockingSendFdOneway(
584 android::os::ParcelFileDescriptor(mockFileDescriptor("a"))));
585 EXPECT_OK(proc.rootIface->blockingSendFdOneway(
586 android::os::ParcelFileDescriptor(mockFileDescriptor("b"))));
587
588 android::os::ParcelFileDescriptor fdA;
589 EXPECT_OK(proc.rootIface->blockingRecvFd(&fdA));
590 std::string result;
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -0700591 ASSERT_TRUE(android::base::ReadFdToString(fdA.get(), &result));
Frederick Mayleb0221d12022-10-03 23:10:53 +0000592 EXPECT_EQ(result, "a");
593
594 android::os::ParcelFileDescriptor fdB;
595 EXPECT_OK(proc.rootIface->blockingRecvFd(&fdB));
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -0700596 ASSERT_TRUE(android::base::ReadFdToString(fdB.get(), &result));
Frederick Mayleb0221d12022-10-03 23:10:53 +0000597 EXPECT_EQ(result, "b");
Andrei Homescu5f2bc562023-02-25 04:59:43 +0000598
599 saturateThreadPool(kNumServerThreads, proc.rootIface);
Frederick Mayleb0221d12022-10-03 23:10:53 +0000600}
601
Andrei Homescua858b0e2022-08-01 23:43:09 +0000602TEST_P(BinderRpc, OnewayCallQueueing) {
603 if (clientOrServerSingleThreaded()) {
604 GTEST_SKIP() << "This test requires multiple threads";
605 }
606
Frederick Mayle96872592023-03-07 14:56:15 -0800607 constexpr size_t kNumQueued = 10;
Steven Moreland5553ac42020-11-11 02:14:45 +0000608 constexpr size_t kNumExtraServerThreads = 4;
Steven Moreland5553ac42020-11-11 02:14:45 +0000609
610 // make sure calls to the same object happen on the same thread
Steven Moreland4313d7e2021-07-15 23:41:22 +0000611 auto proc = createRpcTestSocketServerProcess({.numThreads = 1 + kNumExtraServerThreads});
Steven Moreland5553ac42020-11-11 02:14:45 +0000612
Frederick Mayle96872592023-03-07 14:56:15 -0800613 // all these *Oneway commands should be queued on the server sequentially,
Steven Moreland1c678802021-09-17 16:48:47 -0700614 // even though there are multiple threads.
Frederick Mayle96872592023-03-07 14:56:15 -0800615 for (size_t i = 0; i + 1 < kNumQueued; i++) {
616 proc.rootIface->blockingSendIntOneway(i);
Steven Moreland5553ac42020-11-11 02:14:45 +0000617 }
Frederick Mayle96872592023-03-07 14:56:15 -0800618 for (size_t i = 0; i + 1 < kNumQueued; i++) {
619 int n;
620 proc.rootIface->blockingRecvInt(&n);
621 EXPECT_EQ(n, i);
622 }
Steven Morelandf5174272021-05-25 00:39:28 +0000623
Steven Moreland925ba0a2021-09-17 18:06:32 -0700624 saturateThreadPool(1 + kNumExtraServerThreads, proc.rootIface);
Steven Moreland5553ac42020-11-11 02:14:45 +0000625}
626
Andrei Homescua858b0e2022-08-01 23:43:09 +0000627TEST_P(BinderRpc, OnewayCallExhaustion) {
628 if (clientOrServerSingleThreaded()) {
629 GTEST_SKIP() << "This test requires multiple threads";
630 }
631
Steven Morelandd45be622021-06-04 02:19:37 +0000632 constexpr size_t kNumClients = 2;
633 constexpr size_t kTooLongMs = 1000;
634
Steven Moreland4313d7e2021-07-15 23:41:22 +0000635 auto proc = createRpcTestSocketServerProcess({.numThreads = kNumClients, .numSessions = 2});
Steven Morelandd45be622021-06-04 02:19:37 +0000636
637 // Build up oneway calls on the second session to make sure it terminates
638 // and shuts down. The first session should be unaffected (proc destructor
639 // checks the first session).
Andrei Homescu96834632022-10-14 00:49:49 +0000640 auto iface = interface_cast<IBinderRpcTest>(proc.proc->sessions.at(1).root);
Steven Morelandd45be622021-06-04 02:19:37 +0000641
642 std::vector<std::thread> threads;
643 for (size_t i = 0; i < kNumClients; i++) {
644 // one of these threads will get stuck queueing a transaction once the
645 // socket fills up, the other will be able to fill up transactions on
646 // this object
647 threads.push_back(std::thread([&] {
648 while (iface->sleepMsAsync(kTooLongMs).isOk()) {
649 }
650 }));
651 }
652 for (auto& t : threads) t.join();
653
654 Status status = iface->sleepMsAsync(kTooLongMs);
655 EXPECT_EQ(DEAD_OBJECT, status.transactionError()) << status;
656
Steven Moreland798e0d12021-07-14 23:19:25 +0000657 // now that it has died, wait for the remote session to shutdown
658 std::vector<int32_t> remoteCounts;
659 do {
660 EXPECT_OK(proc.rootIface->countBinders(&remoteCounts));
661 } while (remoteCounts.size() == kNumClients);
662
Steven Morelandd45be622021-06-04 02:19:37 +0000663 // the second session should be shutdown in the other process by the time we
664 // are able to join above (it'll only be hung up once it finishes processing
665 // any pending commands). We need to erase this session from the record
666 // here, so that the destructor for our session won't check that this
667 // session is valid, but we still want it to test the other session.
Andrei Homescu96834632022-10-14 00:49:49 +0000668 proc.proc->sessions.erase(proc.proc->sessions.begin() + 1);
Steven Morelandd45be622021-06-04 02:19:37 +0000669}
670
Steven Moreland67f85902023-03-15 01:13:49 +0000671TEST_P(BinderRpc, SessionWithIncomingThreadpoolDoesntLeak) {
672 if (clientOrServerSingleThreaded()) {
673 GTEST_SKIP() << "This test requires multiple threads";
674 }
675
676 // session 0 - will check for leaks in destrutor of proc
677 // session 1 - we want to make sure it gets deleted when we drop all references to it
678 auto proc = createRpcTestSocketServerProcess(
Tomasz Wasilczyk5da65602023-06-29 10:12:50 -0700679 {.numThreads = 1, .numSessions = 2, .numIncomingConnectionsBySession = {0, 1}});
Steven Moreland67f85902023-03-15 01:13:49 +0000680
681 wp<RpcSession> session = proc.proc->sessions.at(1).session;
682
683 // remove all references to the second session
684 proc.proc->sessions.at(1).root = nullptr;
685 proc.proc->sessions.erase(proc.proc->sessions.begin() + 1);
686
687 // TODO(b/271830568) more efficient way to wait for other incoming threadpool
688 // to drain commands.
689 for (size_t i = 0; i < 100; i++) {
690 usleep(10 * 1000);
691 if (session.promote() == nullptr) break;
692 }
693
694 EXPECT_EQ(nullptr, session.promote());
Steven Morelandb5d2b642023-05-04 00:31:45 +0000695
Steven Moreland0ebdaad2023-06-14 19:33:37 +0000696 // now that it has died, wait for the remote session to shutdown
697 std::vector<int32_t> remoteCounts;
698 do {
699 EXPECT_OK(proc.rootIface->countBinders(&remoteCounts));
700 } while (remoteCounts.size() > 1);
Steven Moreland67f85902023-03-15 01:13:49 +0000701}
702
Devin Moore66d5b7a2022-07-07 21:42:10 +0000703TEST_P(BinderRpc, SingleDeathRecipient) {
Andrei Homescua858b0e2022-08-01 23:43:09 +0000704 if (clientOrServerSingleThreaded()) {
Devin Moore66d5b7a2022-07-07 21:42:10 +0000705 GTEST_SKIP() << "This test requires multiple threads";
706 }
707 class MyDeathRec : public IBinder::DeathRecipient {
708 public:
709 void binderDied(const wp<IBinder>& /* who */) override {
710 dead = true;
711 mCv.notify_one();
712 }
713 std::mutex mMtx;
714 std::condition_variable mCv;
715 bool dead = false;
716 };
717
718 // Death recipient needs to have an incoming connection to be called
719 auto proc = createRpcTestSocketServerProcess(
Steven Moreland67f85902023-03-15 01:13:49 +0000720 {.numThreads = 1, .numSessions = 1, .numIncomingConnectionsBySession = {1}});
Devin Moore66d5b7a2022-07-07 21:42:10 +0000721
722 auto dr = sp<MyDeathRec>::make();
723 ASSERT_EQ(OK, proc.rootBinder->linkToDeath(dr, (void*)1, 0));
724
725 if (auto status = proc.rootIface->scheduleShutdown(); !status.isOk()) {
726 EXPECT_EQ(DEAD_OBJECT, status.transactionError()) << status;
727 }
728
729 std::unique_lock<std::mutex> lock(dr->mMtx);
Steven Morelanddd231e22022-09-08 19:47:49 +0000730 ASSERT_TRUE(dr->mCv.wait_for(lock, 100ms, [&]() { return dr->dead; }));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000731
732 // need to wait for the session to shutdown so we don't "Leak session"
Steven Moreland67f85902023-03-15 01:13:49 +0000733 // can't do this before checking the death recipient by calling
734 // forceShutdown earlier, because shutdownAndWait will also trigger
735 // a death recipient, but if we had a way to wait for the service
736 // to gracefully shutdown, we could use that here.
Andrei Homescu96834632022-10-14 00:49:49 +0000737 EXPECT_TRUE(proc.proc->sessions.at(0).session->shutdownAndWait(true));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000738 proc.expectAlreadyShutdown = true;
739}
740
741TEST_P(BinderRpc, SingleDeathRecipientOnShutdown) {
Andrei Homescua858b0e2022-08-01 23:43:09 +0000742 if (clientOrServerSingleThreaded()) {
Devin Moore66d5b7a2022-07-07 21:42:10 +0000743 GTEST_SKIP() << "This test requires multiple threads";
744 }
745 class MyDeathRec : public IBinder::DeathRecipient {
746 public:
747 void binderDied(const wp<IBinder>& /* who */) override {
748 dead = true;
749 mCv.notify_one();
750 }
751 std::mutex mMtx;
752 std::condition_variable mCv;
753 bool dead = false;
754 };
755
756 // Death recipient needs to have an incoming connection to be called
757 auto proc = createRpcTestSocketServerProcess(
Steven Moreland67f85902023-03-15 01:13:49 +0000758 {.numThreads = 1, .numSessions = 1, .numIncomingConnectionsBySession = {1}});
Devin Moore66d5b7a2022-07-07 21:42:10 +0000759
760 auto dr = sp<MyDeathRec>::make();
761 EXPECT_EQ(OK, proc.rootBinder->linkToDeath(dr, (void*)1, 0));
762
763 // Explicitly calling shutDownAndWait will cause the death recipients
764 // to be called.
Andrei Homescu96834632022-10-14 00:49:49 +0000765 EXPECT_TRUE(proc.proc->sessions.at(0).session->shutdownAndWait(true));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000766
767 std::unique_lock<std::mutex> lock(dr->mMtx);
768 if (!dr->dead) {
Steven Morelanddd231e22022-09-08 19:47:49 +0000769 EXPECT_EQ(std::cv_status::no_timeout, dr->mCv.wait_for(lock, 100ms));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000770 }
771 EXPECT_TRUE(dr->dead) << "Failed to receive the death notification.";
772
Andrei Homescu96834632022-10-14 00:49:49 +0000773 proc.proc->terminate();
774 proc.proc->setCustomExitStatusCheck([](int wstatus) {
Devin Moore66d5b7a2022-07-07 21:42:10 +0000775 EXPECT_TRUE(WIFSIGNALED(wstatus) && WTERMSIG(wstatus) == SIGTERM)
776 << "server process failed incorrectly: " << WaitStatusToString(wstatus);
777 });
778 proc.expectAlreadyShutdown = true;
779}
780
Steven Moreland5ec743f2023-01-18 01:02:06 +0000781TEST_P(BinderRpc, DeathRecipientFailsWithoutIncoming) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000782 if (socketType() == SocketType::TIPC) {
783 // This should work, but Trusty takes too long to restart the service
784 GTEST_SKIP() << "Service death test not supported on Trusty";
785 }
Devin Moore66d5b7a2022-07-07 21:42:10 +0000786 class MyDeathRec : public IBinder::DeathRecipient {
787 public:
788 void binderDied(const wp<IBinder>& /* who */) override {}
789 };
790
Steven Moreland67f85902023-03-15 01:13:49 +0000791 auto proc = createRpcTestSocketServerProcess({.numThreads = 1, .numSessions = 1});
Devin Moore66d5b7a2022-07-07 21:42:10 +0000792
793 auto dr = sp<MyDeathRec>::make();
Steven Moreland5ec743f2023-01-18 01:02:06 +0000794 EXPECT_EQ(INVALID_OPERATION, proc.rootBinder->linkToDeath(dr, (void*)1, 0));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000795}
796
797TEST_P(BinderRpc, UnlinkDeathRecipient) {
Andrei Homescua858b0e2022-08-01 23:43:09 +0000798 if (clientOrServerSingleThreaded()) {
Devin Moore66d5b7a2022-07-07 21:42:10 +0000799 GTEST_SKIP() << "This test requires multiple threads";
800 }
801 class MyDeathRec : public IBinder::DeathRecipient {
802 public:
803 void binderDied(const wp<IBinder>& /* who */) override {
804 GTEST_FAIL() << "This should not be called after unlinkToDeath";
805 }
806 };
807
808 // Death recipient needs to have an incoming connection to be called
809 auto proc = createRpcTestSocketServerProcess(
Steven Moreland67f85902023-03-15 01:13:49 +0000810 {.numThreads = 1, .numSessions = 1, .numIncomingConnectionsBySession = {1}});
Devin Moore66d5b7a2022-07-07 21:42:10 +0000811
812 auto dr = sp<MyDeathRec>::make();
813 ASSERT_EQ(OK, proc.rootBinder->linkToDeath(dr, (void*)1, 0));
814 ASSERT_EQ(OK, proc.rootBinder->unlinkToDeath(dr, (void*)1, 0, nullptr));
815
Steven Moreland67f85902023-03-15 01:13:49 +0000816 proc.forceShutdown();
Devin Moore66d5b7a2022-07-07 21:42:10 +0000817}
818
Steven Morelandc1635952021-04-01 16:20:47 +0000819TEST_P(BinderRpc, Die) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000820 if (socketType() == SocketType::TIPC) {
821 // This should work, but Trusty takes too long to restart the service
822 GTEST_SKIP() << "Service death test not supported on Trusty";
823 }
824
Steven Moreland5553ac42020-11-11 02:14:45 +0000825 for (bool doDeathCleanup : {true, false}) {
Steven Moreland4313d7e2021-07-15 23:41:22 +0000826 auto proc = createRpcTestSocketServerProcess({});
Steven Moreland5553ac42020-11-11 02:14:45 +0000827
828 // make sure there is some state during crash
829 // 1. we hold their binder
830 sp<IBinderRpcSession> session;
831 EXPECT_OK(proc.rootIface->openSession("happy", &session));
832 // 2. they hold our binder
833 sp<IBinder> binder = new BBinder();
834 EXPECT_OK(proc.rootIface->holdBinder(binder));
835
836 EXPECT_EQ(DEAD_OBJECT, proc.rootIface->die(doDeathCleanup).transactionError())
837 << "Do death cleanup: " << doDeathCleanup;
838
Andrei Homescu96834632022-10-14 00:49:49 +0000839 proc.proc->setCustomExitStatusCheck([](int wstatus) {
Frederick Maylea12b0962022-06-25 01:13:22 +0000840 EXPECT_TRUE(WIFEXITED(wstatus) && WEXITSTATUS(wstatus) == 1)
841 << "server process failed incorrectly: " << WaitStatusToString(wstatus);
842 });
Steven Morelandaf4ca712021-05-24 23:22:08 +0000843 proc.expectAlreadyShutdown = true;
Steven Moreland5553ac42020-11-11 02:14:45 +0000844 }
845}
846
Steven Morelandd7302072021-05-15 01:32:04 +0000847TEST_P(BinderRpc, UseKernelBinderCallingId) {
Andrei Homescu2a298012022-06-15 01:08:54 +0000848 // This test only works if the current process shared the internal state of
849 // ProcessState with the service across the call to fork(). Both the static
850 // libraries and libbinder.so have their own separate copies of all the
851 // globals, so the test only works when the test client and service both use
852 // libbinder.so (when using static libraries, even a client and service
853 // using the same kind of static library should have separate copies of the
854 // variables).
Andrei Homescua858b0e2022-08-01 23:43:09 +0000855 if (!kEnableSharedLibs || serverSingleThreaded() || noKernel()) {
Andrei Homescu12106de2022-04-27 04:42:21 +0000856 GTEST_SKIP() << "Test disabled because Binder kernel driver was disabled "
857 "at build time.";
858 }
859
Steven Moreland4313d7e2021-07-15 23:41:22 +0000860 auto proc = createRpcTestSocketServerProcess({});
Steven Morelandd7302072021-05-15 01:32:04 +0000861
Andrei Homescu2a298012022-06-15 01:08:54 +0000862 // we can't allocate IPCThreadState so actually the first time should
863 // succeed :(
864 EXPECT_OK(proc.rootIface->useKernelBinderCallingId());
Steven Morelandd7302072021-05-15 01:32:04 +0000865
866 // second time! we catch the error :)
867 EXPECT_EQ(DEAD_OBJECT, proc.rootIface->useKernelBinderCallingId().transactionError());
868
Andrei Homescu96834632022-10-14 00:49:49 +0000869 proc.proc->setCustomExitStatusCheck([](int wstatus) {
Frederick Maylea12b0962022-06-25 01:13:22 +0000870 EXPECT_TRUE(WIFSIGNALED(wstatus) && WTERMSIG(wstatus) == SIGABRT)
871 << "server process failed incorrectly: " << WaitStatusToString(wstatus);
872 });
Steven Morelandaf4ca712021-05-24 23:22:08 +0000873 proc.expectAlreadyShutdown = true;
Steven Morelandd7302072021-05-15 01:32:04 +0000874}
875
Frederick Mayle69a0c992022-05-26 20:38:39 +0000876TEST_P(BinderRpc, FileDescriptorTransportRejectNone) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000877 if (socketType() == SocketType::TIPC) {
878 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
879 }
880
Frederick Mayle69a0c992022-05-26 20:38:39 +0000881 auto proc = createRpcTestSocketServerProcess({
882 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::NONE,
883 .serverSupportedFileDescriptorTransportModes =
884 {RpcSession::FileDescriptorTransportMode::UNIX},
885 .allowConnectFailure = true,
886 });
Andrei Homescu96834632022-10-14 00:49:49 +0000887 EXPECT_TRUE(proc.proc->sessions.empty()) << "session connections should have failed";
888 proc.proc->terminate();
889 proc.proc->setCustomExitStatusCheck([](int wstatus) {
Frederick Mayle69a0c992022-05-26 20:38:39 +0000890 EXPECT_TRUE(WIFSIGNALED(wstatus) && WTERMSIG(wstatus) == SIGTERM)
891 << "server process failed incorrectly: " << WaitStatusToString(wstatus);
892 });
893 proc.expectAlreadyShutdown = true;
894}
895
896TEST_P(BinderRpc, FileDescriptorTransportRejectUnix) {
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::NONE},
905 .allowConnectFailure = true,
906 });
Andrei Homescu96834632022-10-14 00:49:49 +0000907 EXPECT_TRUE(proc.proc->sessions.empty()) << "session connections should have failed";
908 proc.proc->terminate();
909 proc.proc->setCustomExitStatusCheck([](int wstatus) {
Frederick Mayle69a0c992022-05-26 20:38:39 +0000910 EXPECT_TRUE(WIFSIGNALED(wstatus) && WTERMSIG(wstatus) == SIGTERM)
911 << "server process failed incorrectly: " << WaitStatusToString(wstatus);
912 });
913 proc.expectAlreadyShutdown = true;
914}
915
916TEST_P(BinderRpc, FileDescriptorTransportOptionalUnix) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000917 if (socketType() == SocketType::TIPC) {
918 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
919 }
920
Frederick Mayle69a0c992022-05-26 20:38:39 +0000921 auto proc = createRpcTestSocketServerProcess({
922 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::NONE,
923 .serverSupportedFileDescriptorTransportModes =
924 {RpcSession::FileDescriptorTransportMode::NONE,
925 RpcSession::FileDescriptorTransportMode::UNIX},
926 });
927
928 android::os::ParcelFileDescriptor out;
929 auto status = proc.rootIface->echoAsFile("hello", &out);
930 EXPECT_EQ(status.transactionError(), FDS_NOT_ALLOWED) << status;
931}
932
933TEST_P(BinderRpc, ReceiveFile) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000934 if (socketType() == SocketType::TIPC) {
935 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
936 }
937
Frederick Mayle69a0c992022-05-26 20:38:39 +0000938 auto proc = createRpcTestSocketServerProcess({
939 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
940 .serverSupportedFileDescriptorTransportModes =
941 {RpcSession::FileDescriptorTransportMode::UNIX},
942 });
943
944 android::os::ParcelFileDescriptor out;
945 auto status = proc.rootIface->echoAsFile("hello", &out);
946 if (!supportsFdTransport()) {
947 EXPECT_EQ(status.transactionError(), BAD_VALUE) << status;
948 return;
949 }
950 ASSERT_TRUE(status.isOk()) << status;
951
952 std::string result;
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -0700953 ASSERT_TRUE(android::base::ReadFdToString(out.get(), &result));
954 ASSERT_EQ(result, "hello");
Frederick Mayle69a0c992022-05-26 20:38:39 +0000955}
956
957TEST_P(BinderRpc, SendFiles) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000958 if (socketType() == SocketType::TIPC) {
959 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
960 }
961
Frederick Mayle69a0c992022-05-26 20:38:39 +0000962 auto proc = createRpcTestSocketServerProcess({
963 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
964 .serverSupportedFileDescriptorTransportModes =
965 {RpcSession::FileDescriptorTransportMode::UNIX},
966 });
967
968 std::vector<android::os::ParcelFileDescriptor> files;
969 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("123")));
970 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("a")));
971 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("b")));
972 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("cd")));
973
974 android::os::ParcelFileDescriptor out;
975 auto status = proc.rootIface->concatFiles(files, &out);
976 if (!supportsFdTransport()) {
977 EXPECT_EQ(status.transactionError(), BAD_VALUE) << status;
978 return;
979 }
980 ASSERT_TRUE(status.isOk()) << status;
981
982 std::string result;
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -0700983 EXPECT_TRUE(android::base::ReadFdToString(out.get(), &result));
Frederick Mayle69a0c992022-05-26 20:38:39 +0000984 EXPECT_EQ(result, "123abcd");
985}
986
987TEST_P(BinderRpc, SendMaxFiles) {
988 if (!supportsFdTransport()) {
989 GTEST_SKIP() << "Would fail trivially (which is tested by BinderRpc::SendFiles)";
990 }
991
992 auto proc = createRpcTestSocketServerProcess({
993 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
994 .serverSupportedFileDescriptorTransportModes =
995 {RpcSession::FileDescriptorTransportMode::UNIX},
996 });
997
998 std::vector<android::os::ParcelFileDescriptor> files;
999 for (int i = 0; i < 253; i++) {
1000 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("a")));
1001 }
1002
1003 android::os::ParcelFileDescriptor out;
1004 auto status = proc.rootIface->concatFiles(files, &out);
1005 ASSERT_TRUE(status.isOk()) << status;
1006
1007 std::string result;
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -07001008 EXPECT_TRUE(android::base::ReadFdToString(out.get(), &result));
Frederick Mayle69a0c992022-05-26 20:38:39 +00001009 EXPECT_EQ(result, std::string(253, 'a'));
1010}
1011
1012TEST_P(BinderRpc, SendTooManyFiles) {
1013 if (!supportsFdTransport()) {
1014 GTEST_SKIP() << "Would fail trivially (which is tested by BinderRpc::SendFiles)";
1015 }
1016
1017 auto proc = createRpcTestSocketServerProcess({
1018 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
1019 .serverSupportedFileDescriptorTransportModes =
1020 {RpcSession::FileDescriptorTransportMode::UNIX},
1021 });
1022
1023 std::vector<android::os::ParcelFileDescriptor> files;
1024 for (int i = 0; i < 254; i++) {
1025 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("a")));
1026 }
1027
1028 android::os::ParcelFileDescriptor out;
1029 auto status = proc.rootIface->concatFiles(files, &out);
1030 EXPECT_EQ(status.transactionError(), BAD_VALUE) << status;
1031}
1032
Andrei Homescufc221502022-10-08 03:51:17 +00001033TEST_P(BinderRpc, AppendInvalidFd) {
Andrei Homescu68a55612022-08-02 01:25:15 +00001034 if (socketType() == SocketType::TIPC) {
1035 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
1036 }
1037
Andrei Homescufc221502022-10-08 03:51:17 +00001038 auto proc = createRpcTestSocketServerProcess({
1039 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
1040 .serverSupportedFileDescriptorTransportModes =
1041 {RpcSession::FileDescriptorTransportMode::UNIX},
1042 });
1043
1044 int badFd = fcntl(STDERR_FILENO, F_DUPFD_CLOEXEC, 0);
1045 ASSERT_NE(badFd, -1);
1046
1047 // Close the file descriptor so it becomes invalid for dup
1048 close(badFd);
1049
1050 Parcel p1;
1051 p1.markForBinder(proc.rootBinder);
1052 p1.writeInt32(3);
1053 EXPECT_EQ(OK, p1.writeFileDescriptor(badFd, false));
1054
1055 Parcel pRaw;
1056 pRaw.markForBinder(proc.rootBinder);
1057 EXPECT_EQ(OK, pRaw.appendFrom(&p1, 0, p1.dataSize()));
1058
1059 pRaw.setDataPosition(0);
1060 EXPECT_EQ(3, pRaw.readInt32());
1061 ASSERT_EQ(-1, pRaw.readFileDescriptor());
1062}
1063
Andrei Homescu68a55612022-08-02 01:25:15 +00001064#ifndef __ANDROID_VENDOR__ // No AIBinder_fromPlatformBinder on vendor
Steven Moreland37aff182021-03-26 02:04:16 +00001065TEST_P(BinderRpc, WorksWithLibbinderNdkPing) {
Andrei Homescu12106de2022-04-27 04:42:21 +00001066 if constexpr (!kEnableSharedLibs) {
1067 GTEST_SKIP() << "Test disabled because Binder was built as a static library";
1068 }
1069
Steven Moreland4313d7e2021-07-15 23:41:22 +00001070 auto proc = createRpcTestSocketServerProcess({});
Steven Moreland37aff182021-03-26 02:04:16 +00001071
1072 ndk::SpAIBinder binder = ndk::SpAIBinder(AIBinder_fromPlatformBinder(proc.rootBinder));
1073 ASSERT_NE(binder, nullptr);
1074
1075 ASSERT_EQ(STATUS_OK, AIBinder_ping(binder.get()));
1076}
1077
1078TEST_P(BinderRpc, WorksWithLibbinderNdkUserTransaction) {
Andrei Homescu12106de2022-04-27 04:42:21 +00001079 if constexpr (!kEnableSharedLibs) {
1080 GTEST_SKIP() << "Test disabled because Binder was built as a static library";
1081 }
1082
Steven Moreland4313d7e2021-07-15 23:41:22 +00001083 auto proc = createRpcTestSocketServerProcess({});
Steven Moreland37aff182021-03-26 02:04:16 +00001084
1085 ndk::SpAIBinder binder = ndk::SpAIBinder(AIBinder_fromPlatformBinder(proc.rootBinder));
1086 ASSERT_NE(binder, nullptr);
1087
1088 auto ndkBinder = aidl::IBinderRpcTest::fromBinder(binder);
1089 ASSERT_NE(ndkBinder, nullptr);
1090
1091 std::string out;
1092 ndk::ScopedAStatus status = ndkBinder->doubleString("aoeu", &out);
1093 ASSERT_TRUE(status.isOk()) << status.getDescription();
1094 ASSERT_EQ("aoeuaoeu", out);
1095}
Andrei Homescu68a55612022-08-02 01:25:15 +00001096#endif // __ANDROID_VENDOR__
Steven Moreland37aff182021-03-26 02:04:16 +00001097
Steven Moreland5553ac42020-11-11 02:14:45 +00001098ssize_t countFds() {
1099 DIR* dir = opendir("/proc/self/fd/");
1100 if (dir == nullptr) return -1;
1101 ssize_t ret = 0;
1102 dirent* ent;
1103 while ((ent = readdir(dir)) != nullptr) ret++;
1104 closedir(dir);
1105 return ret;
1106}
1107
Andrei Homescua858b0e2022-08-01 23:43:09 +00001108TEST_P(BinderRpc, Fds) {
1109 if (serverSingleThreaded()) {
1110 GTEST_SKIP() << "This test requires multiple threads";
1111 }
Andrei Homescu68a55612022-08-02 01:25:15 +00001112 if (socketType() == SocketType::TIPC) {
1113 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
1114 }
Andrei Homescua858b0e2022-08-01 23:43:09 +00001115
Steven Moreland5553ac42020-11-11 02:14:45 +00001116 ssize_t beforeFds = countFds();
1117 ASSERT_GE(beforeFds, 0);
1118 {
Steven Moreland4313d7e2021-07-15 23:41:22 +00001119 auto proc = createRpcTestSocketServerProcess({.numThreads = 10});
Steven Moreland5553ac42020-11-11 02:14:45 +00001120 ASSERT_EQ(OK, proc.rootBinder->pingBinder());
1121 }
1122 ASSERT_EQ(beforeFds, countFds()) << (system("ls -l /proc/self/fd/"), "fd leak?");
1123}
1124
Andrei Homescud65666d2023-03-03 07:28:02 +00001125#ifdef BINDER_RPC_TO_TRUSTY_TEST
Steven Morelandb469f432023-07-28 22:13:47 +00001126
1127static std::vector<BinderRpc::ParamType> getTrustyBinderRpcParams() {
1128 std::vector<BinderRpc::ParamType> ret;
1129
1130 for (const auto& clientVersion : testVersions()) {
1131 for (const auto& serverVersion : testVersions()) {
1132 ret.push_back(BinderRpc::ParamType{
1133 .type = SocketType::TIPC,
1134 .security = RpcSecurity::RAW,
1135 .clientVersion = clientVersion,
1136 .serverVersion = serverVersion,
1137 .singleThreaded = true,
1138 .noKernel = true,
1139 });
1140 }
1141 }
1142
1143 return ret;
1144}
1145
1146INSTANTIATE_TEST_CASE_P(Trusty, BinderRpc, ::testing::ValuesIn(getTrustyBinderRpcParams()),
Andrei Homescud65666d2023-03-03 07:28:02 +00001147 BinderRpc::PrintParamInfo);
1148#else // BINDER_RPC_TO_TRUSTY_TEST
Steven Moreland9f250b02023-05-16 23:27:42 +00001149bool testSupportVsockLoopback() {
Yifan Hong702115c2021-06-24 15:39:18 -07001150 // We don't need to enable TLS to know if vsock is supported.
Steven Morelandda573042021-06-12 01:13:45 +00001151 unsigned int vsockPort = allocateVsockPort();
Steven Morelandda573042021-06-12 01:13:45 +00001152
Andrei Homescu992a4052022-06-28 21:26:18 +00001153 android::base::unique_fd serverFd(
1154 TEMP_FAILURE_RETRY(socket(AF_VSOCK, SOCK_STREAM | SOCK_CLOEXEC | SOCK_NONBLOCK, 0)));
Steven Morelanda27311b2023-04-11 22:13:35 +00001155
1156 if (errno == EAFNOSUPPORT) {
1157 return false;
1158 }
1159
Andrei Homescu992a4052022-06-28 21:26:18 +00001160 LOG_ALWAYS_FATAL_IF(serverFd == -1, "Could not create socket: %s", strerror(errno));
1161
1162 sockaddr_vm serverAddr{
1163 .svm_family = AF_VSOCK,
1164 .svm_port = vsockPort,
1165 .svm_cid = VMADDR_CID_ANY,
1166 };
1167 int ret = TEMP_FAILURE_RETRY(
1168 bind(serverFd.get(), reinterpret_cast<sockaddr*>(&serverAddr), sizeof(serverAddr)));
1169 LOG_ALWAYS_FATAL_IF(0 != ret, "Could not bind socket to port %u: %s", vsockPort,
1170 strerror(errno));
1171
1172 ret = TEMP_FAILURE_RETRY(listen(serverFd.get(), 1 /*backlog*/));
1173 LOG_ALWAYS_FATAL_IF(0 != ret, "Could not listen socket on port %u: %s", vsockPort,
1174 strerror(errno));
1175
1176 // Try to connect to the server using the VMADDR_CID_LOCAL cid
1177 // to see if the kernel supports it. It's safe to use a blocking
1178 // connect because vsock sockets have a 2 second connection timeout,
1179 // and they return ETIMEDOUT after that.
1180 android::base::unique_fd connectFd(
1181 TEMP_FAILURE_RETRY(socket(AF_VSOCK, SOCK_STREAM | SOCK_CLOEXEC | SOCK_NONBLOCK, 0)));
1182 LOG_ALWAYS_FATAL_IF(connectFd == -1, "Could not create socket for port %u: %s", vsockPort,
1183 strerror(errno));
1184
1185 bool success = false;
1186 sockaddr_vm connectAddr{
1187 .svm_family = AF_VSOCK,
1188 .svm_port = vsockPort,
1189 .svm_cid = VMADDR_CID_LOCAL,
1190 };
1191 ret = TEMP_FAILURE_RETRY(connect(connectFd.get(), reinterpret_cast<sockaddr*>(&connectAddr),
1192 sizeof(connectAddr)));
1193 if (ret != 0 && (errno == EAGAIN || errno == EINPROGRESS)) {
1194 android::base::unique_fd acceptFd;
1195 while (true) {
1196 pollfd pfd[]{
1197 {.fd = serverFd.get(), .events = POLLIN, .revents = 0},
1198 {.fd = connectFd.get(), .events = POLLOUT, .revents = 0},
1199 };
Tomasz Wasilczyk657c2bc2023-11-07 06:57:42 -08001200 ret = TEMP_FAILURE_RETRY(poll(pfd, countof(pfd), -1));
Andrei Homescu992a4052022-06-28 21:26:18 +00001201 LOG_ALWAYS_FATAL_IF(ret < 0, "Error polling: %s", strerror(errno));
1202
1203 if (pfd[0].revents & POLLIN) {
1204 sockaddr_vm acceptAddr;
1205 socklen_t acceptAddrLen = sizeof(acceptAddr);
1206 ret = TEMP_FAILURE_RETRY(accept4(serverFd.get(),
1207 reinterpret_cast<sockaddr*>(&acceptAddr),
1208 &acceptAddrLen, SOCK_CLOEXEC));
1209 LOG_ALWAYS_FATAL_IF(ret < 0, "Could not accept4 socket: %s", strerror(errno));
1210 LOG_ALWAYS_FATAL_IF(acceptAddrLen != static_cast<socklen_t>(sizeof(acceptAddr)),
1211 "Truncated address");
1212
1213 // Store the fd in acceptFd so we keep the connection alive
1214 // while polling connectFd
1215 acceptFd.reset(ret);
1216 }
1217
1218 if (pfd[1].revents & POLLOUT) {
1219 // Connect either succeeded or timed out
1220 int connectErrno;
1221 socklen_t connectErrnoLen = sizeof(connectErrno);
1222 int ret = getsockopt(connectFd.get(), SOL_SOCKET, SO_ERROR, &connectErrno,
1223 &connectErrnoLen);
1224 LOG_ALWAYS_FATAL_IF(ret == -1,
1225 "Could not getsockopt() after connect() "
1226 "on non-blocking socket: %s.",
1227 strerror(errno));
1228
1229 // We're done, this is all we wanted
1230 success = connectErrno == 0;
1231 break;
1232 }
1233 }
1234 } else {
1235 success = ret == 0;
1236 }
1237
1238 ALOGE("Detected vsock loopback supported: %s", success ? "yes" : "no");
1239
1240 return success;
Steven Morelandda573042021-06-12 01:13:45 +00001241}
1242
Yifan Hong1deca4b2021-09-10 16:16:44 -07001243static std::vector<SocketType> testSocketTypes(bool hasPreconnected = true) {
Alice Wang893a9912022-10-24 10:44:09 +00001244 std::vector<SocketType> ret = {SocketType::UNIX, SocketType::UNIX_BOOTSTRAP, SocketType::INET,
1245 SocketType::UNIX_RAW};
Yifan Hong1deca4b2021-09-10 16:16:44 -07001246
1247 if (hasPreconnected) ret.push_back(SocketType::PRECONNECTED);
Steven Morelandda573042021-06-12 01:13:45 +00001248
Steven Moreland9f250b02023-05-16 23:27:42 +00001249#ifdef __BIONIC__
1250 // Devices may not have vsock support. AVF tests will verify whether they do, but
1251 // we can't require it due to old kernels for the time being.
Steven Morelandda573042021-06-12 01:13:45 +00001252 static bool hasVsockLoopback = testSupportVsockLoopback();
Steven Moreland9f250b02023-05-16 23:27:42 +00001253#else
1254 // On host machines, we always assume we have vsock loopback. If we don't, the
1255 // subsequent failures will be more clear than showing one now.
1256 static bool hasVsockLoopback = true;
1257#endif
Steven Morelandda573042021-06-12 01:13:45 +00001258
1259 if (hasVsockLoopback) {
1260 ret.push_back(SocketType::VSOCK);
1261 }
1262
1263 return ret;
1264}
1265
Steven Morelandb469f432023-07-28 22:13:47 +00001266static std::vector<BinderRpc::ParamType> getBinderRpcParams() {
1267 std::vector<BinderRpc::ParamType> ret;
1268
Steven Morelandf7421432023-07-28 22:41:44 +00001269 constexpr bool full = false;
1270
Steven Morelandb469f432023-07-28 22:13:47 +00001271 for (const auto& type : testSocketTypes()) {
Steven Morelandf7421432023-07-28 22:41:44 +00001272 if (full || type == SocketType::UNIX) {
1273 for (const auto& security : RpcSecurityValues()) {
1274 for (const auto& clientVersion : testVersions()) {
1275 for (const auto& serverVersion : testVersions()) {
1276 for (bool singleThreaded : {false, true}) {
1277 for (bool noKernel : {false, true}) {
1278 ret.push_back(BinderRpc::ParamType{
1279 .type = type,
1280 .security = security,
1281 .clientVersion = clientVersion,
1282 .serverVersion = serverVersion,
1283 .singleThreaded = singleThreaded,
1284 .noKernel = noKernel,
1285 });
1286 }
Steven Morelandb469f432023-07-28 22:13:47 +00001287 }
1288 }
1289 }
1290 }
Steven Morelandf7421432023-07-28 22:41:44 +00001291 } else {
1292 ret.push_back(BinderRpc::ParamType{
1293 .type = type,
1294 .security = RpcSecurity::RAW,
1295 .clientVersion = RPC_WIRE_PROTOCOL_VERSION,
1296 .serverVersion = RPC_WIRE_PROTOCOL_VERSION,
1297 .singleThreaded = false,
1298 .noKernel = false,
1299 });
Steven Morelandb469f432023-07-28 22:13:47 +00001300 }
1301 }
Steven Morelandf7421432023-07-28 22:41:44 +00001302
Steven Morelandb469f432023-07-28 22:13:47 +00001303 return ret;
1304}
1305
1306INSTANTIATE_TEST_CASE_P(PerSocket, BinderRpc, ::testing::ValuesIn(getBinderRpcParams()),
Yifan Hong702115c2021-06-24 15:39:18 -07001307 BinderRpc::PrintParamInfo);
Steven Morelandc1635952021-04-01 16:20:47 +00001308
Yifan Hong702115c2021-06-24 15:39:18 -07001309class BinderRpcServerRootObject
1310 : public ::testing::TestWithParam<std::tuple<bool, bool, RpcSecurity>> {};
Yifan Hong4ffb0c72021-05-07 18:35:14 -07001311
1312TEST_P(BinderRpcServerRootObject, WeakRootObject) {
1313 using SetFn = std::function<void(RpcServer*, sp<IBinder>)>;
1314 auto setRootObject = [](bool isStrong) -> SetFn {
1315 return isStrong ? SetFn(&RpcServer::setRootObject) : SetFn(&RpcServer::setRootObjectWeak);
1316 };
1317
Yifan Hong702115c2021-06-24 15:39:18 -07001318 auto [isStrong1, isStrong2, rpcSecurity] = GetParam();
Andrei Homescuf30148c2023-03-10 00:31:45 +00001319 auto server = RpcServer::make(newTlsFactory(rpcSecurity));
Yifan Hong4ffb0c72021-05-07 18:35:14 -07001320 auto binder1 = sp<BBinder>::make();
1321 IBinder* binderRaw1 = binder1.get();
1322 setRootObject(isStrong1)(server.get(), binder1);
1323 EXPECT_EQ(binderRaw1, server->getRootObject());
1324 binder1.clear();
1325 EXPECT_EQ((isStrong1 ? binderRaw1 : nullptr), server->getRootObject());
1326
1327 auto binder2 = sp<BBinder>::make();
1328 IBinder* binderRaw2 = binder2.get();
1329 setRootObject(isStrong2)(server.get(), binder2);
1330 EXPECT_EQ(binderRaw2, server->getRootObject());
1331 binder2.clear();
1332 EXPECT_EQ((isStrong2 ? binderRaw2 : nullptr), server->getRootObject());
1333}
1334
1335INSTANTIATE_TEST_CASE_P(BinderRpc, BinderRpcServerRootObject,
Yifan Hong702115c2021-06-24 15:39:18 -07001336 ::testing::Combine(::testing::Bool(), ::testing::Bool(),
1337 ::testing::ValuesIn(RpcSecurityValues())));
Yifan Hong4ffb0c72021-05-07 18:35:14 -07001338
Yifan Hong1a235852021-05-13 16:07:47 -07001339class OneOffSignal {
1340public:
1341 // If notify() was previously called, or is called within |duration|, return true; else false.
1342 template <typename R, typename P>
1343 bool wait(std::chrono::duration<R, P> duration) {
1344 std::unique_lock<std::mutex> lock(mMutex);
1345 return mCv.wait_for(lock, duration, [this] { return mValue; });
1346 }
1347 void notify() {
1348 std::unique_lock<std::mutex> lock(mMutex);
1349 mValue = true;
1350 lock.unlock();
1351 mCv.notify_all();
1352 }
1353
1354private:
1355 std::mutex mMutex;
1356 std::condition_variable mCv;
1357 bool mValue = false;
1358};
1359
Yifan Hong194acf22021-06-29 18:44:56 -07001360TEST(BinderRpc, Java) {
Tomasz Wasilczykc2b71d52023-11-06 16:32:12 -08001361 bool expectDebuggable = false;
1362#if defined(__ANDROID__)
1363 expectDebuggable = android::base::GetBoolProperty("ro.debuggable", false) &&
1364 android::base::GetProperty("ro.build.type", "") != "user";
1365#else
Yifan Hong194acf22021-06-29 18:44:56 -07001366 GTEST_SKIP() << "This test is only run on Android. Though it can technically run on host on"
1367 "createRpcDelegateServiceManager() with a device attached, such test belongs "
1368 "to binderHostDeviceTest. Hence, just disable this test on host.";
1369#endif // !__ANDROID__
Andrei Homescu12106de2022-04-27 04:42:21 +00001370 if constexpr (!kEnableKernelIpc) {
1371 GTEST_SKIP() << "Test disabled because Binder kernel driver was disabled "
1372 "at build time.";
1373 }
1374
Yifan Hong194acf22021-06-29 18:44:56 -07001375 sp<IServiceManager> sm = defaultServiceManager();
1376 ASSERT_NE(nullptr, sm);
1377 // Any Java service with non-empty getInterfaceDescriptor() would do.
1378 // Let's pick batteryproperties.
1379 auto binder = sm->checkService(String16("batteryproperties"));
1380 ASSERT_NE(nullptr, binder);
1381 auto descriptor = binder->getInterfaceDescriptor();
1382 ASSERT_GE(descriptor.size(), 0);
1383 ASSERT_EQ(OK, binder->pingBinder());
1384
1385 auto rpcServer = RpcServer::make();
Yifan Hong194acf22021-06-29 18:44:56 -07001386 unsigned int port;
Steven Moreland2372f9d2021-08-05 15:42:01 -07001387 ASSERT_EQ(OK, rpcServer->setupInetServer(kLocalInetAddress, 0, &port));
Yifan Hong194acf22021-06-29 18:44:56 -07001388 auto socket = rpcServer->releaseServer();
1389
1390 auto keepAlive = sp<BBinder>::make();
Yifan Hongfe4b83f2021-11-08 16:29:53 -08001391 auto setRpcClientDebugStatus = binder->setRpcClientDebug(std::move(socket), keepAlive);
1392
Tomasz Wasilczykc2b71d52023-11-06 16:32:12 -08001393 if (!expectDebuggable) {
Yifan Hongfe4b83f2021-11-08 16:29:53 -08001394 ASSERT_EQ(INVALID_OPERATION, setRpcClientDebugStatus)
Yifan Honge3caaf22022-01-12 14:46:56 -08001395 << "setRpcClientDebug should return INVALID_OPERATION on non-debuggable or user "
1396 "builds, but get "
Yifan Hongfe4b83f2021-11-08 16:29:53 -08001397 << statusToString(setRpcClientDebugStatus);
1398 GTEST_SKIP();
1399 }
1400
1401 ASSERT_EQ(OK, setRpcClientDebugStatus);
Yifan Hong194acf22021-06-29 18:44:56 -07001402
1403 auto rpcSession = RpcSession::make();
Steven Moreland2372f9d2021-08-05 15:42:01 -07001404 ASSERT_EQ(OK, rpcSession->setupInetClient("127.0.0.1", port));
Yifan Hong194acf22021-06-29 18:44:56 -07001405 auto rpcBinder = rpcSession->getRootObject();
1406 ASSERT_NE(nullptr, rpcBinder);
1407
1408 ASSERT_EQ(OK, rpcBinder->pingBinder());
1409
1410 ASSERT_EQ(descriptor, rpcBinder->getInterfaceDescriptor())
1411 << "getInterfaceDescriptor should not crash system_server";
1412 ASSERT_EQ(OK, rpcBinder->pingBinder());
1413}
1414
Andrei Homescu8d7f4bd2022-08-03 05:46:17 +00001415class BinderRpcServerOnly : public ::testing::TestWithParam<std::tuple<RpcSecurity, uint32_t>> {
1416public:
1417 static std::string PrintTestParam(const ::testing::TestParamInfo<ParamType>& info) {
Andrei Homescuf30148c2023-03-10 00:31:45 +00001418 return std::string(newTlsFactory(std::get<0>(info.param))->toCString()) + "_serverV" +
Andrei Homescu8d7f4bd2022-08-03 05:46:17 +00001419 std::to_string(std::get<1>(info.param));
1420 }
1421};
1422
1423TEST_P(BinderRpcServerOnly, SetExternalServerTest) {
1424 base::unique_fd sink(TEMP_FAILURE_RETRY(open("/dev/null", O_RDWR)));
1425 int sinkFd = sink.get();
Andrei Homescuf30148c2023-03-10 00:31:45 +00001426 auto server = RpcServer::make(newTlsFactory(std::get<0>(GetParam())));
Steven Morelandca3f6382023-05-11 23:23:26 +00001427 ASSERT_TRUE(server->setProtocolVersion(std::get<1>(GetParam())));
Andrei Homescu8d7f4bd2022-08-03 05:46:17 +00001428 ASSERT_FALSE(server->hasServer());
1429 ASSERT_EQ(OK, server->setupExternalServer(std::move(sink)));
1430 ASSERT_TRUE(server->hasServer());
1431 base::unique_fd retrieved = server->releaseServer();
1432 ASSERT_FALSE(server->hasServer());
1433 ASSERT_EQ(sinkFd, retrieved.get());
1434}
1435
1436TEST_P(BinderRpcServerOnly, Shutdown) {
1437 if constexpr (!kEnableRpcThreads) {
1438 GTEST_SKIP() << "Test skipped because threads were disabled at build time";
1439 }
1440
1441 auto addr = allocateSocketAddress();
Andrei Homescuf30148c2023-03-10 00:31:45 +00001442 auto server = RpcServer::make(newTlsFactory(std::get<0>(GetParam())));
Steven Morelandca3f6382023-05-11 23:23:26 +00001443 ASSERT_TRUE(server->setProtocolVersion(std::get<1>(GetParam())));
Andrei Homescu8d7f4bd2022-08-03 05:46:17 +00001444 ASSERT_EQ(OK, server->setupUnixDomainServer(addr.c_str()));
1445 auto joinEnds = std::make_shared<OneOffSignal>();
1446
1447 // If things are broken and the thread never stops, don't block other tests. Because the thread
1448 // may run after the test finishes, it must not access the stack memory of the test. Hence,
1449 // shared pointers are passed.
1450 std::thread([server, joinEnds] {
1451 server->join();
1452 joinEnds->notify();
1453 }).detach();
1454
1455 bool shutdown = false;
1456 for (int i = 0; i < 10 && !shutdown; i++) {
Steven Morelanddd231e22022-09-08 19:47:49 +00001457 usleep(30 * 1000); // 30ms; total 300ms
Andrei Homescu8d7f4bd2022-08-03 05:46:17 +00001458 if (server->shutdown()) shutdown = true;
1459 }
1460 ASSERT_TRUE(shutdown) << "server->shutdown() never returns true";
1461
1462 ASSERT_TRUE(joinEnds->wait(2s))
1463 << "After server->shutdown() returns true, join() did not stop after 2s";
1464}
1465
Frederick Mayledc07cf82022-05-26 20:30:12 +00001466INSTANTIATE_TEST_CASE_P(BinderRpc, BinderRpcServerOnly,
1467 ::testing::Combine(::testing::ValuesIn(RpcSecurityValues()),
1468 ::testing::ValuesIn(testVersions())),
1469 BinderRpcServerOnly::PrintTestParam);
Yifan Hong702115c2021-06-24 15:39:18 -07001470
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001471class RpcTransportTestUtils {
Yifan Hong1deca4b2021-09-10 16:16:44 -07001472public:
Frederick Mayledc07cf82022-05-26 20:30:12 +00001473 // Only parameterized only server version because `RpcSession` is bypassed
1474 // in the client half of the tests.
1475 using Param =
1476 std::tuple<SocketType, RpcSecurity, std::optional<RpcCertificateFormat>, uint32_t>;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001477 using ConnectToServer = std::function<base::unique_fd()>;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001478
1479 // A server that handles client socket connections.
1480 class Server {
1481 public:
David Brazdil21c887c2022-09-23 12:25:18 +01001482 using AcceptConnection = std::function<base::unique_fd(Server*)>;
1483
Yifan Hong1deca4b2021-09-10 16:16:44 -07001484 explicit Server() {}
1485 Server(Server&&) = default;
Yifan Honge07d2732021-09-13 21:59:14 -07001486 ~Server() { shutdownAndWait(); }
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001487 [[nodiscard]] AssertionResult setUp(
1488 const Param& param,
1489 std::unique_ptr<RpcAuth> auth = std::make_unique<RpcAuthSelfSigned>()) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001490 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = param;
Andrei Homescuf30148c2023-03-10 00:31:45 +00001491 auto rpcServer = RpcServer::make(newTlsFactory(rpcSecurity));
Steven Morelandca3f6382023-05-11 23:23:26 +00001492 if (!rpcServer->setProtocolVersion(serverVersion)) {
1493 return AssertionFailure() << "Invalid protocol version: " << serverVersion;
1494 }
Yifan Hong1deca4b2021-09-10 16:16:44 -07001495 switch (socketType) {
1496 case SocketType::PRECONNECTED: {
1497 return AssertionFailure() << "Not supported by this test";
1498 } break;
1499 case SocketType::UNIX: {
1500 auto addr = allocateSocketAddress();
1501 auto status = rpcServer->setupUnixDomainServer(addr.c_str());
1502 if (status != OK) {
1503 return AssertionFailure()
1504 << "setupUnixDomainServer: " << statusToString(status);
1505 }
1506 mConnectToServer = [addr] {
1507 return connectTo(UnixSocketAddress(addr.c_str()));
1508 };
1509 } break;
David Brazdil21c887c2022-09-23 12:25:18 +01001510 case SocketType::UNIX_BOOTSTRAP: {
1511 base::unique_fd bootstrapFdClient, bootstrapFdServer;
1512 if (!base::Socketpair(SOCK_STREAM, &bootstrapFdClient, &bootstrapFdServer)) {
1513 return AssertionFailure() << "Socketpair() failed";
1514 }
1515 auto status = rpcServer->setupUnixDomainSocketBootstrapServer(
1516 std::move(bootstrapFdServer));
1517 if (status != OK) {
1518 return AssertionFailure() << "setupUnixDomainSocketBootstrapServer: "
1519 << statusToString(status);
1520 }
1521 mBootstrapSocket = RpcTransportFd(std::move(bootstrapFdClient));
1522 mAcceptConnection = &Server::recvmsgServerConnection;
1523 mConnectToServer = [this] { return connectToUnixBootstrap(mBootstrapSocket); };
1524 } break;
Alice Wang893a9912022-10-24 10:44:09 +00001525 case SocketType::UNIX_RAW: {
1526 auto addr = allocateSocketAddress();
1527 auto status = rpcServer->setupRawSocketServer(initUnixSocket(addr));
1528 if (status != OK) {
1529 return AssertionFailure()
1530 << "setupRawSocketServer: " << statusToString(status);
1531 }
1532 mConnectToServer = [addr] {
1533 return connectTo(UnixSocketAddress(addr.c_str()));
1534 };
1535 } break;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001536 case SocketType::VSOCK: {
1537 auto port = allocateVsockPort();
David Brazdila47dfda2022-11-22 22:52:19 +00001538 auto status = rpcServer->setupVsockServer(VMADDR_CID_LOCAL, port);
Yifan Hong1deca4b2021-09-10 16:16:44 -07001539 if (status != OK) {
1540 return AssertionFailure() << "setupVsockServer: " << statusToString(status);
1541 }
1542 mConnectToServer = [port] {
1543 return connectTo(VsockSocketAddress(VMADDR_CID_LOCAL, port));
1544 };
1545 } break;
1546 case SocketType::INET: {
1547 unsigned int port;
1548 auto status = rpcServer->setupInetServer(kLocalInetAddress, 0, &port);
1549 if (status != OK) {
1550 return AssertionFailure() << "setupInetServer: " << statusToString(status);
1551 }
1552 mConnectToServer = [port] {
1553 const char* addr = kLocalInetAddress;
1554 auto aiStart = InetSocketAddress::getAddrInfo(addr, port);
1555 if (aiStart == nullptr) return base::unique_fd{};
1556 for (auto ai = aiStart.get(); ai != nullptr; ai = ai->ai_next) {
1557 auto fd = connectTo(
1558 InetSocketAddress(ai->ai_addr, ai->ai_addrlen, addr, port));
1559 if (fd.ok()) return fd;
1560 }
1561 ALOGE("None of the socket address resolved for %s:%u can be connected",
1562 addr, port);
1563 return base::unique_fd{};
1564 };
Andrei Homescu68a55612022-08-02 01:25:15 +00001565 } break;
1566 case SocketType::TIPC: {
1567 LOG_ALWAYS_FATAL("RpcTransportTest should not be enabled for TIPC");
1568 } break;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001569 }
1570 mFd = rpcServer->releaseServer();
Pawan49d74cb2022-08-03 21:19:11 +00001571 if (!mFd.fd.ok()) return AssertionFailure() << "releaseServer returns invalid fd";
Andrei Homescuf30148c2023-03-10 00:31:45 +00001572 mCtx = newTlsFactory(rpcSecurity, mCertVerifier, std::move(auth))->newServerCtx();
Yifan Hong1deca4b2021-09-10 16:16:44 -07001573 if (mCtx == nullptr) return AssertionFailure() << "newServerCtx";
1574 mSetup = true;
1575 return AssertionSuccess();
1576 }
1577 RpcTransportCtx* getCtx() const { return mCtx.get(); }
1578 std::shared_ptr<RpcCertificateVerifierSimple> getCertVerifier() const {
1579 return mCertVerifier;
1580 }
1581 ConnectToServer getConnectToServerFn() { return mConnectToServer; }
1582 void start() {
1583 LOG_ALWAYS_FATAL_IF(!mSetup, "Call Server::setup first!");
1584 mThread = std::make_unique<std::thread>(&Server::run, this);
1585 }
David Brazdil21c887c2022-09-23 12:25:18 +01001586
1587 base::unique_fd acceptServerConnection() {
1588 return base::unique_fd(TEMP_FAILURE_RETRY(
1589 accept4(mFd.fd.get(), nullptr, nullptr, SOCK_CLOEXEC | SOCK_NONBLOCK)));
1590 }
1591
1592 base::unique_fd recvmsgServerConnection() {
1593 std::vector<std::variant<base::unique_fd, base::borrowed_fd>> fds;
1594 int buf;
1595 iovec iov{&buf, sizeof(buf)};
1596
Tomasz Wasilczyk0d9dec22023-10-06 20:28:49 +00001597 if (binder::os::receiveMessageFromSocket(mFd, &iov, 1, &fds) < 0) {
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -07001598 PLOGF("Failed receiveMessage");
David Brazdil21c887c2022-09-23 12:25:18 +01001599 }
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -07001600 LOG_ALWAYS_FATAL_IF(fds.size() != 1, "Expected one FD from receiveMessage(), got %zu",
1601 fds.size());
David Brazdil21c887c2022-09-23 12:25:18 +01001602 return std::move(std::get<base::unique_fd>(fds[0]));
1603 }
1604
Yifan Hong1deca4b2021-09-10 16:16:44 -07001605 void run() {
1606 LOG_ALWAYS_FATAL_IF(!mSetup, "Call Server::setup first!");
1607
1608 std::vector<std::thread> threads;
1609 while (OK == mFdTrigger->triggerablePoll(mFd, POLLIN)) {
David Brazdil21c887c2022-09-23 12:25:18 +01001610 base::unique_fd acceptedFd = mAcceptConnection(this);
Yifan Hong1deca4b2021-09-10 16:16:44 -07001611 threads.emplace_back(&Server::handleOne, this, std::move(acceptedFd));
1612 }
1613
1614 for (auto& thread : threads) thread.join();
1615 }
1616 void handleOne(android::base::unique_fd acceptedFd) {
1617 ASSERT_TRUE(acceptedFd.ok());
Pawan3e0061c2022-08-26 21:08:34 +00001618 RpcTransportFd transportFd(std::move(acceptedFd));
Pawan49d74cb2022-08-03 21:19:11 +00001619 auto serverTransport = mCtx->newTransport(std::move(transportFd), mFdTrigger.get());
Yifan Hong1deca4b2021-09-10 16:16:44 -07001620 if (serverTransport == nullptr) return; // handshake failed
Yifan Hong67519322021-09-13 18:51:16 -07001621 ASSERT_TRUE(mPostConnect(serverTransport.get(), mFdTrigger.get()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001622 }
Yifan Honge07d2732021-09-13 21:59:14 -07001623 void shutdownAndWait() {
Yifan Hong67519322021-09-13 18:51:16 -07001624 shutdown();
1625 join();
1626 }
1627 void shutdown() { mFdTrigger->trigger(); }
1628
1629 void setPostConnect(
1630 std::function<AssertionResult(RpcTransport*, FdTrigger* fdTrigger)> fn) {
1631 mPostConnect = std::move(fn);
Yifan Hong1deca4b2021-09-10 16:16:44 -07001632 }
1633
1634 private:
1635 std::unique_ptr<std::thread> mThread;
1636 ConnectToServer mConnectToServer;
David Brazdil21c887c2022-09-23 12:25:18 +01001637 AcceptConnection mAcceptConnection = &Server::acceptServerConnection;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001638 std::unique_ptr<FdTrigger> mFdTrigger = FdTrigger::make();
David Brazdil21c887c2022-09-23 12:25:18 +01001639 RpcTransportFd mFd, mBootstrapSocket;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001640 std::unique_ptr<RpcTransportCtx> mCtx;
1641 std::shared_ptr<RpcCertificateVerifierSimple> mCertVerifier =
1642 std::make_shared<RpcCertificateVerifierSimple>();
1643 bool mSetup = false;
Yifan Hong67519322021-09-13 18:51:16 -07001644 // The function invoked after connection and handshake. By default, it is
1645 // |defaultPostConnect| that sends |kMessage| to the client.
1646 std::function<AssertionResult(RpcTransport*, FdTrigger* fdTrigger)> mPostConnect =
1647 Server::defaultPostConnect;
1648
1649 void join() {
1650 if (mThread != nullptr) {
1651 mThread->join();
1652 mThread = nullptr;
1653 }
1654 }
1655
1656 static AssertionResult defaultPostConnect(RpcTransport* serverTransport,
1657 FdTrigger* fdTrigger) {
1658 std::string message(kMessage);
Andrei Homescua39e4ed2021-12-10 08:41:54 +00001659 iovec messageIov{message.data(), message.size()};
Devin Moore695368f2022-06-03 22:29:14 +00001660 auto status = serverTransport->interruptableWriteFully(fdTrigger, &messageIov, 1,
Frederick Mayle69a0c992022-05-26 20:38:39 +00001661 std::nullopt, nullptr);
Yifan Hong67519322021-09-13 18:51:16 -07001662 if (status != OK) return AssertionFailure() << statusToString(status);
1663 return AssertionSuccess();
1664 }
Yifan Hong1deca4b2021-09-10 16:16:44 -07001665 };
1666
1667 class Client {
1668 public:
1669 explicit Client(ConnectToServer connectToServer) : mConnectToServer(connectToServer) {}
1670 Client(Client&&) = default;
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001671 [[nodiscard]] AssertionResult setUp(const Param& param) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001672 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = param;
1673 (void)serverVersion;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001674 mFdTrigger = FdTrigger::make();
Andrei Homescuf30148c2023-03-10 00:31:45 +00001675 mCtx = newTlsFactory(rpcSecurity, mCertVerifier)->newClientCtx();
Yifan Hong1deca4b2021-09-10 16:16:44 -07001676 if (mCtx == nullptr) return AssertionFailure() << "newClientCtx";
1677 return AssertionSuccess();
1678 }
1679 RpcTransportCtx* getCtx() const { return mCtx.get(); }
1680 std::shared_ptr<RpcCertificateVerifierSimple> getCertVerifier() const {
1681 return mCertVerifier;
1682 }
Yifan Hong67519322021-09-13 18:51:16 -07001683 // connect() and do handshake
1684 bool setUpTransport() {
1685 mFd = mConnectToServer();
Pawan49d74cb2022-08-03 21:19:11 +00001686 if (!mFd.fd.ok()) return AssertionFailure() << "Cannot connect to server";
Yifan Hong67519322021-09-13 18:51:16 -07001687 mClientTransport = mCtx->newTransport(std::move(mFd), mFdTrigger.get());
1688 return mClientTransport != nullptr;
1689 }
1690 AssertionResult readMessage(const std::string& expectedMessage = kMessage) {
1691 LOG_ALWAYS_FATAL_IF(mClientTransport == nullptr, "setUpTransport not called or failed");
1692 std::string readMessage(expectedMessage.size(), '\0');
Andrei Homescua39e4ed2021-12-10 08:41:54 +00001693 iovec readMessageIov{readMessage.data(), readMessage.size()};
Devin Moore695368f2022-06-03 22:29:14 +00001694 status_t readStatus =
1695 mClientTransport->interruptableReadFully(mFdTrigger.get(), &readMessageIov, 1,
Frederick Mayleffe9ac22022-06-30 02:07:36 +00001696 std::nullopt, nullptr);
Yifan Hong67519322021-09-13 18:51:16 -07001697 if (readStatus != OK) {
1698 return AssertionFailure() << statusToString(readStatus);
1699 }
1700 if (readMessage != expectedMessage) {
1701 return AssertionFailure()
1702 << "Expected " << expectedMessage << ", actual " << readMessage;
1703 }
1704 return AssertionSuccess();
1705 }
Yifan Hong1deca4b2021-09-10 16:16:44 -07001706 void run(bool handshakeOk = true, bool readOk = true) {
Yifan Hong67519322021-09-13 18:51:16 -07001707 if (!setUpTransport()) {
Yifan Hong1deca4b2021-09-10 16:16:44 -07001708 ASSERT_FALSE(handshakeOk) << "newTransport returns nullptr, but it shouldn't";
1709 return;
1710 }
1711 ASSERT_TRUE(handshakeOk) << "newTransport does not return nullptr, but it should";
Yifan Hong67519322021-09-13 18:51:16 -07001712 ASSERT_EQ(readOk, readMessage());
Yifan Hong1deca4b2021-09-10 16:16:44 -07001713 }
1714
Pawan49d74cb2022-08-03 21:19:11 +00001715 bool isTransportWaiting() { return mClientTransport->isWaiting(); }
1716
Yifan Hong1deca4b2021-09-10 16:16:44 -07001717 private:
1718 ConnectToServer mConnectToServer;
Pawan3e0061c2022-08-26 21:08:34 +00001719 RpcTransportFd mFd;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001720 std::unique_ptr<FdTrigger> mFdTrigger = FdTrigger::make();
1721 std::unique_ptr<RpcTransportCtx> mCtx;
1722 std::shared_ptr<RpcCertificateVerifierSimple> mCertVerifier =
1723 std::make_shared<RpcCertificateVerifierSimple>();
Yifan Hong67519322021-09-13 18:51:16 -07001724 std::unique_ptr<RpcTransport> mClientTransport;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001725 };
1726
1727 // Make A trust B.
1728 template <typename A, typename B>
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001729 static status_t trust(RpcSecurity rpcSecurity,
1730 std::optional<RpcCertificateFormat> certificateFormat, const A& a,
1731 const B& b) {
Yifan Hong1deca4b2021-09-10 16:16:44 -07001732 if (rpcSecurity != RpcSecurity::TLS) return OK;
Yifan Hong22211f82021-09-14 12:32:25 -07001733 LOG_ALWAYS_FATAL_IF(!certificateFormat.has_value());
1734 auto bCert = b->getCtx()->getCertificate(*certificateFormat);
1735 return a->getCertVerifier()->addTrustedPeerCertificate(*certificateFormat, bCert);
Yifan Hong1deca4b2021-09-10 16:16:44 -07001736 }
1737
1738 static constexpr const char* kMessage = "hello";
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001739};
1740
1741class RpcTransportTest : public testing::TestWithParam<RpcTransportTestUtils::Param> {
1742public:
1743 using Server = RpcTransportTestUtils::Server;
1744 using Client = RpcTransportTestUtils::Client;
1745 static inline std::string PrintParamInfo(const testing::TestParamInfo<ParamType>& info) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001746 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = info.param;
Andrei Homescuf30148c2023-03-10 00:31:45 +00001747 auto ret = PrintToString(socketType) + "_" + newTlsFactory(rpcSecurity)->toCString();
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001748 if (certificateFormat.has_value()) ret += "_" + PrintToString(*certificateFormat);
Frederick Mayledc07cf82022-05-26 20:30:12 +00001749 ret += "_serverV" + std::to_string(serverVersion);
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001750 return ret;
1751 }
1752 static std::vector<ParamType> getRpcTranportTestParams() {
1753 std::vector<ParamType> ret;
Frederick Mayledc07cf82022-05-26 20:30:12 +00001754 for (auto serverVersion : testVersions()) {
1755 for (auto socketType : testSocketTypes(false /* hasPreconnected */)) {
1756 for (auto rpcSecurity : RpcSecurityValues()) {
1757 switch (rpcSecurity) {
1758 case RpcSecurity::RAW: {
1759 ret.emplace_back(socketType, rpcSecurity, std::nullopt, serverVersion);
1760 } break;
1761 case RpcSecurity::TLS: {
1762 ret.emplace_back(socketType, rpcSecurity, RpcCertificateFormat::PEM,
1763 serverVersion);
1764 ret.emplace_back(socketType, rpcSecurity, RpcCertificateFormat::DER,
1765 serverVersion);
1766 } break;
1767 }
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001768 }
1769 }
1770 }
1771 return ret;
1772 }
1773 template <typename A, typename B>
1774 status_t trust(const A& a, const B& b) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001775 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = GetParam();
1776 (void)serverVersion;
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001777 return RpcTransportTestUtils::trust(rpcSecurity, certificateFormat, a, b);
1778 }
Andrei Homescu12106de2022-04-27 04:42:21 +00001779 void SetUp() override {
1780 if constexpr (!kEnableRpcThreads) {
1781 GTEST_SKIP() << "Test skipped because threads were disabled at build time";
1782 }
1783 }
Yifan Hong1deca4b2021-09-10 16:16:44 -07001784};
1785
1786TEST_P(RpcTransportTest, GoodCertificate) {
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001787 auto server = std::make_unique<Server>();
1788 ASSERT_TRUE(server->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001789
1790 Client client(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001791 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001792
1793 ASSERT_EQ(OK, trust(&client, server));
1794 ASSERT_EQ(OK, trust(server, &client));
1795
1796 server->start();
1797 client.run();
1798}
1799
1800TEST_P(RpcTransportTest, MultipleClients) {
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001801 auto server = std::make_unique<Server>();
1802 ASSERT_TRUE(server->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001803
1804 std::vector<Client> clients;
1805 for (int i = 0; i < 2; i++) {
1806 auto& client = clients.emplace_back(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001807 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001808 ASSERT_EQ(OK, trust(&client, server));
1809 ASSERT_EQ(OK, trust(server, &client));
1810 }
1811
1812 server->start();
1813 for (auto& client : clients) client.run();
1814}
1815
1816TEST_P(RpcTransportTest, UntrustedServer) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001817 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = GetParam();
1818 (void)serverVersion;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001819
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001820 auto untrustedServer = std::make_unique<Server>();
1821 ASSERT_TRUE(untrustedServer->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001822
1823 Client client(untrustedServer->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001824 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001825
1826 ASSERT_EQ(OK, trust(untrustedServer, &client));
1827
1828 untrustedServer->start();
1829
1830 // For TLS, this should reject the certificate. For RAW sockets, it should pass because
1831 // the client can't verify the server's identity.
1832 bool handshakeOk = rpcSecurity != RpcSecurity::TLS;
1833 client.run(handshakeOk);
1834}
1835TEST_P(RpcTransportTest, MaliciousServer) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001836 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = GetParam();
1837 (void)serverVersion;
1838
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001839 auto validServer = std::make_unique<Server>();
1840 ASSERT_TRUE(validServer->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001841
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001842 auto maliciousServer = std::make_unique<Server>();
1843 ASSERT_TRUE(maliciousServer->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001844
1845 Client client(maliciousServer->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001846 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001847
1848 ASSERT_EQ(OK, trust(&client, validServer));
1849 ASSERT_EQ(OK, trust(validServer, &client));
1850 ASSERT_EQ(OK, trust(maliciousServer, &client));
1851
1852 maliciousServer->start();
1853
1854 // For TLS, this should reject the certificate. For RAW sockets, it should pass because
1855 // the client can't verify the server's identity.
1856 bool handshakeOk = rpcSecurity != RpcSecurity::TLS;
1857 client.run(handshakeOk);
1858}
1859
1860TEST_P(RpcTransportTest, UntrustedClient) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001861 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = GetParam();
1862 (void)serverVersion;
1863
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001864 auto server = std::make_unique<Server>();
1865 ASSERT_TRUE(server->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001866
1867 Client client(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001868 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001869
1870 ASSERT_EQ(OK, trust(&client, server));
1871
1872 server->start();
1873
1874 // For TLS, Client should be able to verify server's identity, so client should see
1875 // do_handshake() successfully executed. However, server shouldn't be able to verify client's
1876 // identity and should drop the connection, so client shouldn't be able to read anything.
1877 bool readOk = rpcSecurity != RpcSecurity::TLS;
1878 client.run(true, readOk);
1879}
1880
1881TEST_P(RpcTransportTest, MaliciousClient) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001882 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = GetParam();
1883 (void)serverVersion;
1884
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001885 auto server = std::make_unique<Server>();
1886 ASSERT_TRUE(server->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001887
1888 Client validClient(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001889 ASSERT_TRUE(validClient.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001890 Client maliciousClient(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001891 ASSERT_TRUE(maliciousClient.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001892
1893 ASSERT_EQ(OK, trust(&validClient, server));
1894 ASSERT_EQ(OK, trust(&maliciousClient, server));
1895
1896 server->start();
1897
1898 // See UntrustedClient.
1899 bool readOk = rpcSecurity != RpcSecurity::TLS;
1900 maliciousClient.run(true, readOk);
1901}
1902
Yifan Hong67519322021-09-13 18:51:16 -07001903TEST_P(RpcTransportTest, Trigger) {
1904 std::string msg2 = ", world!";
1905 std::mutex writeMutex;
1906 std::condition_variable writeCv;
1907 bool shouldContinueWriting = false;
1908 auto serverPostConnect = [&](RpcTransport* serverTransport, FdTrigger* fdTrigger) {
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001909 std::string message(RpcTransportTestUtils::kMessage);
Andrei Homescua39e4ed2021-12-10 08:41:54 +00001910 iovec messageIov{message.data(), message.size()};
Frederick Mayle69a0c992022-05-26 20:38:39 +00001911 auto status = serverTransport->interruptableWriteFully(fdTrigger, &messageIov, 1,
1912 std::nullopt, nullptr);
Yifan Hong67519322021-09-13 18:51:16 -07001913 if (status != OK) return AssertionFailure() << statusToString(status);
1914
1915 {
1916 std::unique_lock<std::mutex> lock(writeMutex);
1917 if (!writeCv.wait_for(lock, 3s, [&] { return shouldContinueWriting; })) {
1918 return AssertionFailure() << "write barrier not cleared in time!";
1919 }
1920 }
1921
Andrei Homescua39e4ed2021-12-10 08:41:54 +00001922 iovec msg2Iov{msg2.data(), msg2.size()};
Frederick Mayle69a0c992022-05-26 20:38:39 +00001923 status = serverTransport->interruptableWriteFully(fdTrigger, &msg2Iov, 1, std::nullopt,
1924 nullptr);
Steven Morelandc591b472021-09-16 13:56:11 -07001925 if (status != DEAD_OBJECT)
Yifan Hong67519322021-09-13 18:51:16 -07001926 return AssertionFailure() << "When FdTrigger is shut down, interruptableWriteFully "
Steven Morelandc591b472021-09-16 13:56:11 -07001927 "should return DEAD_OBJECT, but it is "
Yifan Hong67519322021-09-13 18:51:16 -07001928 << statusToString(status);
1929 return AssertionSuccess();
1930 };
1931
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001932 auto server = std::make_unique<Server>();
1933 ASSERT_TRUE(server->setUp(GetParam()));
Yifan Hong67519322021-09-13 18:51:16 -07001934
1935 // Set up client
1936 Client client(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001937 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong67519322021-09-13 18:51:16 -07001938
1939 // Exchange keys
1940 ASSERT_EQ(OK, trust(&client, server));
1941 ASSERT_EQ(OK, trust(server, &client));
1942
1943 server->setPostConnect(serverPostConnect);
1944
Yifan Hong67519322021-09-13 18:51:16 -07001945 server->start();
1946 // connect() to server and do handshake
1947 ASSERT_TRUE(client.setUpTransport());
Yifan Hong22211f82021-09-14 12:32:25 -07001948 // read the first message. This ensures that server has finished handshake and start handling
1949 // client fd. Server thread should pause at writeCv.wait_for().
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001950 ASSERT_TRUE(client.readMessage(RpcTransportTestUtils::kMessage));
Yifan Hong67519322021-09-13 18:51:16 -07001951 // Trigger server shutdown after server starts handling client FD. This ensures that the second
1952 // write is on an FdTrigger that has been shut down.
1953 server->shutdown();
1954 // Continues server thread to write the second message.
1955 {
Yifan Hong22211f82021-09-14 12:32:25 -07001956 std::lock_guard<std::mutex> lock(writeMutex);
Yifan Hong67519322021-09-13 18:51:16 -07001957 shouldContinueWriting = true;
Yifan Hong67519322021-09-13 18:51:16 -07001958 }
Yifan Hong22211f82021-09-14 12:32:25 -07001959 writeCv.notify_all();
Yifan Hong67519322021-09-13 18:51:16 -07001960 // After this line, server thread unblocks and attempts to write the second message, but
Steven Morelandc591b472021-09-16 13:56:11 -07001961 // shutdown is triggered, so write should failed with DEAD_OBJECT. See |serverPostConnect|.
Yifan Hong67519322021-09-13 18:51:16 -07001962 // On the client side, second read fails with DEAD_OBJECT
1963 ASSERT_FALSE(client.readMessage(msg2));
1964}
1965
Pawan49d74cb2022-08-03 21:19:11 +00001966TEST_P(RpcTransportTest, CheckWaitingForRead) {
1967 std::mutex readMutex;
1968 std::condition_variable readCv;
1969 bool shouldContinueReading = false;
1970 // Server will write data on transport once its started
1971 auto serverPostConnect = [&](RpcTransport* serverTransport, FdTrigger* fdTrigger) {
1972 std::string message(RpcTransportTestUtils::kMessage);
1973 iovec messageIov{message.data(), message.size()};
1974 auto status = serverTransport->interruptableWriteFully(fdTrigger, &messageIov, 1,
1975 std::nullopt, nullptr);
1976 if (status != OK) return AssertionFailure() << statusToString(status);
1977
1978 {
1979 std::unique_lock<std::mutex> lock(readMutex);
1980 shouldContinueReading = true;
1981 lock.unlock();
1982 readCv.notify_all();
1983 }
1984 return AssertionSuccess();
1985 };
1986
1987 // Setup Server and client
1988 auto server = std::make_unique<Server>();
1989 ASSERT_TRUE(server->setUp(GetParam()));
1990
1991 Client client(server->getConnectToServerFn());
1992 ASSERT_TRUE(client.setUp(GetParam()));
1993
1994 ASSERT_EQ(OK, trust(&client, server));
1995 ASSERT_EQ(OK, trust(server, &client));
1996 server->setPostConnect(serverPostConnect);
1997
1998 server->start();
1999 ASSERT_TRUE(client.setUpTransport());
2000 {
2001 // Wait till server writes data
2002 std::unique_lock<std::mutex> lock(readMutex);
2003 ASSERT_TRUE(readCv.wait_for(lock, 3s, [&] { return shouldContinueReading; }));
2004 }
2005
2006 // Since there is no read polling here, we will get polling count 0
2007 ASSERT_FALSE(client.isTransportWaiting());
2008 ASSERT_TRUE(client.readMessage(RpcTransportTestUtils::kMessage));
2009 // Thread should increment polling count, read and decrement polling count
2010 // Again, polling count should be zero here
2011 ASSERT_FALSE(client.isTransportWaiting());
2012
2013 server->shutdown();
2014}
2015
Yifan Hong1deca4b2021-09-10 16:16:44 -07002016INSTANTIATE_TEST_CASE_P(BinderRpc, RpcTransportTest,
Yifan Hong22211f82021-09-14 12:32:25 -07002017 ::testing::ValuesIn(RpcTransportTest::getRpcTranportTestParams()),
Yifan Hong1deca4b2021-09-10 16:16:44 -07002018 RpcTransportTest::PrintParamInfo);
2019
Yifan Hongb1ce80c2021-09-17 22:10:58 -07002020class RpcTransportTlsKeyTest
Frederick Mayledc07cf82022-05-26 20:30:12 +00002021 : public testing::TestWithParam<
2022 std::tuple<SocketType, RpcCertificateFormat, RpcKeyFormat, uint32_t>> {
Yifan Hongb1ce80c2021-09-17 22:10:58 -07002023public:
2024 template <typename A, typename B>
2025 status_t trust(const A& a, const B& b) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00002026 auto [socketType, certificateFormat, keyFormat, serverVersion] = GetParam();
2027 (void)serverVersion;
Yifan Hongb1ce80c2021-09-17 22:10:58 -07002028 return RpcTransportTestUtils::trust(RpcSecurity::TLS, certificateFormat, a, b);
2029 }
2030 static std::string PrintParamInfo(const testing::TestParamInfo<ParamType>& info) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00002031 auto [socketType, certificateFormat, keyFormat, serverVersion] = info.param;
2032 return PrintToString(socketType) + "_certificate_" + PrintToString(certificateFormat) +
2033 "_key_" + PrintToString(keyFormat) + "_serverV" + std::to_string(serverVersion);
Yifan Hongb1ce80c2021-09-17 22:10:58 -07002034 };
2035};
2036
2037TEST_P(RpcTransportTlsKeyTest, PreSignedCertificate) {
Andrei Homescu12106de2022-04-27 04:42:21 +00002038 if constexpr (!kEnableRpcThreads) {
2039 GTEST_SKIP() << "Test skipped because threads were disabled at build time";
2040 }
2041
Frederick Mayledc07cf82022-05-26 20:30:12 +00002042 auto [socketType, certificateFormat, keyFormat, serverVersion] = GetParam();
Yifan Hongb1ce80c2021-09-17 22:10:58 -07002043
2044 std::vector<uint8_t> pkeyData, certData;
2045 {
2046 auto pkey = makeKeyPairForSelfSignedCert();
2047 ASSERT_NE(nullptr, pkey);
2048 auto cert = makeSelfSignedCert(pkey.get(), kCertValidSeconds);
2049 ASSERT_NE(nullptr, cert);
2050 pkeyData = serializeUnencryptedPrivatekey(pkey.get(), keyFormat);
2051 certData = serializeCertificate(cert.get(), certificateFormat);
2052 }
2053
2054 auto desPkey = deserializeUnencryptedPrivatekey(pkeyData, keyFormat);
2055 auto desCert = deserializeCertificate(certData, certificateFormat);
2056 auto auth = std::make_unique<RpcAuthPreSigned>(std::move(desPkey), std::move(desCert));
Frederick Mayledc07cf82022-05-26 20:30:12 +00002057 auto utilsParam = std::make_tuple(socketType, RpcSecurity::TLS,
2058 std::make_optional(certificateFormat), serverVersion);
Yifan Hongb1ce80c2021-09-17 22:10:58 -07002059
2060 auto server = std::make_unique<RpcTransportTestUtils::Server>();
2061 ASSERT_TRUE(server->setUp(utilsParam, std::move(auth)));
2062
2063 RpcTransportTestUtils::Client client(server->getConnectToServerFn());
2064 ASSERT_TRUE(client.setUp(utilsParam));
2065
2066 ASSERT_EQ(OK, trust(&client, server));
2067 ASSERT_EQ(OK, trust(server, &client));
2068
2069 server->start();
2070 client.run();
2071}
2072
2073INSTANTIATE_TEST_CASE_P(
2074 BinderRpc, RpcTransportTlsKeyTest,
2075 testing::Combine(testing::ValuesIn(testSocketTypes(false /* hasPreconnected*/)),
2076 testing::Values(RpcCertificateFormat::PEM, RpcCertificateFormat::DER),
Frederick Mayledc07cf82022-05-26 20:30:12 +00002077 testing::Values(RpcKeyFormat::PEM, RpcKeyFormat::DER),
2078 testing::ValuesIn(testVersions())),
Yifan Hongb1ce80c2021-09-17 22:10:58 -07002079 RpcTransportTlsKeyTest::PrintParamInfo);
Andrei Homescud65666d2023-03-03 07:28:02 +00002080#endif // BINDER_RPC_TO_TRUSTY_TEST
Yifan Hongb1ce80c2021-09-17 22:10:58 -07002081
Steven Morelandc1635952021-04-01 16:20:47 +00002082} // namespace android
2083
2084int main(int argc, char** argv) {
Steven Moreland5553ac42020-11-11 02:14:45 +00002085 ::testing::InitGoogleTest(&argc, argv);
Tomasz Wasilczyke3de8802023-11-01 11:05:27 -07002086 __android_log_set_logger(__android_log_stderr_logger);
Steven Morelanda83191d2021-10-27 10:14:53 -07002087
Steven Moreland5553ac42020-11-11 02:14:45 +00002088 return RUN_ALL_TESTS();
2089}