blob: e454a039849e255696fc03c789b1825dc1b47b68 [file] [log] [blame]
Steven Moreland5553ac42020-11-11 02:14:45 +00001/*
2 * Copyright (C) 2020 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Andrei Homescu9d8adb12022-08-02 04:38:30 +000017#include <aidl/IBinderRpcTest.h>
Frederick Maylea12b0962022-06-25 01:13:22 +000018#include <android-base/stringprintf.h>
Steven Moreland5553ac42020-11-11 02:14:45 +000019
Steven Morelandc1635952021-04-01 16:20:47 +000020#include <chrono>
21#include <cstdlib>
22#include <iostream>
23#include <thread>
Steven Moreland659416d2021-05-11 00:47:50 +000024#include <type_traits>
Steven Morelandc1635952021-04-01 16:20:47 +000025
Andrei Homescu2a298012022-06-15 01:08:54 +000026#include <dlfcn.h>
Yifan Hong1deca4b2021-09-10 16:16:44 -070027#include <poll.h>
Steven Morelandc1635952021-04-01 16:20:47 +000028#include <sys/prctl.h>
Andrei Homescu992a4052022-06-28 21:26:18 +000029#include <sys/socket.h>
Steven Morelandc1635952021-04-01 16:20:47 +000030
Andrei Homescu68a55612022-08-02 01:25:15 +000031#ifdef __ANDROID_VENDOR__
32#include <binder/RpcTransportTipcAndroid.h>
33#include <trusty/tipc.h>
34#endif // __ANDROID_VENDOR__
35
Andrei Homescu2a298012022-06-15 01:08:54 +000036#include "binderRpcTestCommon.h"
Andrei Homescu96834632022-10-14 00:49:49 +000037#include "binderRpcTestFixture.h"
Steven Moreland5553ac42020-11-11 02:14:45 +000038
Yifan Hong1a235852021-05-13 16:07:47 -070039using namespace std::chrono_literals;
Yifan Hong67519322021-09-13 18:51:16 -070040using namespace std::placeholders;
Yifan Hong1deca4b2021-09-10 16:16:44 -070041using testing::AssertionFailure;
42using testing::AssertionResult;
43using testing::AssertionSuccess;
Yifan Hong1a235852021-05-13 16:07:47 -070044
Steven Moreland5553ac42020-11-11 02:14:45 +000045namespace android {
46
Andrei Homescu12106de2022-04-27 04:42:21 +000047#ifdef BINDER_TEST_NO_SHARED_LIBS
48constexpr bool kEnableSharedLibs = false;
49#else
50constexpr bool kEnableSharedLibs = true;
51#endif
52
Andrei Homescu68a55612022-08-02 01:25:15 +000053#ifdef __ANDROID_VENDOR__
54constexpr char kTrustyIpcDevice[] = "/dev/trusty-ipc-dev0";
55#endif
56
Frederick Maylea12b0962022-06-25 01:13:22 +000057static std::string WaitStatusToString(int wstatus) {
58 if (WIFEXITED(wstatus)) {
59 return base::StringPrintf("exit status %d", WEXITSTATUS(wstatus));
60 }
61 if (WIFSIGNALED(wstatus)) {
62 return base::StringPrintf("term signal %d", WTERMSIG(wstatus));
63 }
64 return base::StringPrintf("unexpected state %d", wstatus);
65}
66
Steven Moreland276d8df2022-09-28 23:56:39 +000067static void debugBacktrace(pid_t pid) {
68 std::cerr << "TAKING BACKTRACE FOR PID " << pid << std::endl;
69 system((std::string("debuggerd -b ") + std::to_string(pid)).c_str());
70}
71
Steven Moreland5553ac42020-11-11 02:14:45 +000072class Process {
73public:
Andrei Homescu96834632022-10-14 00:49:49 +000074 Process(Process&& other)
75 : mCustomExitStatusCheck(std::move(other.mCustomExitStatusCheck)),
76 mReadEnd(std::move(other.mReadEnd)),
77 mWriteEnd(std::move(other.mWriteEnd)) {
78 // The default move constructor doesn't clear mPid after moving it,
79 // which we need to do because the destructor checks for mPid!=0
80 mPid = other.mPid;
81 other.mPid = 0;
82 }
Yifan Hong1deca4b2021-09-10 16:16:44 -070083 Process(const std::function<void(android::base::borrowed_fd /* writeEnd */,
84 android::base::borrowed_fd /* readEnd */)>& f) {
85 android::base::unique_fd childWriteEnd;
86 android::base::unique_fd childReadEnd;
Andrei Homescu2a298012022-06-15 01:08:54 +000087 CHECK(android::base::Pipe(&mReadEnd, &childWriteEnd, 0)) << strerror(errno);
88 CHECK(android::base::Pipe(&childReadEnd, &mWriteEnd, 0)) << strerror(errno);
Steven Moreland5553ac42020-11-11 02:14:45 +000089 if (0 == (mPid = fork())) {
90 // racey: assume parent doesn't crash before this is set
91 prctl(PR_SET_PDEATHSIG, SIGHUP);
92
Yifan Hong1deca4b2021-09-10 16:16:44 -070093 f(childWriteEnd, childReadEnd);
Steven Morelandaf4ca712021-05-24 23:22:08 +000094
95 exit(0);
Steven Moreland5553ac42020-11-11 02:14:45 +000096 }
97 }
98 ~Process() {
99 if (mPid != 0) {
Frederick Maylea12b0962022-06-25 01:13:22 +0000100 int wstatus;
101 waitpid(mPid, &wstatus, 0);
102 if (mCustomExitStatusCheck) {
103 mCustomExitStatusCheck(wstatus);
104 } else {
105 EXPECT_TRUE(WIFEXITED(wstatus) && WEXITSTATUS(wstatus) == 0)
106 << "server process failed: " << WaitStatusToString(wstatus);
107 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000108 }
109 }
Yifan Hong0f58fb92021-06-16 16:09:23 -0700110 android::base::borrowed_fd readEnd() { return mReadEnd; }
Yifan Hong1deca4b2021-09-10 16:16:44 -0700111 android::base::borrowed_fd writeEnd() { return mWriteEnd; }
Steven Moreland5553ac42020-11-11 02:14:45 +0000112
Frederick Maylea12b0962022-06-25 01:13:22 +0000113 void setCustomExitStatusCheck(std::function<void(int wstatus)> f) {
114 mCustomExitStatusCheck = std::move(f);
115 }
116
Frederick Mayle69a0c992022-05-26 20:38:39 +0000117 // Kill the process. Avoid if possible. Shutdown gracefully via an RPC instead.
118 void terminate() { kill(mPid, SIGTERM); }
119
Steven Moreland276d8df2022-09-28 23:56:39 +0000120 pid_t getPid() { return mPid; }
121
Steven Moreland5553ac42020-11-11 02:14:45 +0000122private:
Frederick Maylea12b0962022-06-25 01:13:22 +0000123 std::function<void(int wstatus)> mCustomExitStatusCheck;
Steven Moreland5553ac42020-11-11 02:14:45 +0000124 pid_t mPid = 0;
Yifan Hong0f58fb92021-06-16 16:09:23 -0700125 android::base::unique_fd mReadEnd;
Yifan Hong1deca4b2021-09-10 16:16:44 -0700126 android::base::unique_fd mWriteEnd;
Steven Moreland5553ac42020-11-11 02:14:45 +0000127};
128
129static std::string allocateSocketAddress() {
130 static size_t id = 0;
Steven Moreland4bfbf2e2021-04-14 22:15:16 +0000131 std::string temp = getenv("TMPDIR") ?: "/tmp";
Yifan Hong1deca4b2021-09-10 16:16:44 -0700132 auto ret = temp + "/binderRpcTest_" + std::to_string(id++);
133 unlink(ret.c_str());
134 return ret;
Steven Moreland5553ac42020-11-11 02:14:45 +0000135};
136
Steven Morelandda573042021-06-12 01:13:45 +0000137static unsigned int allocateVsockPort() {
Andrei Homescu2a298012022-06-15 01:08:54 +0000138 static unsigned int vsockPort = 34567;
Steven Morelandda573042021-06-12 01:13:45 +0000139 return vsockPort++;
140}
141
Alice Wang893a9912022-10-24 10:44:09 +0000142static base::unique_fd initUnixSocket(std::string addr) {
143 auto socket_addr = UnixSocketAddress(addr.c_str());
144 base::unique_fd fd(
145 TEMP_FAILURE_RETRY(socket(socket_addr.addr()->sa_family, SOCK_STREAM, AF_UNIX)));
146 CHECK(fd.ok());
147 CHECK_EQ(0, TEMP_FAILURE_RETRY(bind(fd.get(), socket_addr.addr(), socket_addr.addrSize())));
148 return fd;
149}
150
Andrei Homescu96834632022-10-14 00:49:49 +0000151// Destructors need to be defined, even if pure virtual
152ProcessSession::~ProcessSession() {}
153
154class LinuxProcessSession : public ProcessSession {
155public:
Steven Moreland5553ac42020-11-11 02:14:45 +0000156 // reference to process hosting a socket server
157 Process host;
158
Andrei Homescu96834632022-10-14 00:49:49 +0000159 LinuxProcessSession(LinuxProcessSession&&) = default;
160 LinuxProcessSession(Process&& host) : host(std::move(host)) {}
161 ~LinuxProcessSession() override {
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000162 for (auto& session : sessions) {
163 session.root = nullptr;
Steven Moreland736664b2021-05-01 04:27:25 +0000164 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000165
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000166 for (auto& info : sessions) {
167 sp<RpcSession>& session = info.session;
Steven Moreland736664b2021-05-01 04:27:25 +0000168
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000169 EXPECT_NE(nullptr, session);
170 EXPECT_NE(nullptr, session->state());
171 EXPECT_EQ(0, session->state()->countBinders()) << (session->state()->dump(), "dump:");
Steven Moreland736664b2021-05-01 04:27:25 +0000172
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000173 wp<RpcSession> weakSession = session;
174 session = nullptr;
Steven Moreland276d8df2022-09-28 23:56:39 +0000175
Steven Moreland57042712022-10-04 23:56:45 +0000176 // b/244325464 - 'getStrongCount' is printing '1' on failure here, which indicates the
177 // the object should not actually be promotable. By looping, we distinguish a race here
178 // from a bug causing the object to not be promotable.
179 for (size_t i = 0; i < 3; i++) {
180 sp<RpcSession> strongSession = weakSession.promote();
181 EXPECT_EQ(nullptr, strongSession)
182 << (debugBacktrace(host.getPid()), debugBacktrace(getpid()),
183 "Leaked sess: ")
184 << strongSession->getStrongCount() << " checked time " << i;
185
186 if (strongSession != nullptr) {
187 sleep(1);
188 }
189 }
Steven Moreland736664b2021-05-01 04:27:25 +0000190 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000191 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000192
Andrei Homescu96834632022-10-14 00:49:49 +0000193 void setCustomExitStatusCheck(std::function<void(int wstatus)> f) override {
194 host.setCustomExitStatusCheck(std::move(f));
Steven Moreland5553ac42020-11-11 02:14:45 +0000195 }
Andrei Homescu96834632022-10-14 00:49:49 +0000196
197 void terminate() override { host.terminate(); }
Steven Moreland5553ac42020-11-11 02:14:45 +0000198};
199
Yifan Hong1deca4b2021-09-10 16:16:44 -0700200static base::unique_fd connectTo(const RpcSocketAddress& addr) {
Steven Moreland4198a122021-08-03 17:37:58 -0700201 base::unique_fd serverFd(
202 TEMP_FAILURE_RETRY(socket(addr.addr()->sa_family, SOCK_STREAM | SOCK_CLOEXEC, 0)));
203 int savedErrno = errno;
Yifan Hong1deca4b2021-09-10 16:16:44 -0700204 CHECK(serverFd.ok()) << "Could not create socket " << addr.toString() << ": "
205 << strerror(savedErrno);
Steven Moreland4198a122021-08-03 17:37:58 -0700206
207 if (0 != TEMP_FAILURE_RETRY(connect(serverFd.get(), addr.addr(), addr.addrSize()))) {
208 int savedErrno = errno;
Yifan Hong1deca4b2021-09-10 16:16:44 -0700209 LOG(FATAL) << "Could not connect to socket " << addr.toString() << ": "
210 << strerror(savedErrno);
Steven Moreland4198a122021-08-03 17:37:58 -0700211 }
212 return serverFd;
213}
214
David Brazdil21c887c2022-09-23 12:25:18 +0100215static base::unique_fd connectToUnixBootstrap(const RpcTransportFd& transportFd) {
216 base::unique_fd sockClient, sockServer;
217 if (!base::Socketpair(SOCK_STREAM, &sockClient, &sockServer)) {
218 int savedErrno = errno;
219 LOG(FATAL) << "Failed socketpair(): " << strerror(savedErrno);
220 }
221
222 int zero = 0;
223 iovec iov{&zero, sizeof(zero)};
224 std::vector<std::variant<base::unique_fd, base::borrowed_fd>> fds;
225 fds.emplace_back(std::move(sockServer));
226
227 if (sendMessageOnSocket(transportFd, &iov, 1, &fds) < 0) {
228 int savedErrno = errno;
229 LOG(FATAL) << "Failed sendMessageOnSocket: " << strerror(savedErrno);
230 }
231 return std::move(sockClient);
232}
233
Andrei Homescu96834632022-10-14 00:49:49 +0000234std::string BinderRpc::PrintParamInfo(const testing::TestParamInfo<ParamType>& info) {
235 auto [type, security, clientVersion, serverVersion, singleThreaded, noKernel] = info.param;
236 auto ret = PrintToString(type) + "_" + newFactory(security)->toCString() + "_clientV" +
237 std::to_string(clientVersion) + "_serverV" + std::to_string(serverVersion);
238 if (singleThreaded) {
239 ret += "_single_threaded";
240 }
241 if (noKernel) {
242 ret += "_no_kernel";
243 }
244 return ret;
245}
Andrei Homescu2a298012022-06-15 01:08:54 +0000246
Andrei Homescu96834632022-10-14 00:49:49 +0000247// This creates a new process serving an interface on a certain number of
248// threads.
249std::unique_ptr<ProcessSession> BinderRpc::createRpcTestSocketServerProcessEtc(
250 const BinderRpcOptions& options) {
251 CHECK_GE(options.numSessions, 1) << "Must have at least one session to a server";
Frederick Mayle69a0c992022-05-26 20:38:39 +0000252
Andrei Homescu96834632022-10-14 00:49:49 +0000253 SocketType socketType = std::get<0>(GetParam());
254 RpcSecurity rpcSecurity = std::get<1>(GetParam());
255 uint32_t clientVersion = std::get<2>(GetParam());
256 uint32_t serverVersion = std::get<3>(GetParam());
257 bool singleThreaded = std::get<4>(GetParam());
258 bool noKernel = std::get<5>(GetParam());
259
260 std::string path = android::base::GetExecutableDirectory();
261 auto servicePath = android::base::StringPrintf("%s/binder_rpc_test_service%s%s", path.c_str(),
262 singleThreaded ? "_single_threaded" : "",
263 noKernel ? "_no_kernel" : "");
264
Alice Wang1ef010b2022-11-14 09:09:25 +0000265 base::unique_fd bootstrapClientFd, socketFd;
266
Alice Wang893a9912022-10-24 10:44:09 +0000267 auto addr = allocateSocketAddress();
268 // Initializes the socket before the fork/exec.
269 if (socketType == SocketType::UNIX_RAW) {
270 socketFd = initUnixSocket(addr);
Alice Wang1ef010b2022-11-14 09:09:25 +0000271 } else if (socketType == SocketType::UNIX_BOOTSTRAP) {
272 // Do not set O_CLOEXEC, bootstrapServerFd needs to survive fork/exec.
273 // This is because we cannot pass ParcelFileDescriptor over a pipe.
274 if (!base::Socketpair(SOCK_STREAM, &bootstrapClientFd, &socketFd)) {
275 int savedErrno = errno;
276 LOG(FATAL) << "Failed socketpair(): " << strerror(savedErrno);
277 }
Alice Wang893a9912022-10-24 10:44:09 +0000278 }
Andrei Homescua858b0e2022-08-01 23:43:09 +0000279
Andrei Homescu96834632022-10-14 00:49:49 +0000280 auto ret = std::make_unique<LinuxProcessSession>(
281 Process([=](android::base::borrowed_fd writeEnd, android::base::borrowed_fd readEnd) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000282 if (socketType == SocketType::TIPC) {
283 // Trusty has a single persistent service
284 return;
285 }
286
Andrei Homescu96834632022-10-14 00:49:49 +0000287 auto writeFd = std::to_string(writeEnd.get());
288 auto readFd = std::to_string(readEnd.get());
289 execl(servicePath.c_str(), servicePath.c_str(), writeFd.c_str(), readFd.c_str(),
290 NULL);
291 }));
292
293 BinderRpcTestServerConfig serverConfig;
294 serverConfig.numThreads = options.numThreads;
295 serverConfig.socketType = static_cast<int32_t>(socketType);
296 serverConfig.rpcSecurity = static_cast<int32_t>(rpcSecurity);
297 serverConfig.serverVersion = serverVersion;
298 serverConfig.vsockPort = allocateVsockPort();
Alice Wang893a9912022-10-24 10:44:09 +0000299 serverConfig.addr = addr;
Alice Wang893a9912022-10-24 10:44:09 +0000300 serverConfig.socketFd = socketFd.get();
Andrei Homescu96834632022-10-14 00:49:49 +0000301 for (auto mode : options.serverSupportedFileDescriptorTransportModes) {
302 serverConfig.serverSupportedFileDescriptorTransportModes.push_back(
303 static_cast<int32_t>(mode));
304 }
Andrei Homescu68a55612022-08-02 01:25:15 +0000305 if (socketType != SocketType::TIPC) {
306 writeToFd(ret->host.writeEnd(), serverConfig);
307 }
Andrei Homescu96834632022-10-14 00:49:49 +0000308
309 std::vector<sp<RpcSession>> sessions;
310 auto certVerifier = std::make_shared<RpcCertificateVerifierSimple>();
311 for (size_t i = 0; i < options.numSessions; i++) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000312 std::unique_ptr<RpcTransportCtxFactory> factory;
313 if (socketType == SocketType::TIPC) {
314#ifdef __ANDROID_VENDOR__
315 factory = RpcTransportCtxFactoryTipcAndroid::make();
316#else
317 LOG_ALWAYS_FATAL("TIPC socket type only supported on vendor");
318#endif
319 } else {
320 factory = newFactory(rpcSecurity, certVerifier);
321 }
322 sessions.emplace_back(RpcSession::make(std::move(factory)));
David Brazdil21c887c2022-09-23 12:25:18 +0100323 }
324
Andrei Homescu68a55612022-08-02 01:25:15 +0000325 BinderRpcTestServerInfo serverInfo;
326 if (socketType != SocketType::TIPC) {
327 serverInfo = readFromFd<BinderRpcTestServerInfo>(ret->host.readEnd());
328 BinderRpcTestClientInfo clientInfo;
329 for (const auto& session : sessions) {
330 auto& parcelableCert = clientInfo.certs.emplace_back();
331 parcelableCert.data = session->getCertificate(RpcCertificateFormat::PEM);
332 }
333 writeToFd(ret->host.writeEnd(), clientInfo);
Andrei Homescu96834632022-10-14 00:49:49 +0000334
Andrei Homescu68a55612022-08-02 01:25:15 +0000335 CHECK_LE(serverInfo.port, std::numeric_limits<unsigned int>::max());
336 if (socketType == SocketType::INET) {
337 CHECK_NE(0, serverInfo.port);
338 }
Frederick Mayle69a0c992022-05-26 20:38:39 +0000339
Andrei Homescu68a55612022-08-02 01:25:15 +0000340 if (rpcSecurity == RpcSecurity::TLS) {
341 const auto& serverCert = serverInfo.cert.data;
342 CHECK_EQ(OK,
343 certVerifier->addTrustedPeerCertificate(RpcCertificateFormat::PEM,
344 serverCert));
345 }
Yifan Hong1deca4b2021-09-10 16:16:44 -0700346 }
347
Andrei Homescu96834632022-10-14 00:49:49 +0000348 status_t status;
Steven Moreland736664b2021-05-01 04:27:25 +0000349
Andrei Homescu96834632022-10-14 00:49:49 +0000350 for (const auto& session : sessions) {
351 CHECK(session->setProtocolVersion(clientVersion));
352 session->setMaxIncomingThreads(options.numIncomingConnections);
Steven Morelandfeb13e82023-03-01 01:25:33 +0000353 session->setMaxOutgoingConnections(options.numOutgoingConnections);
Andrei Homescu96834632022-10-14 00:49:49 +0000354 session->setFileDescriptorTransportMode(options.clientFileDescriptorTransportMode);
Steven Morelandc1635952021-04-01 16:20:47 +0000355
Andrei Homescu96834632022-10-14 00:49:49 +0000356 switch (socketType) {
357 case SocketType::PRECONNECTED:
358 status = session->setupPreconnectedClient({}, [=]() {
359 return connectTo(UnixSocketAddress(serverConfig.addr.c_str()));
360 });
Frederick Mayle69a0c992022-05-26 20:38:39 +0000361 break;
Alice Wang893a9912022-10-24 10:44:09 +0000362 case SocketType::UNIX_RAW:
Andrei Homescu96834632022-10-14 00:49:49 +0000363 case SocketType::UNIX:
364 status = session->setupUnixDomainClient(serverConfig.addr.c_str());
365 break;
366 case SocketType::UNIX_BOOTSTRAP:
367 status = session->setupUnixDomainSocketBootstrapClient(
368 base::unique_fd(dup(bootstrapClientFd.get())));
369 break;
370 case SocketType::VSOCK:
371 status = session->setupVsockClient(VMADDR_CID_LOCAL, serverConfig.vsockPort);
372 break;
373 case SocketType::INET:
374 status = session->setupInetClient("127.0.0.1", serverInfo.port);
375 break;
Andrei Homescu68a55612022-08-02 01:25:15 +0000376 case SocketType::TIPC:
377 status = session->setupPreconnectedClient({}, [=]() {
378#ifdef __ANDROID_VENDOR__
379 auto port = trustyIpcPort(serverVersion);
380 int tipcFd = tipc_connect(kTrustyIpcDevice, port.c_str());
381 return tipcFd >= 0 ? android::base::unique_fd(tipcFd)
382 : android::base::unique_fd();
383#else
384 LOG_ALWAYS_FATAL("Tried to connect to Trusty outside of vendor");
385 return android::base::unique_fd();
386#endif
387 });
388 break;
Andrei Homescu96834632022-10-14 00:49:49 +0000389 default:
390 LOG_ALWAYS_FATAL("Unknown socket type");
Steven Morelandc1635952021-04-01 16:20:47 +0000391 }
Andrei Homescu96834632022-10-14 00:49:49 +0000392 if (options.allowConnectFailure && status != OK) {
393 ret->sessions.clear();
394 break;
395 }
396 CHECK_EQ(status, OK) << "Could not connect: " << statusToString(status);
397 ret->sessions.push_back({session, session->getRootObject()});
Steven Morelandc1635952021-04-01 16:20:47 +0000398 }
Andrei Homescu96834632022-10-14 00:49:49 +0000399 return ret;
400}
Steven Morelandc1635952021-04-01 16:20:47 +0000401
Andrei Homescua858b0e2022-08-01 23:43:09 +0000402TEST_P(BinderRpc, ThreadPoolGreaterThanEqualRequested) {
403 if (clientOrServerSingleThreaded()) {
404 GTEST_SKIP() << "This test requires multiple threads";
405 }
406
Steven Moreland5553ac42020-11-11 02:14:45 +0000407 constexpr size_t kNumThreads = 10;
408
Steven Moreland4313d7e2021-07-15 23:41:22 +0000409 auto proc = createRpcTestSocketServerProcess({.numThreads = kNumThreads});
Steven Moreland5553ac42020-11-11 02:14:45 +0000410
411 EXPECT_OK(proc.rootIface->lock());
412
413 // block all but one thread taking locks
414 std::vector<std::thread> ts;
415 for (size_t i = 0; i < kNumThreads - 1; i++) {
416 ts.push_back(std::thread([&] { proc.rootIface->lockUnlock(); }));
417 }
418
Steven Morelandd6d816f2022-12-23 01:37:17 +0000419 usleep(100000); // give chance for calls on other threads
Steven Moreland5553ac42020-11-11 02:14:45 +0000420
421 // other calls still work
422 EXPECT_EQ(OK, proc.rootBinder->pingBinder());
423
Steven Morelandd6d816f2022-12-23 01:37:17 +0000424 constexpr size_t blockTimeMs = 100;
Steven Moreland5553ac42020-11-11 02:14:45 +0000425 size_t epochMsBefore = epochMillis();
426 // after this, we should never see a response within this time
427 EXPECT_OK(proc.rootIface->unlockInMsAsync(blockTimeMs));
428
429 // this call should be blocked for blockTimeMs
430 EXPECT_EQ(OK, proc.rootBinder->pingBinder());
431
432 size_t epochMsAfter = epochMillis();
433 EXPECT_GE(epochMsAfter, epochMsBefore + blockTimeMs) << epochMsBefore;
434
435 for (auto& t : ts) t.join();
436}
437
Andrei Homescu96834632022-10-14 00:49:49 +0000438static void testThreadPoolOverSaturated(sp<IBinderRpcTest> iface, size_t numCalls,
439 size_t sleepMs = 500) {
Steven Moreland5553ac42020-11-11 02:14:45 +0000440 size_t epochMsBefore = epochMillis();
441
442 std::vector<std::thread> ts;
Yifan Hong1f44f982021-10-08 17:16:47 -0700443 for (size_t i = 0; i < numCalls; i++) {
444 ts.push_back(std::thread([&] { iface->sleepMs(sleepMs); }));
Steven Moreland5553ac42020-11-11 02:14:45 +0000445 }
446
447 for (auto& t : ts) t.join();
448
449 size_t epochMsAfter = epochMillis();
450
Yifan Hong1f44f982021-10-08 17:16:47 -0700451 EXPECT_GE(epochMsAfter, epochMsBefore + 2 * sleepMs);
Steven Moreland5553ac42020-11-11 02:14:45 +0000452
453 // Potential flake, but make sure calls are handled in parallel.
Yifan Hong1f44f982021-10-08 17:16:47 -0700454 EXPECT_LE(epochMsAfter, epochMsBefore + 3 * sleepMs);
455}
456
Andrei Homescua858b0e2022-08-01 23:43:09 +0000457TEST_P(BinderRpc, ThreadPoolOverSaturated) {
458 if (clientOrServerSingleThreaded()) {
459 GTEST_SKIP() << "This test requires multiple threads";
460 }
461
Yifan Hong1f44f982021-10-08 17:16:47 -0700462 constexpr size_t kNumThreads = 10;
463 constexpr size_t kNumCalls = kNumThreads + 3;
464 auto proc = createRpcTestSocketServerProcess({.numThreads = kNumThreads});
465 testThreadPoolOverSaturated(proc.rootIface, kNumCalls);
466}
467
Andrei Homescua858b0e2022-08-01 23:43:09 +0000468TEST_P(BinderRpc, ThreadPoolLimitOutgoing) {
469 if (clientOrServerSingleThreaded()) {
470 GTEST_SKIP() << "This test requires multiple threads";
471 }
472
Yifan Hong1f44f982021-10-08 17:16:47 -0700473 constexpr size_t kNumThreads = 20;
474 constexpr size_t kNumOutgoingConnections = 10;
475 constexpr size_t kNumCalls = kNumOutgoingConnections + 3;
476 auto proc = createRpcTestSocketServerProcess(
477 {.numThreads = kNumThreads, .numOutgoingConnections = kNumOutgoingConnections});
478 testThreadPoolOverSaturated(proc.rootIface, kNumCalls);
Steven Moreland5553ac42020-11-11 02:14:45 +0000479}
480
Andrei Homescua858b0e2022-08-01 23:43:09 +0000481TEST_P(BinderRpc, ThreadingStressTest) {
482 if (clientOrServerSingleThreaded()) {
483 GTEST_SKIP() << "This test requires multiple threads";
484 }
485
Steven Moreland5553ac42020-11-11 02:14:45 +0000486 constexpr size_t kNumClientThreads = 10;
487 constexpr size_t kNumServerThreads = 10;
488 constexpr size_t kNumCalls = 100;
489
Steven Moreland4313d7e2021-07-15 23:41:22 +0000490 auto proc = createRpcTestSocketServerProcess({.numThreads = kNumServerThreads});
Steven Moreland5553ac42020-11-11 02:14:45 +0000491
492 std::vector<std::thread> threads;
493 for (size_t i = 0; i < kNumClientThreads; i++) {
494 threads.push_back(std::thread([&] {
495 for (size_t j = 0; j < kNumCalls; j++) {
496 sp<IBinder> out;
Steven Morelandc6046982021-04-20 00:49:42 +0000497 EXPECT_OK(proc.rootIface->repeatBinder(proc.rootBinder, &out));
Steven Moreland5553ac42020-11-11 02:14:45 +0000498 EXPECT_EQ(proc.rootBinder, out);
499 }
500 }));
501 }
502
503 for (auto& t : threads) t.join();
504}
505
Steven Moreland925ba0a2021-09-17 18:06:32 -0700506static void saturateThreadPool(size_t threadCount, const sp<IBinderRpcTest>& iface) {
507 std::vector<std::thread> threads;
508 for (size_t i = 0; i < threadCount; i++) {
509 threads.push_back(std::thread([&] { EXPECT_OK(iface->sleepMs(500)); }));
510 }
511 for (auto& t : threads) t.join();
512}
513
Andrei Homescua858b0e2022-08-01 23:43:09 +0000514TEST_P(BinderRpc, OnewayStressTest) {
515 if (clientOrServerSingleThreaded()) {
516 GTEST_SKIP() << "This test requires multiple threads";
517 }
518
Steven Morelandc6046982021-04-20 00:49:42 +0000519 constexpr size_t kNumClientThreads = 10;
520 constexpr size_t kNumServerThreads = 10;
Steven Moreland3c3ab8d2021-09-23 10:29:50 -0700521 constexpr size_t kNumCalls = 1000;
Steven Morelandc6046982021-04-20 00:49:42 +0000522
Steven Moreland4313d7e2021-07-15 23:41:22 +0000523 auto proc = createRpcTestSocketServerProcess({.numThreads = kNumServerThreads});
Steven Morelandc6046982021-04-20 00:49:42 +0000524
525 std::vector<std::thread> threads;
526 for (size_t i = 0; i < kNumClientThreads; i++) {
527 threads.push_back(std::thread([&] {
528 for (size_t j = 0; j < kNumCalls; j++) {
529 EXPECT_OK(proc.rootIface->sendString("a"));
530 }
Steven Morelandc6046982021-04-20 00:49:42 +0000531 }));
532 }
533
534 for (auto& t : threads) t.join();
Steven Moreland925ba0a2021-09-17 18:06:32 -0700535
536 saturateThreadPool(kNumServerThreads, proc.rootIface);
Steven Morelandc6046982021-04-20 00:49:42 +0000537}
538
Frederick Mayleb0221d12022-10-03 23:10:53 +0000539TEST_P(BinderRpc, OnewayCallQueueingWithFds) {
540 if (!supportsFdTransport()) {
541 GTEST_SKIP() << "Would fail trivially (which is tested elsewhere)";
542 }
543 if (clientOrServerSingleThreaded()) {
544 GTEST_SKIP() << "This test requires multiple threads";
545 }
546
Andrei Homescu5f2bc562023-02-25 04:59:43 +0000547 constexpr size_t kNumServerThreads = 3;
548
Frederick Mayleb0221d12022-10-03 23:10:53 +0000549 // This test forces a oneway transaction to be queued by issuing two
550 // `blockingSendFdOneway` calls, then drains the queue by issuing two
551 // `blockingRecvFd` calls.
552 //
553 // For more details about the queuing semantics see
554 // https://developer.android.com/reference/android/os/IBinder#FLAG_ONEWAY
555
556 auto proc = createRpcTestSocketServerProcess({
Andrei Homescu5f2bc562023-02-25 04:59:43 +0000557 .numThreads = kNumServerThreads,
Frederick Mayleb0221d12022-10-03 23:10:53 +0000558 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
559 .serverSupportedFileDescriptorTransportModes =
560 {RpcSession::FileDescriptorTransportMode::UNIX},
561 });
562
563 EXPECT_OK(proc.rootIface->blockingSendFdOneway(
564 android::os::ParcelFileDescriptor(mockFileDescriptor("a"))));
565 EXPECT_OK(proc.rootIface->blockingSendFdOneway(
566 android::os::ParcelFileDescriptor(mockFileDescriptor("b"))));
567
568 android::os::ParcelFileDescriptor fdA;
569 EXPECT_OK(proc.rootIface->blockingRecvFd(&fdA));
570 std::string result;
571 CHECK(android::base::ReadFdToString(fdA.get(), &result));
572 EXPECT_EQ(result, "a");
573
574 android::os::ParcelFileDescriptor fdB;
575 EXPECT_OK(proc.rootIface->blockingRecvFd(&fdB));
576 CHECK(android::base::ReadFdToString(fdB.get(), &result));
577 EXPECT_EQ(result, "b");
Andrei Homescu5f2bc562023-02-25 04:59:43 +0000578
579 saturateThreadPool(kNumServerThreads, proc.rootIface);
Frederick Mayleb0221d12022-10-03 23:10:53 +0000580}
581
Andrei Homescua858b0e2022-08-01 23:43:09 +0000582TEST_P(BinderRpc, OnewayCallQueueing) {
583 if (clientOrServerSingleThreaded()) {
584 GTEST_SKIP() << "This test requires multiple threads";
585 }
586
Frederick Mayle96872592023-03-07 14:56:15 -0800587 constexpr size_t kNumQueued = 10;
Steven Moreland5553ac42020-11-11 02:14:45 +0000588 constexpr size_t kNumExtraServerThreads = 4;
Steven Moreland5553ac42020-11-11 02:14:45 +0000589
590 // make sure calls to the same object happen on the same thread
Steven Moreland4313d7e2021-07-15 23:41:22 +0000591 auto proc = createRpcTestSocketServerProcess({.numThreads = 1 + kNumExtraServerThreads});
Steven Moreland5553ac42020-11-11 02:14:45 +0000592
Frederick Mayle96872592023-03-07 14:56:15 -0800593 // all these *Oneway commands should be queued on the server sequentially,
Steven Moreland1c678802021-09-17 16:48:47 -0700594 // even though there are multiple threads.
Frederick Mayle96872592023-03-07 14:56:15 -0800595 for (size_t i = 0; i + 1 < kNumQueued; i++) {
596 proc.rootIface->blockingSendIntOneway(i);
Steven Moreland5553ac42020-11-11 02:14:45 +0000597 }
Frederick Mayle96872592023-03-07 14:56:15 -0800598 for (size_t i = 0; i + 1 < kNumQueued; i++) {
599 int n;
600 proc.rootIface->blockingRecvInt(&n);
601 EXPECT_EQ(n, i);
602 }
Steven Morelandf5174272021-05-25 00:39:28 +0000603
Steven Moreland925ba0a2021-09-17 18:06:32 -0700604 saturateThreadPool(1 + kNumExtraServerThreads, proc.rootIface);
Steven Moreland5553ac42020-11-11 02:14:45 +0000605}
606
Andrei Homescua858b0e2022-08-01 23:43:09 +0000607TEST_P(BinderRpc, OnewayCallExhaustion) {
608 if (clientOrServerSingleThreaded()) {
609 GTEST_SKIP() << "This test requires multiple threads";
610 }
611
Steven Morelandd45be622021-06-04 02:19:37 +0000612 constexpr size_t kNumClients = 2;
613 constexpr size_t kTooLongMs = 1000;
614
Steven Moreland4313d7e2021-07-15 23:41:22 +0000615 auto proc = createRpcTestSocketServerProcess({.numThreads = kNumClients, .numSessions = 2});
Steven Morelandd45be622021-06-04 02:19:37 +0000616
617 // Build up oneway calls on the second session to make sure it terminates
618 // and shuts down. The first session should be unaffected (proc destructor
619 // checks the first session).
Andrei Homescu96834632022-10-14 00:49:49 +0000620 auto iface = interface_cast<IBinderRpcTest>(proc.proc->sessions.at(1).root);
Steven Morelandd45be622021-06-04 02:19:37 +0000621
622 std::vector<std::thread> threads;
623 for (size_t i = 0; i < kNumClients; i++) {
624 // one of these threads will get stuck queueing a transaction once the
625 // socket fills up, the other will be able to fill up transactions on
626 // this object
627 threads.push_back(std::thread([&] {
628 while (iface->sleepMsAsync(kTooLongMs).isOk()) {
629 }
630 }));
631 }
632 for (auto& t : threads) t.join();
633
634 Status status = iface->sleepMsAsync(kTooLongMs);
635 EXPECT_EQ(DEAD_OBJECT, status.transactionError()) << status;
636
Steven Moreland798e0d12021-07-14 23:19:25 +0000637 // now that it has died, wait for the remote session to shutdown
638 std::vector<int32_t> remoteCounts;
639 do {
640 EXPECT_OK(proc.rootIface->countBinders(&remoteCounts));
641 } while (remoteCounts.size() == kNumClients);
642
Steven Morelandd45be622021-06-04 02:19:37 +0000643 // the second session should be shutdown in the other process by the time we
644 // are able to join above (it'll only be hung up once it finishes processing
645 // any pending commands). We need to erase this session from the record
646 // here, so that the destructor for our session won't check that this
647 // session is valid, but we still want it to test the other session.
Andrei Homescu96834632022-10-14 00:49:49 +0000648 proc.proc->sessions.erase(proc.proc->sessions.begin() + 1);
Steven Morelandd45be622021-06-04 02:19:37 +0000649}
650
Devin Moore66d5b7a2022-07-07 21:42:10 +0000651TEST_P(BinderRpc, SingleDeathRecipient) {
Andrei Homescua858b0e2022-08-01 23:43:09 +0000652 if (clientOrServerSingleThreaded()) {
Devin Moore66d5b7a2022-07-07 21:42:10 +0000653 GTEST_SKIP() << "This test requires multiple threads";
654 }
655 class MyDeathRec : public IBinder::DeathRecipient {
656 public:
657 void binderDied(const wp<IBinder>& /* who */) override {
658 dead = true;
659 mCv.notify_one();
660 }
661 std::mutex mMtx;
662 std::condition_variable mCv;
663 bool dead = false;
664 };
665
666 // Death recipient needs to have an incoming connection to be called
667 auto proc = createRpcTestSocketServerProcess(
668 {.numThreads = 1, .numSessions = 1, .numIncomingConnections = 1});
669
670 auto dr = sp<MyDeathRec>::make();
671 ASSERT_EQ(OK, proc.rootBinder->linkToDeath(dr, (void*)1, 0));
672
673 if (auto status = proc.rootIface->scheduleShutdown(); !status.isOk()) {
674 EXPECT_EQ(DEAD_OBJECT, status.transactionError()) << status;
675 }
676
677 std::unique_lock<std::mutex> lock(dr->mMtx);
Steven Morelanddd231e22022-09-08 19:47:49 +0000678 ASSERT_TRUE(dr->mCv.wait_for(lock, 100ms, [&]() { return dr->dead; }));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000679
680 // need to wait for the session to shutdown so we don't "Leak session"
Andrei Homescu96834632022-10-14 00:49:49 +0000681 EXPECT_TRUE(proc.proc->sessions.at(0).session->shutdownAndWait(true));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000682 proc.expectAlreadyShutdown = true;
683}
684
685TEST_P(BinderRpc, SingleDeathRecipientOnShutdown) {
Andrei Homescua858b0e2022-08-01 23:43:09 +0000686 if (clientOrServerSingleThreaded()) {
Devin Moore66d5b7a2022-07-07 21:42:10 +0000687 GTEST_SKIP() << "This test requires multiple threads";
688 }
689 class MyDeathRec : public IBinder::DeathRecipient {
690 public:
691 void binderDied(const wp<IBinder>& /* who */) override {
692 dead = true;
693 mCv.notify_one();
694 }
695 std::mutex mMtx;
696 std::condition_variable mCv;
697 bool dead = false;
698 };
699
700 // Death recipient needs to have an incoming connection to be called
701 auto proc = createRpcTestSocketServerProcess(
702 {.numThreads = 1, .numSessions = 1, .numIncomingConnections = 1});
703
704 auto dr = sp<MyDeathRec>::make();
705 EXPECT_EQ(OK, proc.rootBinder->linkToDeath(dr, (void*)1, 0));
706
707 // Explicitly calling shutDownAndWait will cause the death recipients
708 // to be called.
Andrei Homescu96834632022-10-14 00:49:49 +0000709 EXPECT_TRUE(proc.proc->sessions.at(0).session->shutdownAndWait(true));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000710
711 std::unique_lock<std::mutex> lock(dr->mMtx);
712 if (!dr->dead) {
Steven Morelanddd231e22022-09-08 19:47:49 +0000713 EXPECT_EQ(std::cv_status::no_timeout, dr->mCv.wait_for(lock, 100ms));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000714 }
715 EXPECT_TRUE(dr->dead) << "Failed to receive the death notification.";
716
Andrei Homescu96834632022-10-14 00:49:49 +0000717 proc.proc->terminate();
718 proc.proc->setCustomExitStatusCheck([](int wstatus) {
Devin Moore66d5b7a2022-07-07 21:42:10 +0000719 EXPECT_TRUE(WIFSIGNALED(wstatus) && WTERMSIG(wstatus) == SIGTERM)
720 << "server process failed incorrectly: " << WaitStatusToString(wstatus);
721 });
722 proc.expectAlreadyShutdown = true;
723}
724
Steven Moreland5ec743f2023-01-18 01:02:06 +0000725TEST_P(BinderRpc, DeathRecipientFailsWithoutIncoming) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000726 if (socketType() == SocketType::TIPC) {
727 // This should work, but Trusty takes too long to restart the service
728 GTEST_SKIP() << "Service death test not supported on Trusty";
729 }
Devin Moore66d5b7a2022-07-07 21:42:10 +0000730 class MyDeathRec : public IBinder::DeathRecipient {
731 public:
732 void binderDied(const wp<IBinder>& /* who */) override {}
733 };
734
735 auto proc = createRpcTestSocketServerProcess(
736 {.numThreads = 1, .numSessions = 1, .numIncomingConnections = 0});
737
738 auto dr = sp<MyDeathRec>::make();
Steven Moreland5ec743f2023-01-18 01:02:06 +0000739 EXPECT_EQ(INVALID_OPERATION, proc.rootBinder->linkToDeath(dr, (void*)1, 0));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000740}
741
742TEST_P(BinderRpc, UnlinkDeathRecipient) {
Andrei Homescua858b0e2022-08-01 23:43:09 +0000743 if (clientOrServerSingleThreaded()) {
Devin Moore66d5b7a2022-07-07 21:42:10 +0000744 GTEST_SKIP() << "This test requires multiple threads";
745 }
746 class MyDeathRec : public IBinder::DeathRecipient {
747 public:
748 void binderDied(const wp<IBinder>& /* who */) override {
749 GTEST_FAIL() << "This should not be called after unlinkToDeath";
750 }
751 };
752
753 // Death recipient needs to have an incoming connection to be called
754 auto proc = createRpcTestSocketServerProcess(
755 {.numThreads = 1, .numSessions = 1, .numIncomingConnections = 1});
756
757 auto dr = sp<MyDeathRec>::make();
758 ASSERT_EQ(OK, proc.rootBinder->linkToDeath(dr, (void*)1, 0));
759 ASSERT_EQ(OK, proc.rootBinder->unlinkToDeath(dr, (void*)1, 0, nullptr));
760
761 if (auto status = proc.rootIface->scheduleShutdown(); !status.isOk()) {
762 EXPECT_EQ(DEAD_OBJECT, status.transactionError()) << status;
763 }
764
765 // need to wait for the session to shutdown so we don't "Leak session"
Andrei Homescu96834632022-10-14 00:49:49 +0000766 EXPECT_TRUE(proc.proc->sessions.at(0).session->shutdownAndWait(true));
Devin Moore66d5b7a2022-07-07 21:42:10 +0000767 proc.expectAlreadyShutdown = true;
768}
769
Steven Morelandc1635952021-04-01 16:20:47 +0000770TEST_P(BinderRpc, Die) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000771 if (socketType() == SocketType::TIPC) {
772 // This should work, but Trusty takes too long to restart the service
773 GTEST_SKIP() << "Service death test not supported on Trusty";
774 }
775
Steven Moreland5553ac42020-11-11 02:14:45 +0000776 for (bool doDeathCleanup : {true, false}) {
Steven Moreland4313d7e2021-07-15 23:41:22 +0000777 auto proc = createRpcTestSocketServerProcess({});
Steven Moreland5553ac42020-11-11 02:14:45 +0000778
779 // make sure there is some state during crash
780 // 1. we hold their binder
781 sp<IBinderRpcSession> session;
782 EXPECT_OK(proc.rootIface->openSession("happy", &session));
783 // 2. they hold our binder
784 sp<IBinder> binder = new BBinder();
785 EXPECT_OK(proc.rootIface->holdBinder(binder));
786
787 EXPECT_EQ(DEAD_OBJECT, proc.rootIface->die(doDeathCleanup).transactionError())
788 << "Do death cleanup: " << doDeathCleanup;
789
Andrei Homescu96834632022-10-14 00:49:49 +0000790 proc.proc->setCustomExitStatusCheck([](int wstatus) {
Frederick Maylea12b0962022-06-25 01:13:22 +0000791 EXPECT_TRUE(WIFEXITED(wstatus) && WEXITSTATUS(wstatus) == 1)
792 << "server process failed incorrectly: " << WaitStatusToString(wstatus);
793 });
Steven Morelandaf4ca712021-05-24 23:22:08 +0000794 proc.expectAlreadyShutdown = true;
Steven Moreland5553ac42020-11-11 02:14:45 +0000795 }
796}
797
Steven Morelandd7302072021-05-15 01:32:04 +0000798TEST_P(BinderRpc, UseKernelBinderCallingId) {
Andrei Homescu2a298012022-06-15 01:08:54 +0000799 // This test only works if the current process shared the internal state of
800 // ProcessState with the service across the call to fork(). Both the static
801 // libraries and libbinder.so have their own separate copies of all the
802 // globals, so the test only works when the test client and service both use
803 // libbinder.so (when using static libraries, even a client and service
804 // using the same kind of static library should have separate copies of the
805 // variables).
Andrei Homescua858b0e2022-08-01 23:43:09 +0000806 if (!kEnableSharedLibs || serverSingleThreaded() || noKernel()) {
Andrei Homescu12106de2022-04-27 04:42:21 +0000807 GTEST_SKIP() << "Test disabled because Binder kernel driver was disabled "
808 "at build time.";
809 }
810
Steven Moreland4313d7e2021-07-15 23:41:22 +0000811 auto proc = createRpcTestSocketServerProcess({});
Steven Morelandd7302072021-05-15 01:32:04 +0000812
Andrei Homescu2a298012022-06-15 01:08:54 +0000813 // we can't allocate IPCThreadState so actually the first time should
814 // succeed :(
815 EXPECT_OK(proc.rootIface->useKernelBinderCallingId());
Steven Morelandd7302072021-05-15 01:32:04 +0000816
817 // second time! we catch the error :)
818 EXPECT_EQ(DEAD_OBJECT, proc.rootIface->useKernelBinderCallingId().transactionError());
819
Andrei Homescu96834632022-10-14 00:49:49 +0000820 proc.proc->setCustomExitStatusCheck([](int wstatus) {
Frederick Maylea12b0962022-06-25 01:13:22 +0000821 EXPECT_TRUE(WIFSIGNALED(wstatus) && WTERMSIG(wstatus) == SIGABRT)
822 << "server process failed incorrectly: " << WaitStatusToString(wstatus);
823 });
Steven Morelandaf4ca712021-05-24 23:22:08 +0000824 proc.expectAlreadyShutdown = true;
Steven Morelandd7302072021-05-15 01:32:04 +0000825}
826
Frederick Mayle69a0c992022-05-26 20:38:39 +0000827TEST_P(BinderRpc, FileDescriptorTransportRejectNone) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000828 if (socketType() == SocketType::TIPC) {
829 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
830 }
831
Frederick Mayle69a0c992022-05-26 20:38:39 +0000832 auto proc = createRpcTestSocketServerProcess({
833 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::NONE,
834 .serverSupportedFileDescriptorTransportModes =
835 {RpcSession::FileDescriptorTransportMode::UNIX},
836 .allowConnectFailure = true,
837 });
Andrei Homescu96834632022-10-14 00:49:49 +0000838 EXPECT_TRUE(proc.proc->sessions.empty()) << "session connections should have failed";
839 proc.proc->terminate();
840 proc.proc->setCustomExitStatusCheck([](int wstatus) {
Frederick Mayle69a0c992022-05-26 20:38:39 +0000841 EXPECT_TRUE(WIFSIGNALED(wstatus) && WTERMSIG(wstatus) == SIGTERM)
842 << "server process failed incorrectly: " << WaitStatusToString(wstatus);
843 });
844 proc.expectAlreadyShutdown = true;
845}
846
847TEST_P(BinderRpc, FileDescriptorTransportRejectUnix) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000848 if (socketType() == SocketType::TIPC) {
849 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
850 }
851
Frederick Mayle69a0c992022-05-26 20:38:39 +0000852 auto proc = createRpcTestSocketServerProcess({
853 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
854 .serverSupportedFileDescriptorTransportModes =
855 {RpcSession::FileDescriptorTransportMode::NONE},
856 .allowConnectFailure = true,
857 });
Andrei Homescu96834632022-10-14 00:49:49 +0000858 EXPECT_TRUE(proc.proc->sessions.empty()) << "session connections should have failed";
859 proc.proc->terminate();
860 proc.proc->setCustomExitStatusCheck([](int wstatus) {
Frederick Mayle69a0c992022-05-26 20:38:39 +0000861 EXPECT_TRUE(WIFSIGNALED(wstatus) && WTERMSIG(wstatus) == SIGTERM)
862 << "server process failed incorrectly: " << WaitStatusToString(wstatus);
863 });
864 proc.expectAlreadyShutdown = true;
865}
866
867TEST_P(BinderRpc, FileDescriptorTransportOptionalUnix) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000868 if (socketType() == SocketType::TIPC) {
869 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
870 }
871
Frederick Mayle69a0c992022-05-26 20:38:39 +0000872 auto proc = createRpcTestSocketServerProcess({
873 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::NONE,
874 .serverSupportedFileDescriptorTransportModes =
875 {RpcSession::FileDescriptorTransportMode::NONE,
876 RpcSession::FileDescriptorTransportMode::UNIX},
877 });
878
879 android::os::ParcelFileDescriptor out;
880 auto status = proc.rootIface->echoAsFile("hello", &out);
881 EXPECT_EQ(status.transactionError(), FDS_NOT_ALLOWED) << status;
882}
883
884TEST_P(BinderRpc, ReceiveFile) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000885 if (socketType() == SocketType::TIPC) {
886 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
887 }
888
Frederick Mayle69a0c992022-05-26 20:38:39 +0000889 auto proc = createRpcTestSocketServerProcess({
890 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
891 .serverSupportedFileDescriptorTransportModes =
892 {RpcSession::FileDescriptorTransportMode::UNIX},
893 });
894
895 android::os::ParcelFileDescriptor out;
896 auto status = proc.rootIface->echoAsFile("hello", &out);
897 if (!supportsFdTransport()) {
898 EXPECT_EQ(status.transactionError(), BAD_VALUE) << status;
899 return;
900 }
901 ASSERT_TRUE(status.isOk()) << status;
902
903 std::string result;
904 CHECK(android::base::ReadFdToString(out.get(), &result));
905 EXPECT_EQ(result, "hello");
906}
907
908TEST_P(BinderRpc, SendFiles) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000909 if (socketType() == SocketType::TIPC) {
910 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
911 }
912
Frederick Mayle69a0c992022-05-26 20:38:39 +0000913 auto proc = createRpcTestSocketServerProcess({
914 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
915 .serverSupportedFileDescriptorTransportModes =
916 {RpcSession::FileDescriptorTransportMode::UNIX},
917 });
918
919 std::vector<android::os::ParcelFileDescriptor> files;
920 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("123")));
921 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("a")));
922 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("b")));
923 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("cd")));
924
925 android::os::ParcelFileDescriptor out;
926 auto status = proc.rootIface->concatFiles(files, &out);
927 if (!supportsFdTransport()) {
928 EXPECT_EQ(status.transactionError(), BAD_VALUE) << status;
929 return;
930 }
931 ASSERT_TRUE(status.isOk()) << status;
932
933 std::string result;
934 CHECK(android::base::ReadFdToString(out.get(), &result));
935 EXPECT_EQ(result, "123abcd");
936}
937
938TEST_P(BinderRpc, SendMaxFiles) {
939 if (!supportsFdTransport()) {
940 GTEST_SKIP() << "Would fail trivially (which is tested by BinderRpc::SendFiles)";
941 }
942
943 auto proc = createRpcTestSocketServerProcess({
944 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
945 .serverSupportedFileDescriptorTransportModes =
946 {RpcSession::FileDescriptorTransportMode::UNIX},
947 });
948
949 std::vector<android::os::ParcelFileDescriptor> files;
950 for (int i = 0; i < 253; i++) {
951 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("a")));
952 }
953
954 android::os::ParcelFileDescriptor out;
955 auto status = proc.rootIface->concatFiles(files, &out);
956 ASSERT_TRUE(status.isOk()) << status;
957
958 std::string result;
959 CHECK(android::base::ReadFdToString(out.get(), &result));
960 EXPECT_EQ(result, std::string(253, 'a'));
961}
962
963TEST_P(BinderRpc, SendTooManyFiles) {
964 if (!supportsFdTransport()) {
965 GTEST_SKIP() << "Would fail trivially (which is tested by BinderRpc::SendFiles)";
966 }
967
968 auto proc = createRpcTestSocketServerProcess({
969 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
970 .serverSupportedFileDescriptorTransportModes =
971 {RpcSession::FileDescriptorTransportMode::UNIX},
972 });
973
974 std::vector<android::os::ParcelFileDescriptor> files;
975 for (int i = 0; i < 254; i++) {
976 files.emplace_back(android::os::ParcelFileDescriptor(mockFileDescriptor("a")));
977 }
978
979 android::os::ParcelFileDescriptor out;
980 auto status = proc.rootIface->concatFiles(files, &out);
981 EXPECT_EQ(status.transactionError(), BAD_VALUE) << status;
982}
983
Andrei Homescufc221502022-10-08 03:51:17 +0000984TEST_P(BinderRpc, AppendInvalidFd) {
Andrei Homescu68a55612022-08-02 01:25:15 +0000985 if (socketType() == SocketType::TIPC) {
986 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
987 }
988
Andrei Homescufc221502022-10-08 03:51:17 +0000989 auto proc = createRpcTestSocketServerProcess({
990 .clientFileDescriptorTransportMode = RpcSession::FileDescriptorTransportMode::UNIX,
991 .serverSupportedFileDescriptorTransportModes =
992 {RpcSession::FileDescriptorTransportMode::UNIX},
993 });
994
995 int badFd = fcntl(STDERR_FILENO, F_DUPFD_CLOEXEC, 0);
996 ASSERT_NE(badFd, -1);
997
998 // Close the file descriptor so it becomes invalid for dup
999 close(badFd);
1000
1001 Parcel p1;
1002 p1.markForBinder(proc.rootBinder);
1003 p1.writeInt32(3);
1004 EXPECT_EQ(OK, p1.writeFileDescriptor(badFd, false));
1005
1006 Parcel pRaw;
1007 pRaw.markForBinder(proc.rootBinder);
1008 EXPECT_EQ(OK, pRaw.appendFrom(&p1, 0, p1.dataSize()));
1009
1010 pRaw.setDataPosition(0);
1011 EXPECT_EQ(3, pRaw.readInt32());
1012 ASSERT_EQ(-1, pRaw.readFileDescriptor());
1013}
1014
Andrei Homescu68a55612022-08-02 01:25:15 +00001015#ifndef __ANDROID_VENDOR__ // No AIBinder_fromPlatformBinder on vendor
Steven Moreland37aff182021-03-26 02:04:16 +00001016TEST_P(BinderRpc, WorksWithLibbinderNdkPing) {
Andrei Homescu12106de2022-04-27 04:42:21 +00001017 if constexpr (!kEnableSharedLibs) {
1018 GTEST_SKIP() << "Test disabled because Binder was built as a static library";
1019 }
1020
Steven Moreland4313d7e2021-07-15 23:41:22 +00001021 auto proc = createRpcTestSocketServerProcess({});
Steven Moreland37aff182021-03-26 02:04:16 +00001022
1023 ndk::SpAIBinder binder = ndk::SpAIBinder(AIBinder_fromPlatformBinder(proc.rootBinder));
1024 ASSERT_NE(binder, nullptr);
1025
1026 ASSERT_EQ(STATUS_OK, AIBinder_ping(binder.get()));
1027}
1028
1029TEST_P(BinderRpc, WorksWithLibbinderNdkUserTransaction) {
Andrei Homescu12106de2022-04-27 04:42:21 +00001030 if constexpr (!kEnableSharedLibs) {
1031 GTEST_SKIP() << "Test disabled because Binder was built as a static library";
1032 }
1033
Steven Moreland4313d7e2021-07-15 23:41:22 +00001034 auto proc = createRpcTestSocketServerProcess({});
Steven Moreland37aff182021-03-26 02:04:16 +00001035
1036 ndk::SpAIBinder binder = ndk::SpAIBinder(AIBinder_fromPlatformBinder(proc.rootBinder));
1037 ASSERT_NE(binder, nullptr);
1038
1039 auto ndkBinder = aidl::IBinderRpcTest::fromBinder(binder);
1040 ASSERT_NE(ndkBinder, nullptr);
1041
1042 std::string out;
1043 ndk::ScopedAStatus status = ndkBinder->doubleString("aoeu", &out);
1044 ASSERT_TRUE(status.isOk()) << status.getDescription();
1045 ASSERT_EQ("aoeuaoeu", out);
1046}
Andrei Homescu68a55612022-08-02 01:25:15 +00001047#endif // __ANDROID_VENDOR__
Steven Moreland37aff182021-03-26 02:04:16 +00001048
Steven Moreland5553ac42020-11-11 02:14:45 +00001049ssize_t countFds() {
1050 DIR* dir = opendir("/proc/self/fd/");
1051 if (dir == nullptr) return -1;
1052 ssize_t ret = 0;
1053 dirent* ent;
1054 while ((ent = readdir(dir)) != nullptr) ret++;
1055 closedir(dir);
1056 return ret;
1057}
1058
Andrei Homescua858b0e2022-08-01 23:43:09 +00001059TEST_P(BinderRpc, Fds) {
1060 if (serverSingleThreaded()) {
1061 GTEST_SKIP() << "This test requires multiple threads";
1062 }
Andrei Homescu68a55612022-08-02 01:25:15 +00001063 if (socketType() == SocketType::TIPC) {
1064 GTEST_SKIP() << "File descriptor tests not supported on Trusty (yet)";
1065 }
Andrei Homescua858b0e2022-08-01 23:43:09 +00001066
Steven Moreland5553ac42020-11-11 02:14:45 +00001067 ssize_t beforeFds = countFds();
1068 ASSERT_GE(beforeFds, 0);
1069 {
Steven Moreland4313d7e2021-07-15 23:41:22 +00001070 auto proc = createRpcTestSocketServerProcess({.numThreads = 10});
Steven Moreland5553ac42020-11-11 02:14:45 +00001071 ASSERT_EQ(OK, proc.rootBinder->pingBinder());
1072 }
1073 ASSERT_EQ(beforeFds, countFds()) << (system("ls -l /proc/self/fd/"), "fd leak?");
1074}
1075
Steven Morelandda573042021-06-12 01:13:45 +00001076static bool testSupportVsockLoopback() {
Yifan Hong702115c2021-06-24 15:39:18 -07001077 // We don't need to enable TLS to know if vsock is supported.
Steven Morelandda573042021-06-12 01:13:45 +00001078 unsigned int vsockPort = allocateVsockPort();
Steven Morelandda573042021-06-12 01:13:45 +00001079
Andrei Homescu992a4052022-06-28 21:26:18 +00001080 android::base::unique_fd serverFd(
1081 TEMP_FAILURE_RETRY(socket(AF_VSOCK, SOCK_STREAM | SOCK_CLOEXEC | SOCK_NONBLOCK, 0)));
1082 LOG_ALWAYS_FATAL_IF(serverFd == -1, "Could not create socket: %s", strerror(errno));
1083
1084 sockaddr_vm serverAddr{
1085 .svm_family = AF_VSOCK,
1086 .svm_port = vsockPort,
1087 .svm_cid = VMADDR_CID_ANY,
1088 };
1089 int ret = TEMP_FAILURE_RETRY(
1090 bind(serverFd.get(), reinterpret_cast<sockaddr*>(&serverAddr), sizeof(serverAddr)));
1091 LOG_ALWAYS_FATAL_IF(0 != ret, "Could not bind socket to port %u: %s", vsockPort,
1092 strerror(errno));
1093
1094 ret = TEMP_FAILURE_RETRY(listen(serverFd.get(), 1 /*backlog*/));
1095 LOG_ALWAYS_FATAL_IF(0 != ret, "Could not listen socket on port %u: %s", vsockPort,
1096 strerror(errno));
1097
1098 // Try to connect to the server using the VMADDR_CID_LOCAL cid
1099 // to see if the kernel supports it. It's safe to use a blocking
1100 // connect because vsock sockets have a 2 second connection timeout,
1101 // and they return ETIMEDOUT after that.
1102 android::base::unique_fd connectFd(
1103 TEMP_FAILURE_RETRY(socket(AF_VSOCK, SOCK_STREAM | SOCK_CLOEXEC | SOCK_NONBLOCK, 0)));
1104 LOG_ALWAYS_FATAL_IF(connectFd == -1, "Could not create socket for port %u: %s", vsockPort,
1105 strerror(errno));
1106
1107 bool success = false;
1108 sockaddr_vm connectAddr{
1109 .svm_family = AF_VSOCK,
1110 .svm_port = vsockPort,
1111 .svm_cid = VMADDR_CID_LOCAL,
1112 };
1113 ret = TEMP_FAILURE_RETRY(connect(connectFd.get(), reinterpret_cast<sockaddr*>(&connectAddr),
1114 sizeof(connectAddr)));
1115 if (ret != 0 && (errno == EAGAIN || errno == EINPROGRESS)) {
1116 android::base::unique_fd acceptFd;
1117 while (true) {
1118 pollfd pfd[]{
1119 {.fd = serverFd.get(), .events = POLLIN, .revents = 0},
1120 {.fd = connectFd.get(), .events = POLLOUT, .revents = 0},
1121 };
1122 ret = TEMP_FAILURE_RETRY(poll(pfd, arraysize(pfd), -1));
1123 LOG_ALWAYS_FATAL_IF(ret < 0, "Error polling: %s", strerror(errno));
1124
1125 if (pfd[0].revents & POLLIN) {
1126 sockaddr_vm acceptAddr;
1127 socklen_t acceptAddrLen = sizeof(acceptAddr);
1128 ret = TEMP_FAILURE_RETRY(accept4(serverFd.get(),
1129 reinterpret_cast<sockaddr*>(&acceptAddr),
1130 &acceptAddrLen, SOCK_CLOEXEC));
1131 LOG_ALWAYS_FATAL_IF(ret < 0, "Could not accept4 socket: %s", strerror(errno));
1132 LOG_ALWAYS_FATAL_IF(acceptAddrLen != static_cast<socklen_t>(sizeof(acceptAddr)),
1133 "Truncated address");
1134
1135 // Store the fd in acceptFd so we keep the connection alive
1136 // while polling connectFd
1137 acceptFd.reset(ret);
1138 }
1139
1140 if (pfd[1].revents & POLLOUT) {
1141 // Connect either succeeded or timed out
1142 int connectErrno;
1143 socklen_t connectErrnoLen = sizeof(connectErrno);
1144 int ret = getsockopt(connectFd.get(), SOL_SOCKET, SO_ERROR, &connectErrno,
1145 &connectErrnoLen);
1146 LOG_ALWAYS_FATAL_IF(ret == -1,
1147 "Could not getsockopt() after connect() "
1148 "on non-blocking socket: %s.",
1149 strerror(errno));
1150
1151 // We're done, this is all we wanted
1152 success = connectErrno == 0;
1153 break;
1154 }
1155 }
1156 } else {
1157 success = ret == 0;
1158 }
1159
1160 ALOGE("Detected vsock loopback supported: %s", success ? "yes" : "no");
1161
1162 return success;
Steven Morelandda573042021-06-12 01:13:45 +00001163}
1164
Yifan Hong1deca4b2021-09-10 16:16:44 -07001165static std::vector<SocketType> testSocketTypes(bool hasPreconnected = true) {
Alice Wang893a9912022-10-24 10:44:09 +00001166 std::vector<SocketType> ret = {SocketType::UNIX, SocketType::UNIX_BOOTSTRAP, SocketType::INET,
1167 SocketType::UNIX_RAW};
Yifan Hong1deca4b2021-09-10 16:16:44 -07001168
1169 if (hasPreconnected) ret.push_back(SocketType::PRECONNECTED);
Steven Morelandda573042021-06-12 01:13:45 +00001170
1171 static bool hasVsockLoopback = testSupportVsockLoopback();
1172
1173 if (hasVsockLoopback) {
1174 ret.push_back(SocketType::VSOCK);
1175 }
1176
1177 return ret;
1178}
1179
Andrei Homescu68a55612022-08-02 01:25:15 +00001180static std::vector<SocketType> testTipcSocketTypes() {
1181#ifdef __ANDROID_VENDOR__
1182 auto port = trustyIpcPort(RPC_WIRE_PROTOCOL_VERSION_EXPERIMENTAL);
1183 int tipcFd = tipc_connect(kTrustyIpcDevice, port.c_str());
1184 if (tipcFd >= 0) {
1185 close(tipcFd);
1186 return {SocketType::TIPC};
1187 }
1188#endif // __ANDROID_VENDOR__
1189
1190 // TIPC is not supported on this device, most likely
1191 // because /dev/trusty-ipc-dev0 is missing
1192 return {};
1193}
1194
Yifan Hong702115c2021-06-24 15:39:18 -07001195INSTANTIATE_TEST_CASE_P(PerSocket, BinderRpc,
1196 ::testing::Combine(::testing::ValuesIn(testSocketTypes()),
Frederick Mayledc07cf82022-05-26 20:30:12 +00001197 ::testing::ValuesIn(RpcSecurityValues()),
1198 ::testing::ValuesIn(testVersions()),
Andrei Homescu2a298012022-06-15 01:08:54 +00001199 ::testing::ValuesIn(testVersions()),
1200 ::testing::Values(false, true),
1201 ::testing::Values(false, true)),
Yifan Hong702115c2021-06-24 15:39:18 -07001202 BinderRpc::PrintParamInfo);
Steven Morelandc1635952021-04-01 16:20:47 +00001203
Andrei Homescu68a55612022-08-02 01:25:15 +00001204INSTANTIATE_TEST_CASE_P(Trusty, BinderRpc,
1205 ::testing::Combine(::testing::ValuesIn(testTipcSocketTypes()),
1206 ::testing::Values(RpcSecurity::RAW),
1207 ::testing::ValuesIn(testVersions()),
1208 ::testing::ValuesIn(testVersions()),
1209 ::testing::Values(true), ::testing::Values(true)),
1210 BinderRpc::PrintParamInfo);
1211
Yifan Hong702115c2021-06-24 15:39:18 -07001212class BinderRpcServerRootObject
1213 : public ::testing::TestWithParam<std::tuple<bool, bool, RpcSecurity>> {};
Yifan Hong4ffb0c72021-05-07 18:35:14 -07001214
1215TEST_P(BinderRpcServerRootObject, WeakRootObject) {
1216 using SetFn = std::function<void(RpcServer*, sp<IBinder>)>;
1217 auto setRootObject = [](bool isStrong) -> SetFn {
1218 return isStrong ? SetFn(&RpcServer::setRootObject) : SetFn(&RpcServer::setRootObjectWeak);
1219 };
1220
Yifan Hong702115c2021-06-24 15:39:18 -07001221 auto [isStrong1, isStrong2, rpcSecurity] = GetParam();
1222 auto server = RpcServer::make(newFactory(rpcSecurity));
Yifan Hong4ffb0c72021-05-07 18:35:14 -07001223 auto binder1 = sp<BBinder>::make();
1224 IBinder* binderRaw1 = binder1.get();
1225 setRootObject(isStrong1)(server.get(), binder1);
1226 EXPECT_EQ(binderRaw1, server->getRootObject());
1227 binder1.clear();
1228 EXPECT_EQ((isStrong1 ? binderRaw1 : nullptr), server->getRootObject());
1229
1230 auto binder2 = sp<BBinder>::make();
1231 IBinder* binderRaw2 = binder2.get();
1232 setRootObject(isStrong2)(server.get(), binder2);
1233 EXPECT_EQ(binderRaw2, server->getRootObject());
1234 binder2.clear();
1235 EXPECT_EQ((isStrong2 ? binderRaw2 : nullptr), server->getRootObject());
1236}
1237
1238INSTANTIATE_TEST_CASE_P(BinderRpc, BinderRpcServerRootObject,
Yifan Hong702115c2021-06-24 15:39:18 -07001239 ::testing::Combine(::testing::Bool(), ::testing::Bool(),
1240 ::testing::ValuesIn(RpcSecurityValues())));
Yifan Hong4ffb0c72021-05-07 18:35:14 -07001241
Yifan Hong1a235852021-05-13 16:07:47 -07001242class OneOffSignal {
1243public:
1244 // If notify() was previously called, or is called within |duration|, return true; else false.
1245 template <typename R, typename P>
1246 bool wait(std::chrono::duration<R, P> duration) {
1247 std::unique_lock<std::mutex> lock(mMutex);
1248 return mCv.wait_for(lock, duration, [this] { return mValue; });
1249 }
1250 void notify() {
1251 std::unique_lock<std::mutex> lock(mMutex);
1252 mValue = true;
1253 lock.unlock();
1254 mCv.notify_all();
1255 }
1256
1257private:
1258 std::mutex mMutex;
1259 std::condition_variable mCv;
1260 bool mValue = false;
1261};
1262
Yifan Hong194acf22021-06-29 18:44:56 -07001263TEST(BinderRpc, Java) {
1264#if !defined(__ANDROID__)
1265 GTEST_SKIP() << "This test is only run on Android. Though it can technically run on host on"
1266 "createRpcDelegateServiceManager() with a device attached, such test belongs "
1267 "to binderHostDeviceTest. Hence, just disable this test on host.";
1268#endif // !__ANDROID__
Andrei Homescu12106de2022-04-27 04:42:21 +00001269 if constexpr (!kEnableKernelIpc) {
1270 GTEST_SKIP() << "Test disabled because Binder kernel driver was disabled "
1271 "at build time.";
1272 }
1273
Yifan Hong194acf22021-06-29 18:44:56 -07001274 sp<IServiceManager> sm = defaultServiceManager();
1275 ASSERT_NE(nullptr, sm);
1276 // Any Java service with non-empty getInterfaceDescriptor() would do.
1277 // Let's pick batteryproperties.
1278 auto binder = sm->checkService(String16("batteryproperties"));
1279 ASSERT_NE(nullptr, binder);
1280 auto descriptor = binder->getInterfaceDescriptor();
1281 ASSERT_GE(descriptor.size(), 0);
1282 ASSERT_EQ(OK, binder->pingBinder());
1283
1284 auto rpcServer = RpcServer::make();
Yifan Hong194acf22021-06-29 18:44:56 -07001285 unsigned int port;
Steven Moreland2372f9d2021-08-05 15:42:01 -07001286 ASSERT_EQ(OK, rpcServer->setupInetServer(kLocalInetAddress, 0, &port));
Yifan Hong194acf22021-06-29 18:44:56 -07001287 auto socket = rpcServer->releaseServer();
1288
1289 auto keepAlive = sp<BBinder>::make();
Yifan Hongfe4b83f2021-11-08 16:29:53 -08001290 auto setRpcClientDebugStatus = binder->setRpcClientDebug(std::move(socket), keepAlive);
1291
Yifan Honge3caaf22022-01-12 14:46:56 -08001292 if (!android::base::GetBoolProperty("ro.debuggable", false) ||
1293 android::base::GetProperty("ro.build.type", "") == "user") {
Yifan Hongfe4b83f2021-11-08 16:29:53 -08001294 ASSERT_EQ(INVALID_OPERATION, setRpcClientDebugStatus)
Yifan Honge3caaf22022-01-12 14:46:56 -08001295 << "setRpcClientDebug should return INVALID_OPERATION on non-debuggable or user "
1296 "builds, but get "
Yifan Hongfe4b83f2021-11-08 16:29:53 -08001297 << statusToString(setRpcClientDebugStatus);
1298 GTEST_SKIP();
1299 }
1300
1301 ASSERT_EQ(OK, setRpcClientDebugStatus);
Yifan Hong194acf22021-06-29 18:44:56 -07001302
1303 auto rpcSession = RpcSession::make();
Steven Moreland2372f9d2021-08-05 15:42:01 -07001304 ASSERT_EQ(OK, rpcSession->setupInetClient("127.0.0.1", port));
Yifan Hong194acf22021-06-29 18:44:56 -07001305 auto rpcBinder = rpcSession->getRootObject();
1306 ASSERT_NE(nullptr, rpcBinder);
1307
1308 ASSERT_EQ(OK, rpcBinder->pingBinder());
1309
1310 ASSERT_EQ(descriptor, rpcBinder->getInterfaceDescriptor())
1311 << "getInterfaceDescriptor should not crash system_server";
1312 ASSERT_EQ(OK, rpcBinder->pingBinder());
1313}
1314
Andrei Homescu8d7f4bd2022-08-03 05:46:17 +00001315class BinderRpcServerOnly : public ::testing::TestWithParam<std::tuple<RpcSecurity, uint32_t>> {
1316public:
1317 static std::string PrintTestParam(const ::testing::TestParamInfo<ParamType>& info) {
1318 return std::string(newFactory(std::get<0>(info.param))->toCString()) + "_serverV" +
1319 std::to_string(std::get<1>(info.param));
1320 }
1321};
1322
1323TEST_P(BinderRpcServerOnly, SetExternalServerTest) {
1324 base::unique_fd sink(TEMP_FAILURE_RETRY(open("/dev/null", O_RDWR)));
1325 int sinkFd = sink.get();
1326 auto server = RpcServer::make(newFactory(std::get<0>(GetParam())));
1327 server->setProtocolVersion(std::get<1>(GetParam()));
1328 ASSERT_FALSE(server->hasServer());
1329 ASSERT_EQ(OK, server->setupExternalServer(std::move(sink)));
1330 ASSERT_TRUE(server->hasServer());
1331 base::unique_fd retrieved = server->releaseServer();
1332 ASSERT_FALSE(server->hasServer());
1333 ASSERT_EQ(sinkFd, retrieved.get());
1334}
1335
1336TEST_P(BinderRpcServerOnly, Shutdown) {
1337 if constexpr (!kEnableRpcThreads) {
1338 GTEST_SKIP() << "Test skipped because threads were disabled at build time";
1339 }
1340
1341 auto addr = allocateSocketAddress();
1342 auto server = RpcServer::make(newFactory(std::get<0>(GetParam())));
1343 server->setProtocolVersion(std::get<1>(GetParam()));
1344 ASSERT_EQ(OK, server->setupUnixDomainServer(addr.c_str()));
1345 auto joinEnds = std::make_shared<OneOffSignal>();
1346
1347 // If things are broken and the thread never stops, don't block other tests. Because the thread
1348 // may run after the test finishes, it must not access the stack memory of the test. Hence,
1349 // shared pointers are passed.
1350 std::thread([server, joinEnds] {
1351 server->join();
1352 joinEnds->notify();
1353 }).detach();
1354
1355 bool shutdown = false;
1356 for (int i = 0; i < 10 && !shutdown; i++) {
Steven Morelanddd231e22022-09-08 19:47:49 +00001357 usleep(30 * 1000); // 30ms; total 300ms
Andrei Homescu8d7f4bd2022-08-03 05:46:17 +00001358 if (server->shutdown()) shutdown = true;
1359 }
1360 ASSERT_TRUE(shutdown) << "server->shutdown() never returns true";
1361
1362 ASSERT_TRUE(joinEnds->wait(2s))
1363 << "After server->shutdown() returns true, join() did not stop after 2s";
1364}
1365
Frederick Mayledc07cf82022-05-26 20:30:12 +00001366INSTANTIATE_TEST_CASE_P(BinderRpc, BinderRpcServerOnly,
1367 ::testing::Combine(::testing::ValuesIn(RpcSecurityValues()),
1368 ::testing::ValuesIn(testVersions())),
1369 BinderRpcServerOnly::PrintTestParam);
Yifan Hong702115c2021-06-24 15:39:18 -07001370
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001371class RpcTransportTestUtils {
Yifan Hong1deca4b2021-09-10 16:16:44 -07001372public:
Frederick Mayledc07cf82022-05-26 20:30:12 +00001373 // Only parameterized only server version because `RpcSession` is bypassed
1374 // in the client half of the tests.
1375 using Param =
1376 std::tuple<SocketType, RpcSecurity, std::optional<RpcCertificateFormat>, uint32_t>;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001377 using ConnectToServer = std::function<base::unique_fd()>;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001378
1379 // A server that handles client socket connections.
1380 class Server {
1381 public:
David Brazdil21c887c2022-09-23 12:25:18 +01001382 using AcceptConnection = std::function<base::unique_fd(Server*)>;
1383
Yifan Hong1deca4b2021-09-10 16:16:44 -07001384 explicit Server() {}
1385 Server(Server&&) = default;
Yifan Honge07d2732021-09-13 21:59:14 -07001386 ~Server() { shutdownAndWait(); }
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001387 [[nodiscard]] AssertionResult setUp(
1388 const Param& param,
1389 std::unique_ptr<RpcAuth> auth = std::make_unique<RpcAuthSelfSigned>()) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001390 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = param;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001391 auto rpcServer = RpcServer::make(newFactory(rpcSecurity));
Frederick Mayledc07cf82022-05-26 20:30:12 +00001392 rpcServer->setProtocolVersion(serverVersion);
Yifan Hong1deca4b2021-09-10 16:16:44 -07001393 switch (socketType) {
1394 case SocketType::PRECONNECTED: {
1395 return AssertionFailure() << "Not supported by this test";
1396 } break;
1397 case SocketType::UNIX: {
1398 auto addr = allocateSocketAddress();
1399 auto status = rpcServer->setupUnixDomainServer(addr.c_str());
1400 if (status != OK) {
1401 return AssertionFailure()
1402 << "setupUnixDomainServer: " << statusToString(status);
1403 }
1404 mConnectToServer = [addr] {
1405 return connectTo(UnixSocketAddress(addr.c_str()));
1406 };
1407 } break;
David Brazdil21c887c2022-09-23 12:25:18 +01001408 case SocketType::UNIX_BOOTSTRAP: {
1409 base::unique_fd bootstrapFdClient, bootstrapFdServer;
1410 if (!base::Socketpair(SOCK_STREAM, &bootstrapFdClient, &bootstrapFdServer)) {
1411 return AssertionFailure() << "Socketpair() failed";
1412 }
1413 auto status = rpcServer->setupUnixDomainSocketBootstrapServer(
1414 std::move(bootstrapFdServer));
1415 if (status != OK) {
1416 return AssertionFailure() << "setupUnixDomainSocketBootstrapServer: "
1417 << statusToString(status);
1418 }
1419 mBootstrapSocket = RpcTransportFd(std::move(bootstrapFdClient));
1420 mAcceptConnection = &Server::recvmsgServerConnection;
1421 mConnectToServer = [this] { return connectToUnixBootstrap(mBootstrapSocket); };
1422 } break;
Alice Wang893a9912022-10-24 10:44:09 +00001423 case SocketType::UNIX_RAW: {
1424 auto addr = allocateSocketAddress();
1425 auto status = rpcServer->setupRawSocketServer(initUnixSocket(addr));
1426 if (status != OK) {
1427 return AssertionFailure()
1428 << "setupRawSocketServer: " << statusToString(status);
1429 }
1430 mConnectToServer = [addr] {
1431 return connectTo(UnixSocketAddress(addr.c_str()));
1432 };
1433 } break;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001434 case SocketType::VSOCK: {
1435 auto port = allocateVsockPort();
David Brazdila47dfda2022-11-22 22:52:19 +00001436 auto status = rpcServer->setupVsockServer(VMADDR_CID_LOCAL, port);
Yifan Hong1deca4b2021-09-10 16:16:44 -07001437 if (status != OK) {
1438 return AssertionFailure() << "setupVsockServer: " << statusToString(status);
1439 }
1440 mConnectToServer = [port] {
1441 return connectTo(VsockSocketAddress(VMADDR_CID_LOCAL, port));
1442 };
1443 } break;
1444 case SocketType::INET: {
1445 unsigned int port;
1446 auto status = rpcServer->setupInetServer(kLocalInetAddress, 0, &port);
1447 if (status != OK) {
1448 return AssertionFailure() << "setupInetServer: " << statusToString(status);
1449 }
1450 mConnectToServer = [port] {
1451 const char* addr = kLocalInetAddress;
1452 auto aiStart = InetSocketAddress::getAddrInfo(addr, port);
1453 if (aiStart == nullptr) return base::unique_fd{};
1454 for (auto ai = aiStart.get(); ai != nullptr; ai = ai->ai_next) {
1455 auto fd = connectTo(
1456 InetSocketAddress(ai->ai_addr, ai->ai_addrlen, addr, port));
1457 if (fd.ok()) return fd;
1458 }
1459 ALOGE("None of the socket address resolved for %s:%u can be connected",
1460 addr, port);
1461 return base::unique_fd{};
1462 };
Andrei Homescu68a55612022-08-02 01:25:15 +00001463 } break;
1464 case SocketType::TIPC: {
1465 LOG_ALWAYS_FATAL("RpcTransportTest should not be enabled for TIPC");
1466 } break;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001467 }
1468 mFd = rpcServer->releaseServer();
Pawan49d74cb2022-08-03 21:19:11 +00001469 if (!mFd.fd.ok()) return AssertionFailure() << "releaseServer returns invalid fd";
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001470 mCtx = newFactory(rpcSecurity, mCertVerifier, std::move(auth))->newServerCtx();
Yifan Hong1deca4b2021-09-10 16:16:44 -07001471 if (mCtx == nullptr) return AssertionFailure() << "newServerCtx";
1472 mSetup = true;
1473 return AssertionSuccess();
1474 }
1475 RpcTransportCtx* getCtx() const { return mCtx.get(); }
1476 std::shared_ptr<RpcCertificateVerifierSimple> getCertVerifier() const {
1477 return mCertVerifier;
1478 }
1479 ConnectToServer getConnectToServerFn() { return mConnectToServer; }
1480 void start() {
1481 LOG_ALWAYS_FATAL_IF(!mSetup, "Call Server::setup first!");
1482 mThread = std::make_unique<std::thread>(&Server::run, this);
1483 }
David Brazdil21c887c2022-09-23 12:25:18 +01001484
1485 base::unique_fd acceptServerConnection() {
1486 return base::unique_fd(TEMP_FAILURE_RETRY(
1487 accept4(mFd.fd.get(), nullptr, nullptr, SOCK_CLOEXEC | SOCK_NONBLOCK)));
1488 }
1489
1490 base::unique_fd recvmsgServerConnection() {
1491 std::vector<std::variant<base::unique_fd, base::borrowed_fd>> fds;
1492 int buf;
1493 iovec iov{&buf, sizeof(buf)};
1494
1495 if (receiveMessageFromSocket(mFd, &iov, 1, &fds) < 0) {
1496 int savedErrno = errno;
1497 LOG(FATAL) << "Failed receiveMessage: " << strerror(savedErrno);
1498 }
1499 if (fds.size() != 1) {
1500 LOG(FATAL) << "Expected one FD from receiveMessage(), got " << fds.size();
1501 }
1502 return std::move(std::get<base::unique_fd>(fds[0]));
1503 }
1504
Yifan Hong1deca4b2021-09-10 16:16:44 -07001505 void run() {
1506 LOG_ALWAYS_FATAL_IF(!mSetup, "Call Server::setup first!");
1507
1508 std::vector<std::thread> threads;
1509 while (OK == mFdTrigger->triggerablePoll(mFd, POLLIN)) {
David Brazdil21c887c2022-09-23 12:25:18 +01001510 base::unique_fd acceptedFd = mAcceptConnection(this);
Yifan Hong1deca4b2021-09-10 16:16:44 -07001511 threads.emplace_back(&Server::handleOne, this, std::move(acceptedFd));
1512 }
1513
1514 for (auto& thread : threads) thread.join();
1515 }
1516 void handleOne(android::base::unique_fd acceptedFd) {
1517 ASSERT_TRUE(acceptedFd.ok());
Pawan3e0061c2022-08-26 21:08:34 +00001518 RpcTransportFd transportFd(std::move(acceptedFd));
Pawan49d74cb2022-08-03 21:19:11 +00001519 auto serverTransport = mCtx->newTransport(std::move(transportFd), mFdTrigger.get());
Yifan Hong1deca4b2021-09-10 16:16:44 -07001520 if (serverTransport == nullptr) return; // handshake failed
Yifan Hong67519322021-09-13 18:51:16 -07001521 ASSERT_TRUE(mPostConnect(serverTransport.get(), mFdTrigger.get()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001522 }
Yifan Honge07d2732021-09-13 21:59:14 -07001523 void shutdownAndWait() {
Yifan Hong67519322021-09-13 18:51:16 -07001524 shutdown();
1525 join();
1526 }
1527 void shutdown() { mFdTrigger->trigger(); }
1528
1529 void setPostConnect(
1530 std::function<AssertionResult(RpcTransport*, FdTrigger* fdTrigger)> fn) {
1531 mPostConnect = std::move(fn);
Yifan Hong1deca4b2021-09-10 16:16:44 -07001532 }
1533
1534 private:
1535 std::unique_ptr<std::thread> mThread;
1536 ConnectToServer mConnectToServer;
David Brazdil21c887c2022-09-23 12:25:18 +01001537 AcceptConnection mAcceptConnection = &Server::acceptServerConnection;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001538 std::unique_ptr<FdTrigger> mFdTrigger = FdTrigger::make();
David Brazdil21c887c2022-09-23 12:25:18 +01001539 RpcTransportFd mFd, mBootstrapSocket;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001540 std::unique_ptr<RpcTransportCtx> mCtx;
1541 std::shared_ptr<RpcCertificateVerifierSimple> mCertVerifier =
1542 std::make_shared<RpcCertificateVerifierSimple>();
1543 bool mSetup = false;
Yifan Hong67519322021-09-13 18:51:16 -07001544 // The function invoked after connection and handshake. By default, it is
1545 // |defaultPostConnect| that sends |kMessage| to the client.
1546 std::function<AssertionResult(RpcTransport*, FdTrigger* fdTrigger)> mPostConnect =
1547 Server::defaultPostConnect;
1548
1549 void join() {
1550 if (mThread != nullptr) {
1551 mThread->join();
1552 mThread = nullptr;
1553 }
1554 }
1555
1556 static AssertionResult defaultPostConnect(RpcTransport* serverTransport,
1557 FdTrigger* fdTrigger) {
1558 std::string message(kMessage);
Andrei Homescua39e4ed2021-12-10 08:41:54 +00001559 iovec messageIov{message.data(), message.size()};
Devin Moore695368f2022-06-03 22:29:14 +00001560 auto status = serverTransport->interruptableWriteFully(fdTrigger, &messageIov, 1,
Frederick Mayle69a0c992022-05-26 20:38:39 +00001561 std::nullopt, nullptr);
Yifan Hong67519322021-09-13 18:51:16 -07001562 if (status != OK) return AssertionFailure() << statusToString(status);
1563 return AssertionSuccess();
1564 }
Yifan Hong1deca4b2021-09-10 16:16:44 -07001565 };
1566
1567 class Client {
1568 public:
1569 explicit Client(ConnectToServer connectToServer) : mConnectToServer(connectToServer) {}
1570 Client(Client&&) = default;
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001571 [[nodiscard]] AssertionResult setUp(const Param& param) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001572 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = param;
1573 (void)serverVersion;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001574 mFdTrigger = FdTrigger::make();
1575 mCtx = newFactory(rpcSecurity, mCertVerifier)->newClientCtx();
1576 if (mCtx == nullptr) return AssertionFailure() << "newClientCtx";
1577 return AssertionSuccess();
1578 }
1579 RpcTransportCtx* getCtx() const { return mCtx.get(); }
1580 std::shared_ptr<RpcCertificateVerifierSimple> getCertVerifier() const {
1581 return mCertVerifier;
1582 }
Yifan Hong67519322021-09-13 18:51:16 -07001583 // connect() and do handshake
1584 bool setUpTransport() {
1585 mFd = mConnectToServer();
Pawan49d74cb2022-08-03 21:19:11 +00001586 if (!mFd.fd.ok()) return AssertionFailure() << "Cannot connect to server";
Yifan Hong67519322021-09-13 18:51:16 -07001587 mClientTransport = mCtx->newTransport(std::move(mFd), mFdTrigger.get());
1588 return mClientTransport != nullptr;
1589 }
1590 AssertionResult readMessage(const std::string& expectedMessage = kMessage) {
1591 LOG_ALWAYS_FATAL_IF(mClientTransport == nullptr, "setUpTransport not called or failed");
1592 std::string readMessage(expectedMessage.size(), '\0');
Andrei Homescua39e4ed2021-12-10 08:41:54 +00001593 iovec readMessageIov{readMessage.data(), readMessage.size()};
Devin Moore695368f2022-06-03 22:29:14 +00001594 status_t readStatus =
1595 mClientTransport->interruptableReadFully(mFdTrigger.get(), &readMessageIov, 1,
Frederick Mayleffe9ac22022-06-30 02:07:36 +00001596 std::nullopt, nullptr);
Yifan Hong67519322021-09-13 18:51:16 -07001597 if (readStatus != OK) {
1598 return AssertionFailure() << statusToString(readStatus);
1599 }
1600 if (readMessage != expectedMessage) {
1601 return AssertionFailure()
1602 << "Expected " << expectedMessage << ", actual " << readMessage;
1603 }
1604 return AssertionSuccess();
1605 }
Yifan Hong1deca4b2021-09-10 16:16:44 -07001606 void run(bool handshakeOk = true, bool readOk = true) {
Yifan Hong67519322021-09-13 18:51:16 -07001607 if (!setUpTransport()) {
Yifan Hong1deca4b2021-09-10 16:16:44 -07001608 ASSERT_FALSE(handshakeOk) << "newTransport returns nullptr, but it shouldn't";
1609 return;
1610 }
1611 ASSERT_TRUE(handshakeOk) << "newTransport does not return nullptr, but it should";
Yifan Hong67519322021-09-13 18:51:16 -07001612 ASSERT_EQ(readOk, readMessage());
Yifan Hong1deca4b2021-09-10 16:16:44 -07001613 }
1614
Pawan49d74cb2022-08-03 21:19:11 +00001615 bool isTransportWaiting() { return mClientTransport->isWaiting(); }
1616
Yifan Hong1deca4b2021-09-10 16:16:44 -07001617 private:
1618 ConnectToServer mConnectToServer;
Pawan3e0061c2022-08-26 21:08:34 +00001619 RpcTransportFd mFd;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001620 std::unique_ptr<FdTrigger> mFdTrigger = FdTrigger::make();
1621 std::unique_ptr<RpcTransportCtx> mCtx;
1622 std::shared_ptr<RpcCertificateVerifierSimple> mCertVerifier =
1623 std::make_shared<RpcCertificateVerifierSimple>();
Yifan Hong67519322021-09-13 18:51:16 -07001624 std::unique_ptr<RpcTransport> mClientTransport;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001625 };
1626
1627 // Make A trust B.
1628 template <typename A, typename B>
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001629 static status_t trust(RpcSecurity rpcSecurity,
1630 std::optional<RpcCertificateFormat> certificateFormat, const A& a,
1631 const B& b) {
Yifan Hong1deca4b2021-09-10 16:16:44 -07001632 if (rpcSecurity != RpcSecurity::TLS) return OK;
Yifan Hong22211f82021-09-14 12:32:25 -07001633 LOG_ALWAYS_FATAL_IF(!certificateFormat.has_value());
1634 auto bCert = b->getCtx()->getCertificate(*certificateFormat);
1635 return a->getCertVerifier()->addTrustedPeerCertificate(*certificateFormat, bCert);
Yifan Hong1deca4b2021-09-10 16:16:44 -07001636 }
1637
1638 static constexpr const char* kMessage = "hello";
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001639};
1640
1641class RpcTransportTest : public testing::TestWithParam<RpcTransportTestUtils::Param> {
1642public:
1643 using Server = RpcTransportTestUtils::Server;
1644 using Client = RpcTransportTestUtils::Client;
1645 static inline std::string PrintParamInfo(const testing::TestParamInfo<ParamType>& info) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001646 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = info.param;
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001647 auto ret = PrintToString(socketType) + "_" + newFactory(rpcSecurity)->toCString();
1648 if (certificateFormat.has_value()) ret += "_" + PrintToString(*certificateFormat);
Frederick Mayledc07cf82022-05-26 20:30:12 +00001649 ret += "_serverV" + std::to_string(serverVersion);
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001650 return ret;
1651 }
1652 static std::vector<ParamType> getRpcTranportTestParams() {
1653 std::vector<ParamType> ret;
Frederick Mayledc07cf82022-05-26 20:30:12 +00001654 for (auto serverVersion : testVersions()) {
1655 for (auto socketType : testSocketTypes(false /* hasPreconnected */)) {
1656 for (auto rpcSecurity : RpcSecurityValues()) {
1657 switch (rpcSecurity) {
1658 case RpcSecurity::RAW: {
1659 ret.emplace_back(socketType, rpcSecurity, std::nullopt, serverVersion);
1660 } break;
1661 case RpcSecurity::TLS: {
1662 ret.emplace_back(socketType, rpcSecurity, RpcCertificateFormat::PEM,
1663 serverVersion);
1664 ret.emplace_back(socketType, rpcSecurity, RpcCertificateFormat::DER,
1665 serverVersion);
1666 } break;
1667 }
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001668 }
1669 }
1670 }
1671 return ret;
1672 }
1673 template <typename A, typename B>
1674 status_t trust(const A& a, const B& b) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001675 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = GetParam();
1676 (void)serverVersion;
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001677 return RpcTransportTestUtils::trust(rpcSecurity, certificateFormat, a, b);
1678 }
Andrei Homescu12106de2022-04-27 04:42:21 +00001679 void SetUp() override {
1680 if constexpr (!kEnableRpcThreads) {
1681 GTEST_SKIP() << "Test skipped because threads were disabled at build time";
1682 }
1683 }
Yifan Hong1deca4b2021-09-10 16:16:44 -07001684};
1685
1686TEST_P(RpcTransportTest, GoodCertificate) {
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001687 auto server = std::make_unique<Server>();
1688 ASSERT_TRUE(server->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001689
1690 Client client(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001691 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001692
1693 ASSERT_EQ(OK, trust(&client, server));
1694 ASSERT_EQ(OK, trust(server, &client));
1695
1696 server->start();
1697 client.run();
1698}
1699
1700TEST_P(RpcTransportTest, MultipleClients) {
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001701 auto server = std::make_unique<Server>();
1702 ASSERT_TRUE(server->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001703
1704 std::vector<Client> clients;
1705 for (int i = 0; i < 2; i++) {
1706 auto& client = clients.emplace_back(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001707 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001708 ASSERT_EQ(OK, trust(&client, server));
1709 ASSERT_EQ(OK, trust(server, &client));
1710 }
1711
1712 server->start();
1713 for (auto& client : clients) client.run();
1714}
1715
1716TEST_P(RpcTransportTest, UntrustedServer) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001717 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = GetParam();
1718 (void)serverVersion;
Yifan Hong1deca4b2021-09-10 16:16:44 -07001719
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001720 auto untrustedServer = std::make_unique<Server>();
1721 ASSERT_TRUE(untrustedServer->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001722
1723 Client client(untrustedServer->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001724 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001725
1726 ASSERT_EQ(OK, trust(untrustedServer, &client));
1727
1728 untrustedServer->start();
1729
1730 // For TLS, this should reject the certificate. For RAW sockets, it should pass because
1731 // the client can't verify the server's identity.
1732 bool handshakeOk = rpcSecurity != RpcSecurity::TLS;
1733 client.run(handshakeOk);
1734}
1735TEST_P(RpcTransportTest, MaliciousServer) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001736 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = GetParam();
1737 (void)serverVersion;
1738
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001739 auto validServer = std::make_unique<Server>();
1740 ASSERT_TRUE(validServer->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001741
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001742 auto maliciousServer = std::make_unique<Server>();
1743 ASSERT_TRUE(maliciousServer->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001744
1745 Client client(maliciousServer->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001746 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001747
1748 ASSERT_EQ(OK, trust(&client, validServer));
1749 ASSERT_EQ(OK, trust(validServer, &client));
1750 ASSERT_EQ(OK, trust(maliciousServer, &client));
1751
1752 maliciousServer->start();
1753
1754 // For TLS, this should reject the certificate. For RAW sockets, it should pass because
1755 // the client can't verify the server's identity.
1756 bool handshakeOk = rpcSecurity != RpcSecurity::TLS;
1757 client.run(handshakeOk);
1758}
1759
1760TEST_P(RpcTransportTest, UntrustedClient) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001761 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = GetParam();
1762 (void)serverVersion;
1763
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001764 auto server = std::make_unique<Server>();
1765 ASSERT_TRUE(server->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001766
1767 Client client(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001768 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001769
1770 ASSERT_EQ(OK, trust(&client, server));
1771
1772 server->start();
1773
1774 // For TLS, Client should be able to verify server's identity, so client should see
1775 // do_handshake() successfully executed. However, server shouldn't be able to verify client's
1776 // identity and should drop the connection, so client shouldn't be able to read anything.
1777 bool readOk = rpcSecurity != RpcSecurity::TLS;
1778 client.run(true, readOk);
1779}
1780
1781TEST_P(RpcTransportTest, MaliciousClient) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001782 auto [socketType, rpcSecurity, certificateFormat, serverVersion] = GetParam();
1783 (void)serverVersion;
1784
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001785 auto server = std::make_unique<Server>();
1786 ASSERT_TRUE(server->setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001787
1788 Client validClient(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001789 ASSERT_TRUE(validClient.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001790 Client maliciousClient(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001791 ASSERT_TRUE(maliciousClient.setUp(GetParam()));
Yifan Hong1deca4b2021-09-10 16:16:44 -07001792
1793 ASSERT_EQ(OK, trust(&validClient, server));
1794 ASSERT_EQ(OK, trust(&maliciousClient, server));
1795
1796 server->start();
1797
1798 // See UntrustedClient.
1799 bool readOk = rpcSecurity != RpcSecurity::TLS;
1800 maliciousClient.run(true, readOk);
1801}
1802
Yifan Hong67519322021-09-13 18:51:16 -07001803TEST_P(RpcTransportTest, Trigger) {
1804 std::string msg2 = ", world!";
1805 std::mutex writeMutex;
1806 std::condition_variable writeCv;
1807 bool shouldContinueWriting = false;
1808 auto serverPostConnect = [&](RpcTransport* serverTransport, FdTrigger* fdTrigger) {
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001809 std::string message(RpcTransportTestUtils::kMessage);
Andrei Homescua39e4ed2021-12-10 08:41:54 +00001810 iovec messageIov{message.data(), message.size()};
Frederick Mayle69a0c992022-05-26 20:38:39 +00001811 auto status = serverTransport->interruptableWriteFully(fdTrigger, &messageIov, 1,
1812 std::nullopt, nullptr);
Yifan Hong67519322021-09-13 18:51:16 -07001813 if (status != OK) return AssertionFailure() << statusToString(status);
1814
1815 {
1816 std::unique_lock<std::mutex> lock(writeMutex);
1817 if (!writeCv.wait_for(lock, 3s, [&] { return shouldContinueWriting; })) {
1818 return AssertionFailure() << "write barrier not cleared in time!";
1819 }
1820 }
1821
Andrei Homescua39e4ed2021-12-10 08:41:54 +00001822 iovec msg2Iov{msg2.data(), msg2.size()};
Frederick Mayle69a0c992022-05-26 20:38:39 +00001823 status = serverTransport->interruptableWriteFully(fdTrigger, &msg2Iov, 1, std::nullopt,
1824 nullptr);
Steven Morelandc591b472021-09-16 13:56:11 -07001825 if (status != DEAD_OBJECT)
Yifan Hong67519322021-09-13 18:51:16 -07001826 return AssertionFailure() << "When FdTrigger is shut down, interruptableWriteFully "
Steven Morelandc591b472021-09-16 13:56:11 -07001827 "should return DEAD_OBJECT, but it is "
Yifan Hong67519322021-09-13 18:51:16 -07001828 << statusToString(status);
1829 return AssertionSuccess();
1830 };
1831
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001832 auto server = std::make_unique<Server>();
1833 ASSERT_TRUE(server->setUp(GetParam()));
Yifan Hong67519322021-09-13 18:51:16 -07001834
1835 // Set up client
1836 Client client(server->getConnectToServerFn());
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001837 ASSERT_TRUE(client.setUp(GetParam()));
Yifan Hong67519322021-09-13 18:51:16 -07001838
1839 // Exchange keys
1840 ASSERT_EQ(OK, trust(&client, server));
1841 ASSERT_EQ(OK, trust(server, &client));
1842
1843 server->setPostConnect(serverPostConnect);
1844
Yifan Hong67519322021-09-13 18:51:16 -07001845 server->start();
1846 // connect() to server and do handshake
1847 ASSERT_TRUE(client.setUpTransport());
Yifan Hong22211f82021-09-14 12:32:25 -07001848 // read the first message. This ensures that server has finished handshake and start handling
1849 // client fd. Server thread should pause at writeCv.wait_for().
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001850 ASSERT_TRUE(client.readMessage(RpcTransportTestUtils::kMessage));
Yifan Hong67519322021-09-13 18:51:16 -07001851 // Trigger server shutdown after server starts handling client FD. This ensures that the second
1852 // write is on an FdTrigger that has been shut down.
1853 server->shutdown();
1854 // Continues server thread to write the second message.
1855 {
Yifan Hong22211f82021-09-14 12:32:25 -07001856 std::lock_guard<std::mutex> lock(writeMutex);
Yifan Hong67519322021-09-13 18:51:16 -07001857 shouldContinueWriting = true;
Yifan Hong67519322021-09-13 18:51:16 -07001858 }
Yifan Hong22211f82021-09-14 12:32:25 -07001859 writeCv.notify_all();
Yifan Hong67519322021-09-13 18:51:16 -07001860 // After this line, server thread unblocks and attempts to write the second message, but
Steven Morelandc591b472021-09-16 13:56:11 -07001861 // shutdown is triggered, so write should failed with DEAD_OBJECT. See |serverPostConnect|.
Yifan Hong67519322021-09-13 18:51:16 -07001862 // On the client side, second read fails with DEAD_OBJECT
1863 ASSERT_FALSE(client.readMessage(msg2));
1864}
1865
Pawan49d74cb2022-08-03 21:19:11 +00001866TEST_P(RpcTransportTest, CheckWaitingForRead) {
1867 std::mutex readMutex;
1868 std::condition_variable readCv;
1869 bool shouldContinueReading = false;
1870 // Server will write data on transport once its started
1871 auto serverPostConnect = [&](RpcTransport* serverTransport, FdTrigger* fdTrigger) {
1872 std::string message(RpcTransportTestUtils::kMessage);
1873 iovec messageIov{message.data(), message.size()};
1874 auto status = serverTransport->interruptableWriteFully(fdTrigger, &messageIov, 1,
1875 std::nullopt, nullptr);
1876 if (status != OK) return AssertionFailure() << statusToString(status);
1877
1878 {
1879 std::unique_lock<std::mutex> lock(readMutex);
1880 shouldContinueReading = true;
1881 lock.unlock();
1882 readCv.notify_all();
1883 }
1884 return AssertionSuccess();
1885 };
1886
1887 // Setup Server and client
1888 auto server = std::make_unique<Server>();
1889 ASSERT_TRUE(server->setUp(GetParam()));
1890
1891 Client client(server->getConnectToServerFn());
1892 ASSERT_TRUE(client.setUp(GetParam()));
1893
1894 ASSERT_EQ(OK, trust(&client, server));
1895 ASSERT_EQ(OK, trust(server, &client));
1896 server->setPostConnect(serverPostConnect);
1897
1898 server->start();
1899 ASSERT_TRUE(client.setUpTransport());
1900 {
1901 // Wait till server writes data
1902 std::unique_lock<std::mutex> lock(readMutex);
1903 ASSERT_TRUE(readCv.wait_for(lock, 3s, [&] { return shouldContinueReading; }));
1904 }
1905
1906 // Since there is no read polling here, we will get polling count 0
1907 ASSERT_FALSE(client.isTransportWaiting());
1908 ASSERT_TRUE(client.readMessage(RpcTransportTestUtils::kMessage));
1909 // Thread should increment polling count, read and decrement polling count
1910 // Again, polling count should be zero here
1911 ASSERT_FALSE(client.isTransportWaiting());
1912
1913 server->shutdown();
1914}
1915
Yifan Hong1deca4b2021-09-10 16:16:44 -07001916INSTANTIATE_TEST_CASE_P(BinderRpc, RpcTransportTest,
Yifan Hong22211f82021-09-14 12:32:25 -07001917 ::testing::ValuesIn(RpcTransportTest::getRpcTranportTestParams()),
Yifan Hong1deca4b2021-09-10 16:16:44 -07001918 RpcTransportTest::PrintParamInfo);
1919
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001920class RpcTransportTlsKeyTest
Frederick Mayledc07cf82022-05-26 20:30:12 +00001921 : public testing::TestWithParam<
1922 std::tuple<SocketType, RpcCertificateFormat, RpcKeyFormat, uint32_t>> {
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001923public:
1924 template <typename A, typename B>
1925 status_t trust(const A& a, const B& b) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001926 auto [socketType, certificateFormat, keyFormat, serverVersion] = GetParam();
1927 (void)serverVersion;
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001928 return RpcTransportTestUtils::trust(RpcSecurity::TLS, certificateFormat, a, b);
1929 }
1930 static std::string PrintParamInfo(const testing::TestParamInfo<ParamType>& info) {
Frederick Mayledc07cf82022-05-26 20:30:12 +00001931 auto [socketType, certificateFormat, keyFormat, serverVersion] = info.param;
1932 return PrintToString(socketType) + "_certificate_" + PrintToString(certificateFormat) +
1933 "_key_" + PrintToString(keyFormat) + "_serverV" + std::to_string(serverVersion);
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001934 };
1935};
1936
1937TEST_P(RpcTransportTlsKeyTest, PreSignedCertificate) {
Andrei Homescu12106de2022-04-27 04:42:21 +00001938 if constexpr (!kEnableRpcThreads) {
1939 GTEST_SKIP() << "Test skipped because threads were disabled at build time";
1940 }
1941
Frederick Mayledc07cf82022-05-26 20:30:12 +00001942 auto [socketType, certificateFormat, keyFormat, serverVersion] = GetParam();
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001943
1944 std::vector<uint8_t> pkeyData, certData;
1945 {
1946 auto pkey = makeKeyPairForSelfSignedCert();
1947 ASSERT_NE(nullptr, pkey);
1948 auto cert = makeSelfSignedCert(pkey.get(), kCertValidSeconds);
1949 ASSERT_NE(nullptr, cert);
1950 pkeyData = serializeUnencryptedPrivatekey(pkey.get(), keyFormat);
1951 certData = serializeCertificate(cert.get(), certificateFormat);
1952 }
1953
1954 auto desPkey = deserializeUnencryptedPrivatekey(pkeyData, keyFormat);
1955 auto desCert = deserializeCertificate(certData, certificateFormat);
1956 auto auth = std::make_unique<RpcAuthPreSigned>(std::move(desPkey), std::move(desCert));
Frederick Mayledc07cf82022-05-26 20:30:12 +00001957 auto utilsParam = std::make_tuple(socketType, RpcSecurity::TLS,
1958 std::make_optional(certificateFormat), serverVersion);
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001959
1960 auto server = std::make_unique<RpcTransportTestUtils::Server>();
1961 ASSERT_TRUE(server->setUp(utilsParam, std::move(auth)));
1962
1963 RpcTransportTestUtils::Client client(server->getConnectToServerFn());
1964 ASSERT_TRUE(client.setUp(utilsParam));
1965
1966 ASSERT_EQ(OK, trust(&client, server));
1967 ASSERT_EQ(OK, trust(server, &client));
1968
1969 server->start();
1970 client.run();
1971}
1972
1973INSTANTIATE_TEST_CASE_P(
1974 BinderRpc, RpcTransportTlsKeyTest,
1975 testing::Combine(testing::ValuesIn(testSocketTypes(false /* hasPreconnected*/)),
1976 testing::Values(RpcCertificateFormat::PEM, RpcCertificateFormat::DER),
Frederick Mayledc07cf82022-05-26 20:30:12 +00001977 testing::Values(RpcKeyFormat::PEM, RpcKeyFormat::DER),
1978 testing::ValuesIn(testVersions())),
Yifan Hongb1ce80c2021-09-17 22:10:58 -07001979 RpcTransportTlsKeyTest::PrintParamInfo);
1980
Steven Morelandc1635952021-04-01 16:20:47 +00001981} // namespace android
1982
1983int main(int argc, char** argv) {
Steven Moreland5553ac42020-11-11 02:14:45 +00001984 ::testing::InitGoogleTest(&argc, argv);
1985 android::base::InitLogging(argv, android::base::StderrLogger, android::base::DefaultAborter);
Steven Morelanda83191d2021-10-27 10:14:53 -07001986
Steven Moreland5553ac42020-11-11 02:14:45 +00001987 return RUN_ALL_TESTS();
1988}