blob: 9622313699c1e68947653f211c0c56edbb3e7a66 [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
17#define LOG_TAG "RpcServer"
18
Steven Morelandc5032042021-09-30 15:40:27 -070019#include <inttypes.h>
Steven Moreland798e0d12021-07-14 23:19:25 +000020#include <poll.h>
Steven Moreland5553ac42020-11-11 02:14:45 +000021#include <sys/socket.h>
22#include <sys/un.h>
23
Steven Morelandf137de92021-04-24 01:54:26 +000024#include <thread>
Steven Moreland5553ac42020-11-11 02:14:45 +000025#include <vector>
26
Steven Moreland5802c2b2021-05-12 20:13:04 +000027#include <android-base/scopeguard.h>
Steven Moreland5553ac42020-11-11 02:14:45 +000028#include <binder/Parcel.h>
29#include <binder/RpcServer.h>
Yifan Hong702115c2021-06-24 15:39:18 -070030#include <binder/RpcTransportRaw.h>
Steven Moreland5553ac42020-11-11 02:14:45 +000031#include <log/log.h>
Andrei Homescu1d935e82022-04-25 04:58:23 +000032#include <utils/Compat.h>
Steven Moreland5553ac42020-11-11 02:14:45 +000033
Andrei Homescuffa3aaa2022-04-07 05:06:33 +000034#include "BuildFlags.h"
Yifan Hong8c950422021-08-05 17:13:55 -070035#include "FdTrigger.h"
Andrei Homescu7c0b79f2022-06-30 02:00:46 +000036#include "OS.h"
Steven Moreland611d15f2021-05-01 01:28:27 +000037#include "RpcSocketAddress.h"
Yifan Hong1a235852021-05-13 16:07:47 -070038#include "RpcState.h"
David Brazdil21c887c2022-09-23 12:25:18 +010039#include "RpcTransportUtils.h"
Steven Moreland5553ac42020-11-11 02:14:45 +000040#include "RpcWireFormat.h"
Andrei Homescuc24c8792022-04-19 00:24:51 +000041#include "Utils.h"
Steven Moreland5553ac42020-11-11 02:14:45 +000042
43namespace android {
44
Steven Morelandc5032042021-09-30 15:40:27 -070045constexpr size_t kSessionIdBytes = 32;
46
Steven Moreland5802c2b2021-05-12 20:13:04 +000047using base::ScopeGuard;
Steven Moreland611d15f2021-05-01 01:28:27 +000048using base::unique_fd;
49
Yifan Hongecf937d2021-08-11 17:29:28 -070050RpcServer::RpcServer(std::unique_ptr<RpcTransportCtx> ctx) : mCtx(std::move(ctx)) {}
Yifan Hong436f0e62021-05-19 15:25:34 -070051RpcServer::~RpcServer() {
David Brazdil4766a1f2022-12-19 21:58:25 +000052 RpcMutexUniqueLock _l(mLock);
53 LOG_ALWAYS_FATAL_IF(mShutdownTrigger != nullptr, "Must call shutdown() before destructor");
Yifan Hong436f0e62021-05-19 15:25:34 -070054}
Steven Moreland5553ac42020-11-11 02:14:45 +000055
Yifan Hong702115c2021-06-24 15:39:18 -070056sp<RpcServer> RpcServer::make(std::unique_ptr<RpcTransportCtxFactory> rpcTransportCtxFactory) {
57 // Default is without TLS.
58 if (rpcTransportCtxFactory == nullptr)
Andrei Homescu024727b2022-08-24 23:54:59 +000059 rpcTransportCtxFactory = makeDefaultRpcTransportCtxFactory();
Yifan Hongecf937d2021-08-11 17:29:28 -070060 auto ctx = rpcTransportCtxFactory->newServerCtx();
61 if (ctx == nullptr) return nullptr;
62 return sp<RpcServer>::make(std::move(ctx));
Steven Moreland5553ac42020-11-11 02:14:45 +000063}
64
David Brazdil21c887c2022-09-23 12:25:18 +010065status_t RpcServer::setupUnixDomainSocketBootstrapServer(unique_fd bootstrapFd) {
66 return setupExternalServer(std::move(bootstrapFd), &RpcServer::recvmsgSocketConnection);
67}
68
Steven Moreland2372f9d2021-08-05 15:42:01 -070069status_t RpcServer::setupUnixDomainServer(const char* path) {
Steven Moreland611d15f2021-05-01 01:28:27 +000070 return setupSocketServer(UnixSocketAddress(path));
71}
72
David Brazdila47dfda2022-11-22 22:52:19 +000073status_t RpcServer::setupVsockServer(unsigned int bindCid, unsigned int port) {
74 return setupSocketServer(VsockSocketAddress(bindCid, port));
Steven Moreland611d15f2021-05-01 01:28:27 +000075}
76
Steven Moreland2372f9d2021-08-05 15:42:01 -070077status_t RpcServer::setupInetServer(const char* address, unsigned int port,
78 unsigned int* assignedPort) {
Steven Moreland611d15f2021-05-01 01:28:27 +000079 if (assignedPort != nullptr) *assignedPort = 0;
Devin Mooref3b9c4f2021-08-03 15:50:13 +000080 auto aiStart = InetSocketAddress::getAddrInfo(address, port);
Steven Moreland2372f9d2021-08-05 15:42:01 -070081 if (aiStart == nullptr) return UNKNOWN_ERROR;
Steven Moreland611d15f2021-05-01 01:28:27 +000082 for (auto ai = aiStart.get(); ai != nullptr; ai = ai->ai_next) {
zijunzhaoa2013362023-05-11 21:27:19 +000083 if (ai->ai_addr == nullptr) continue;
Devin Mooref3b9c4f2021-08-03 15:50:13 +000084 InetSocketAddress socketAddress(ai->ai_addr, ai->ai_addrlen, address, port);
Steven Moreland2372f9d2021-08-05 15:42:01 -070085 if (status_t status = setupSocketServer(socketAddress); status != OK) {
Steven Moreland611d15f2021-05-01 01:28:27 +000086 continue;
87 }
88
89 LOG_ALWAYS_FATAL_IF(socketAddress.addr()->sa_family != AF_INET, "expecting inet");
90 sockaddr_in addr{};
91 socklen_t len = sizeof(addr);
Pawan49d74cb2022-08-03 21:19:11 +000092 if (0 != getsockname(mServer.fd.get(), reinterpret_cast<sockaddr*>(&addr), &len)) {
Steven Moreland611d15f2021-05-01 01:28:27 +000093 int savedErrno = errno;
94 ALOGE("Could not getsockname at %s: %s", socketAddress.toString().c_str(),
95 strerror(savedErrno));
Steven Moreland2372f9d2021-08-05 15:42:01 -070096 return -savedErrno;
Steven Moreland611d15f2021-05-01 01:28:27 +000097 }
98 LOG_ALWAYS_FATAL_IF(len != sizeof(addr), "Wrong socket type: len %zu vs len %zu",
99 static_cast<size_t>(len), sizeof(addr));
100 unsigned int realPort = ntohs(addr.sin_port);
101 LOG_ALWAYS_FATAL_IF(port != 0 && realPort != port,
102 "Requesting inet server on %s but it is set up on %u.",
103 socketAddress.toString().c_str(), realPort);
104
105 if (assignedPort != nullptr) {
106 *assignedPort = realPort;
107 }
108
Steven Moreland2372f9d2021-08-05 15:42:01 -0700109 return OK;
Steven Moreland611d15f2021-05-01 01:28:27 +0000110 }
Devin Mooref3b9c4f2021-08-03 15:50:13 +0000111 ALOGE("None of the socket address resolved for %s:%u can be set up as inet server.", address,
Steven Moreland611d15f2021-05-01 01:28:27 +0000112 port);
Steven Moreland2372f9d2021-08-05 15:42:01 -0700113 return UNKNOWN_ERROR;
Steven Moreland611d15f2021-05-01 01:28:27 +0000114}
115
Steven Morelandf137de92021-04-24 01:54:26 +0000116void RpcServer::setMaxThreads(size_t threads) {
117 LOG_ALWAYS_FATAL_IF(threads <= 0, "RpcServer is useless without threads");
Yifan Hong1a235852021-05-13 16:07:47 -0700118 LOG_ALWAYS_FATAL_IF(mJoinThreadRunning, "Cannot set max threads while running");
Steven Morelandf137de92021-04-24 01:54:26 +0000119 mMaxThreads = threads;
120}
121
122size_t RpcServer::getMaxThreads() {
123 return mMaxThreads;
Steven Moreland5553ac42020-11-11 02:14:45 +0000124}
125
Steven Morelandca3f6382023-05-11 23:23:26 +0000126bool RpcServer::setProtocolVersion(uint32_t version) {
127 if (!RpcState::validateProtocolVersion(version)) {
128 return false;
129 }
130
Steven Morelandbf57bce2021-07-26 15:26:12 -0700131 mProtocolVersion = version;
Steven Morelandca3f6382023-05-11 23:23:26 +0000132 return true;
Steven Morelandbf57bce2021-07-26 15:26:12 -0700133}
134
Frederick Mayle69a0c992022-05-26 20:38:39 +0000135void RpcServer::setSupportedFileDescriptorTransportModes(
136 const std::vector<RpcSession::FileDescriptorTransportMode>& modes) {
137 mSupportedFileDescriptorTransportModes.reset();
138 for (RpcSession::FileDescriptorTransportMode mode : modes) {
139 mSupportedFileDescriptorTransportModes.set(static_cast<size_t>(mode));
140 }
141}
142
Steven Moreland5553ac42020-11-11 02:14:45 +0000143void RpcServer::setRootObject(const sp<IBinder>& binder) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000144 RpcMutexLockGuard _l(mLock);
Steven Moreland51c44a92021-10-14 16:50:35 -0700145 mRootObjectFactory = nullptr;
Yifan Hong4ffb0c72021-05-07 18:35:14 -0700146 mRootObjectWeak = mRootObject = binder;
147}
148
149void RpcServer::setRootObjectWeak(const wp<IBinder>& binder) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000150 RpcMutexLockGuard _l(mLock);
Yifan Hong4ffb0c72021-05-07 18:35:14 -0700151 mRootObject.clear();
Steven Moreland51c44a92021-10-14 16:50:35 -0700152 mRootObjectFactory = nullptr;
Yifan Hong4ffb0c72021-05-07 18:35:14 -0700153 mRootObjectWeak = binder;
Steven Moreland5553ac42020-11-11 02:14:45 +0000154}
Steven Moreland51c44a92021-10-14 16:50:35 -0700155void RpcServer::setPerSessionRootObject(
Steven Morelanddfb92182023-05-24 17:48:59 +0000156 std::function<sp<IBinder>(wp<RpcSession> session, const void*, size_t)>&& makeObject) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000157 RpcMutexLockGuard _l(mLock);
Steven Moreland51c44a92021-10-14 16:50:35 -0700158 mRootObject.clear();
159 mRootObjectWeak.clear();
160 mRootObjectFactory = std::move(makeObject);
161}
Steven Moreland5553ac42020-11-11 02:14:45 +0000162
David Brazdila47dfda2022-11-22 22:52:19 +0000163void RpcServer::setConnectionFilter(std::function<bool(const void*, size_t)>&& filter) {
164 RpcMutexLockGuard _l(mLock);
165 LOG_ALWAYS_FATAL_IF(mShutdownTrigger != nullptr, "Already joined");
166 mConnectionFilter = std::move(filter);
167}
168
Tomasz Wasilczyk7c8dd482023-03-23 15:30:03 -0700169void RpcServer::setServerSocketModifier(std::function<void(base::borrowed_fd)>&& modifier) {
170 RpcMutexLockGuard _l(mLock);
171 LOG_ALWAYS_FATAL_IF(mServer.fd != -1, "Already started");
172 mServerSocketModifier = std::move(modifier);
173}
174
Steven Moreland5553ac42020-11-11 02:14:45 +0000175sp<IBinder> RpcServer::getRootObject() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000176 RpcMutexLockGuard _l(mLock);
Yifan Hong4ffb0c72021-05-07 18:35:14 -0700177 bool hasWeak = mRootObjectWeak.unsafe_get();
178 sp<IBinder> ret = mRootObjectWeak.promote();
179 ALOGW_IF(hasWeak && ret == nullptr, "RpcServer root object is freed, returning nullptr");
180 return ret;
Steven Moreland5553ac42020-11-11 02:14:45 +0000181}
182
Yifan Hong9734cfc2021-09-13 16:14:09 -0700183std::vector<uint8_t> RpcServer::getCertificate(RpcCertificateFormat format) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000184 RpcMutexLockGuard _l(mLock);
Yifan Hongecf937d2021-08-11 17:29:28 -0700185 return mCtx->getCertificate(format);
186}
187
Yifan Hong326afd12021-05-19 15:24:54 -0700188static void joinRpcServer(sp<RpcServer>&& thiz) {
189 thiz->join();
190}
191
192void RpcServer::start() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000193 RpcMutexLockGuard _l(mLock);
Yifan Hong326afd12021-05-19 15:24:54 -0700194 LOG_ALWAYS_FATAL_IF(mJoinThread.get(), "Already started!");
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000195 mJoinThread =
196 std::make_unique<RpcMaybeThread>(&joinRpcServer, sp<RpcServer>::fromExisting(this));
197 rpcJoinIfSingleThreaded(*mJoinThread);
Yifan Hong326afd12021-05-19 15:24:54 -0700198}
199
David Brazdil21c887c2022-09-23 12:25:18 +0100200status_t RpcServer::acceptSocketConnection(const RpcServer& server, RpcTransportFd* out) {
201 RpcTransportFd clientSocket(unique_fd(TEMP_FAILURE_RETRY(
202 accept4(server.mServer.fd.get(), nullptr, nullptr, SOCK_CLOEXEC | SOCK_NONBLOCK))));
203 if (clientSocket.fd < 0) {
204 int savedErrno = errno;
205 ALOGE("Could not accept4 socket: %s", strerror(savedErrno));
206 return -savedErrno;
207 }
208
209 *out = std::move(clientSocket);
210 return OK;
211}
212
213status_t RpcServer::recvmsgSocketConnection(const RpcServer& server, RpcTransportFd* out) {
214 int zero = 0;
215 iovec iov{&zero, sizeof(zero)};
216 std::vector<std::variant<base::unique_fd, base::borrowed_fd>> fds;
217
David Brazdil8a741902022-12-17 21:41:04 +0000218 ssize_t num_bytes = receiveMessageFromSocket(server.mServer, &iov, 1, &fds);
219 if (num_bytes < 0) {
David Brazdil21c887c2022-09-23 12:25:18 +0100220 int savedErrno = errno;
221 ALOGE("Failed recvmsg: %s", strerror(savedErrno));
222 return -savedErrno;
223 }
David Brazdil8a741902022-12-17 21:41:04 +0000224 if (num_bytes == 0) {
225 return DEAD_OBJECT;
226 }
David Brazdil21c887c2022-09-23 12:25:18 +0100227 if (fds.size() != 1) {
228 ALOGE("Expected exactly one fd from recvmsg, got %zu", fds.size());
229 return -EINVAL;
230 }
231
232 unique_fd fd(std::move(std::get<unique_fd>(fds.back())));
233 if (auto res = setNonBlocking(fd); !res.ok()) {
234 ALOGE("Failed setNonBlocking: %s", res.error().message().c_str());
235 return res.error().code() == 0 ? UNKNOWN_ERROR : -res.error().code();
236 }
237
238 *out = RpcTransportFd(std::move(fd));
239 return OK;
240}
241
Steven Moreland611d15f2021-05-01 01:28:27 +0000242void RpcServer::join() {
Yifan Hong1a235852021-05-13 16:07:47 -0700243
244 {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000245 RpcMutexLockGuard _l(mLock);
Pawan49d74cb2022-08-03 21:19:11 +0000246 LOG_ALWAYS_FATAL_IF(!mServer.fd.ok(), "RpcServer must be setup to join.");
David Brazdil21c887c2022-09-23 12:25:18 +0100247 LOG_ALWAYS_FATAL_IF(mAcceptFn == nullptr, "RpcServer must have an accept() function");
Yifan Hong1a235852021-05-13 16:07:47 -0700248 LOG_ALWAYS_FATAL_IF(mShutdownTrigger != nullptr, "Already joined");
249 mJoinThreadRunning = true;
Yifan Hong8c950422021-08-05 17:13:55 -0700250 mShutdownTrigger = FdTrigger::make();
Yifan Hong1a235852021-05-13 16:07:47 -0700251 LOG_ALWAYS_FATAL_IF(mShutdownTrigger == nullptr, "Cannot create join signaler");
Steven Morelandd539fbf2021-05-05 23:40:25 +0000252 }
Yifan Hong1a235852021-05-13 16:07:47 -0700253
Steven Moreland2b4f3802021-05-22 01:46:27 +0000254 status_t status;
Steven Moreland798e0d12021-07-14 23:19:25 +0000255 while ((status = mShutdownTrigger->triggerablePoll(mServer, POLLIN)) == OK) {
Andrei Homescu86124ca2022-04-21 22:22:48 +0000256 std::array<uint8_t, kRpcAddressSize> addr;
257 static_assert(addr.size() >= sizeof(sockaddr_storage), "kRpcAddressSize is too small");
Andrei Homescu86124ca2022-04-21 22:22:48 +0000258 socklen_t addrLen = addr.size();
Steven Moreland51c44a92021-10-14 16:50:35 -0700259
David Brazdil21c887c2022-09-23 12:25:18 +0100260 RpcTransportFd clientSocket;
David Brazdil8a741902022-12-17 21:41:04 +0000261 if ((status = mAcceptFn(*this, &clientSocket)) != OK) {
262 if (status == DEAD_OBJECT)
263 break;
264 else
265 continue;
Steven Moreland410325a2021-06-02 18:37:42 +0000266 }
David Brazdila47dfda2022-11-22 22:52:19 +0000267
268 LOG_RPC_DETAIL("accept on fd %d yields fd %d", mServer.fd.get(), clientSocket.fd.get());
269
David Brazdil21c887c2022-09-23 12:25:18 +0100270 if (getpeername(clientSocket.fd.get(), reinterpret_cast<sockaddr*>(addr.data()),
271 &addrLen)) {
272 ALOGE("Could not getpeername socket: %s", strerror(errno));
273 continue;
274 }
275
David Brazdila47dfda2022-11-22 22:52:19 +0000276 if (mConnectionFilter != nullptr && !mConnectionFilter(addr.data(), addrLen)) {
277 ALOGE("Dropped client connection fd %d", clientSocket.fd.get());
278 continue;
279 }
Steven Moreland410325a2021-06-02 18:37:42 +0000280
281 {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000282 RpcMutexLockGuard _l(mLock);
Andrei Homescu74a54452021-12-10 05:30:21 +0000283 RpcMaybeThread thread =
284 RpcMaybeThread(&RpcServer::establishConnection,
Pawan49d74cb2022-08-03 21:19:11 +0000285 sp<RpcServer>::fromExisting(this), std::move(clientSocket), addr,
Andrei Homescu74a54452021-12-10 05:30:21 +0000286 addrLen, RpcSession::join);
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000287
288 auto& threadRef = mConnectingThreads[thread.get_id()];
289 threadRef = std::move(thread);
290 rpcJoinIfSingleThreaded(threadRef);
Steven Moreland410325a2021-06-02 18:37:42 +0000291 }
Yifan Hong1a235852021-05-13 16:07:47 -0700292 }
Steven Moreland2b4f3802021-05-22 01:46:27 +0000293 LOG_RPC_DETAIL("RpcServer::join exiting with %s", statusToString(status).c_str());
Yifan Hong1a235852021-05-13 16:07:47 -0700294
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000295 if constexpr (kEnableRpcThreads) {
296 RpcMutexLockGuard _l(mLock);
Yifan Hong1a235852021-05-13 16:07:47 -0700297 mJoinThreadRunning = false;
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000298 } else {
299 // Multi-threaded builds clear this in shutdown(), but we need it valid
300 // so the loop above exits cleanly
301 mShutdownTrigger = nullptr;
Yifan Hong1a235852021-05-13 16:07:47 -0700302 }
303 mShutdownCv.notify_all();
Steven Morelandd539fbf2021-05-05 23:40:25 +0000304}
305
Yifan Hong1a235852021-05-13 16:07:47 -0700306bool RpcServer::shutdown() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000307 RpcMutexUniqueLock _l(mLock);
Steven Moreland9d11b922021-05-20 01:22:58 +0000308 if (mShutdownTrigger == nullptr) {
Devin Moore06add172023-03-22 22:49:29 +0000309 LOG_RPC_DETAIL("Cannot shutdown. No shutdown trigger installed (already shutdown, or not "
310 "joined yet?)");
Steven Moreland9d11b922021-05-20 01:22:58 +0000311 return false;
312 }
Yifan Hong1a235852021-05-13 16:07:47 -0700313
314 mShutdownTrigger->trigger();
Steven Morelandab3f4422021-09-27 18:38:20 -0700315
Steven Morelanda8b44292021-06-08 01:27:53 +0000316 for (auto& [id, session] : mSessions) {
317 (void)id;
Steven Morelandab3f4422021-09-27 18:38:20 -0700318 // server lock is a more general lock
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000319 RpcMutexLockGuard _lSession(session->mMutex);
Steven Morelanda8b44292021-06-08 01:27:53 +0000320 session->mShutdownTrigger->trigger();
321 }
322
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000323 if constexpr (!kEnableRpcThreads) {
324 // In single-threaded mode we're done here, everything else that
325 // needs to happen should be at the end of RpcServer::join()
326 return true;
327 }
328
Steven Morelandee3f4662021-05-22 01:07:33 +0000329 while (mJoinThreadRunning || !mConnectingThreads.empty() || !mSessions.empty()) {
Steven Morelandaf4ca712021-05-24 23:22:08 +0000330 if (std::cv_status::timeout == mShutdownCv.wait_for(_l, std::chrono::seconds(1))) {
331 ALOGE("Waiting for RpcServer to shut down (1s w/o progress). Join thread running: %d, "
332 "Connecting threads: "
333 "%zu, Sessions: %zu. Is your server deadlocked?",
334 mJoinThreadRunning, mConnectingThreads.size(), mSessions.size());
335 }
Steven Moreland9d11b922021-05-20 01:22:58 +0000336 }
Yifan Hong1a235852021-05-13 16:07:47 -0700337
Yifan Hong326afd12021-05-19 15:24:54 -0700338 // At this point, we know join() is about to exit, but the thread that calls
339 // join() may not have exited yet.
340 // If RpcServer owns the join thread (aka start() is called), make sure the thread exits;
341 // otherwise ~thread() may call std::terminate(), which may crash the process.
342 // If RpcServer does not own the join thread (aka join() is called directly),
343 // then the owner of RpcServer is responsible for cleaning up that thread.
344 if (mJoinThread.get()) {
345 mJoinThread->join();
346 mJoinThread.reset();
347 }
348
Tomasz Wasilczyk7c8dd482023-03-23 15:30:03 -0700349 mServer = RpcTransportFd();
350
Steven Moreland1c943ec2021-07-13 23:57:56 +0000351 LOG_RPC_DETAIL("Finished waiting on shutdown.");
352
Yifan Hong1a235852021-05-13 16:07:47 -0700353 mShutdownTrigger = nullptr;
354 return true;
355}
356
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000357std::vector<sp<RpcSession>> RpcServer::listSessions() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000358 RpcMutexLockGuard _l(mLock);
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000359 std::vector<sp<RpcSession>> sessions;
360 for (auto& [id, session] : mSessions) {
Steven Moreland736664b2021-05-01 04:27:25 +0000361 (void)id;
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000362 sessions.push_back(session);
Steven Moreland736664b2021-05-01 04:27:25 +0000363 }
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000364 return sessions;
Steven Moreland611d15f2021-05-01 01:28:27 +0000365}
366
Steven Morelandd539fbf2021-05-05 23:40:25 +0000367size_t RpcServer::numUninitializedSessions() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000368 RpcMutexLockGuard _l(mLock);
Steven Morelandd539fbf2021-05-05 23:40:25 +0000369 return mConnectingThreads.size();
370}
371
Andrei Homescu74a54452021-12-10 05:30:21 +0000372void RpcServer::establishConnection(
Pawan3e0061c2022-08-26 21:08:34 +0000373 sp<RpcServer>&& server, RpcTransportFd clientFd, std::array<uint8_t, kRpcAddressSize> addr,
Andrei Homescu74a54452021-12-10 05:30:21 +0000374 size_t addrLen,
375 std::function<void(sp<RpcSession>&&, RpcSession::PreJoinSetupResult&&)>&& joinFn) {
Steven Moreland9d11b922021-05-20 01:22:58 +0000376 // mShutdownTrigger can only be cleared once connection threads have joined.
377 // It must be set before this thread is started
378 LOG_ALWAYS_FATAL_IF(server->mShutdownTrigger == nullptr);
Yifan Hong702115c2021-06-24 15:39:18 -0700379 LOG_ALWAYS_FATAL_IF(server->mCtx == nullptr);
380
381 status_t status = OK;
382
Pawan49d74cb2022-08-03 21:19:11 +0000383 int clientFdForLog = clientFd.fd.get();
Yifan Hongf6d42292021-08-05 23:43:05 -0700384 auto client = server->mCtx->newTransport(std::move(clientFd), server->mShutdownTrigger.get());
Yifan Hong702115c2021-06-24 15:39:18 -0700385 if (client == nullptr) {
386 ALOGE("Dropping accept4()-ed socket because sslAccept fails");
387 status = DEAD_OBJECT;
388 // still need to cleanup before we can return
389 } else {
390 LOG_RPC_DETAIL("Created RpcTransport %p for client fd %d", client.get(), clientFdForLog);
391 }
Steven Moreland9d11b922021-05-20 01:22:58 +0000392
Steven Moreland659416d2021-05-11 00:47:50 +0000393 RpcConnectionHeader header;
Yifan Hong702115c2021-06-24 15:39:18 -0700394 if (status == OK) {
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000395 iovec iov{&header, sizeof(header)};
Devin Moore695368f2022-06-03 22:29:14 +0000396 status = client->interruptableReadFully(server->mShutdownTrigger.get(), &iov, 1,
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000397 std::nullopt, /*ancillaryFds=*/nullptr);
Yifan Hong702115c2021-06-24 15:39:18 -0700398 if (status != OK) {
399 ALOGE("Failed to read ID for client connecting to RPC server: %s",
400 statusToString(status).c_str());
401 // still need to cleanup before we can return
402 }
Steven Morelanda63ff932021-05-12 00:03:15 +0000403 }
Steven Morelandbf57bce2021-07-26 15:26:12 -0700404
Steven Moreland826367f2021-09-10 14:05:31 -0700405 std::vector<uint8_t> sessionId;
406 if (status == OK) {
407 if (header.sessionIdSize > 0) {
Steven Morelandc5032042021-09-30 15:40:27 -0700408 if (header.sessionIdSize == kSessionIdBytes) {
409 sessionId.resize(header.sessionIdSize);
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000410 iovec iov{sessionId.data(), sessionId.size()};
Devin Moore695368f2022-06-03 22:29:14 +0000411 status = client->interruptableReadFully(server->mShutdownTrigger.get(), &iov, 1,
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000412 std::nullopt, /*ancillaryFds=*/nullptr);
Steven Morelandc5032042021-09-30 15:40:27 -0700413 if (status != OK) {
414 ALOGE("Failed to read session ID for client connecting to RPC server: %s",
415 statusToString(status).c_str());
416 // still need to cleanup before we can return
417 }
418 } else {
419 ALOGE("Malformed session ID. Expecting session ID of size %zu but got %" PRIu16,
420 kSessionIdBytes, header.sessionIdSize);
421 status = BAD_VALUE;
Steven Moreland826367f2021-09-10 14:05:31 -0700422 }
423 }
424 }
425
Steven Morelandbf57bce2021-07-26 15:26:12 -0700426 bool incoming = false;
427 uint32_t protocolVersion = 0;
Steven Morelandbf57bce2021-07-26 15:26:12 -0700428 bool requestingNewSession = false;
429
430 if (status == OK) {
431 incoming = header.options & RPC_CONNECTION_OPTION_INCOMING;
432 protocolVersion = std::min(header.version,
433 server->mProtocolVersion.value_or(RPC_WIRE_PROTOCOL_VERSION));
Steven Moreland826367f2021-09-10 14:05:31 -0700434 requestingNewSession = sessionId.empty();
Steven Morelandbf57bce2021-07-26 15:26:12 -0700435
436 if (requestingNewSession) {
437 RpcNewSessionResponse response{
438 .version = protocolVersion,
439 };
440
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000441 iovec iov{&response, sizeof(response)};
Devin Moore695368f2022-06-03 22:29:14 +0000442 status = client->interruptableWriteFully(server->mShutdownTrigger.get(), &iov, 1,
Frederick Mayle69a0c992022-05-26 20:38:39 +0000443 std::nullopt, nullptr);
Steven Morelandbf57bce2021-07-26 15:26:12 -0700444 if (status != OK) {
445 ALOGE("Failed to send new session response: %s", statusToString(status).c_str());
446 // still need to cleanup before we can return
447 }
448 }
449 }
Steven Morelanda63ff932021-05-12 00:03:15 +0000450
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000451 RpcMaybeThread thisThread;
Steven Morelanda63ff932021-05-12 00:03:15 +0000452 sp<RpcSession> session;
453 {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000454 RpcMutexUniqueLock _l(server->mLock);
Steven Morelanda63ff932021-05-12 00:03:15 +0000455
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000456 auto threadId = server->mConnectingThreads.find(rpc_this_thread::get_id());
Yifan Hongb3005502021-05-19 15:37:00 -0700457 LOG_ALWAYS_FATAL_IF(threadId == server->mConnectingThreads.end(),
Steven Morelanda63ff932021-05-12 00:03:15 +0000458 "Must establish connection on owned thread");
459 thisThread = std::move(threadId->second);
Steven Morelandadc5dca2021-05-25 02:06:03 +0000460 ScopeGuard detachGuard = [&]() {
461 thisThread.detach();
Steven Moreland9d11b922021-05-20 01:22:58 +0000462 _l.unlock();
463 server->mShutdownCv.notify_all();
464 };
Steven Morelandadc5dca2021-05-25 02:06:03 +0000465 server->mConnectingThreads.erase(threadId);
Steven Moreland9d11b922021-05-20 01:22:58 +0000466
Steven Morelandbf57bce2021-07-26 15:26:12 -0700467 if (status != OK || server->mShutdownTrigger->isTriggered()) {
Steven Moreland5802c2b2021-05-12 20:13:04 +0000468 return;
469 }
470
Steven Morelandbf57bce2021-07-26 15:26:12 -0700471 if (requestingNewSession) {
Steven Moreland1b304292021-07-15 22:59:34 +0000472 if (incoming) {
473 ALOGE("Cannot create a new session with an incoming connection, would leak");
Steven Moreland659416d2021-05-11 00:47:50 +0000474 return;
475 }
476
Steven Moreland826367f2021-09-10 14:05:31 -0700477 // Uniquely identify session at the application layer. Even if a
478 // client/server use the same certificates, if they create multiple
479 // sessions, we still want to distinguish between them.
Steven Morelandc5032042021-09-30 15:40:27 -0700480 sessionId.resize(kSessionIdBytes);
Steven Moreland01a6bad2021-06-11 00:59:20 +0000481 size_t tries = 0;
482 do {
483 // don't block if there is some entropy issue
484 if (tries++ > 5) {
Steven Moreland826367f2021-09-10 14:05:31 -0700485 ALOGE("Cannot find new address: %s",
Tomasz Wasilczyk891f6b02023-10-11 18:35:42 +0000486 HexString(sessionId.data(), sessionId.size()).c_str());
Steven Moreland01a6bad2021-06-11 00:59:20 +0000487 return;
488 }
489
Andrei Homescuc24c8792022-04-19 00:24:51 +0000490 auto status = getRandomBytes(sessionId.data(), sessionId.size());
491 if (status != OK) {
492 ALOGE("Failed to read random session ID: %s", strerror(-status));
Steven Moreland826367f2021-09-10 14:05:31 -0700493 return;
494 }
Steven Moreland01a6bad2021-06-11 00:59:20 +0000495 } while (server->mSessions.end() != server->mSessions.find(sessionId));
Steven Morelanda63ff932021-05-12 00:03:15 +0000496
Andrei Homescu5e301462022-05-12 00:52:34 +0000497 session = sp<RpcSession>::make(nullptr);
Yifan Hong10423062021-10-08 16:26:32 -0700498 session->setMaxIncomingThreads(server->mMaxThreads);
Steven Morelandbf57bce2021-07-26 15:26:12 -0700499 if (!session->setProtocolVersion(protocolVersion)) return;
Steven Moreland51c44a92021-10-14 16:50:35 -0700500
Frederick Mayle26b494e2022-07-08 22:09:58 +0000501 if (header.fileDescriptorTransportMode <
502 server->mSupportedFileDescriptorTransportModes.size() &&
503 server->mSupportedFileDescriptorTransportModes.test(
Frederick Mayle69a0c992022-05-26 20:38:39 +0000504 header.fileDescriptorTransportMode)) {
505 session->setFileDescriptorTransportMode(
506 static_cast<RpcSession::FileDescriptorTransportMode>(
507 header.fileDescriptorTransportMode));
508 } else {
509 ALOGE("Rejecting connection: FileDescriptorTransportMode is not supported: %hhu",
510 header.fileDescriptorTransportMode);
511 return;
512 }
513
Steven Moreland51c44a92021-10-14 16:50:35 -0700514 // if null, falls back to server root
515 sp<IBinder> sessionSpecificRoot;
516 if (server->mRootObjectFactory != nullptr) {
Steven Morelanddfb92182023-05-24 17:48:59 +0000517 sessionSpecificRoot =
518 server->mRootObjectFactory(wp<RpcSession>(session), addr.data(), addrLen);
Steven Moreland51c44a92021-10-14 16:50:35 -0700519 if (sessionSpecificRoot == nullptr) {
520 ALOGE("Warning: server returned null from root object factory");
521 }
522 }
523
Steven Morelanda8b44292021-06-08 01:27:53 +0000524 if (!session->setForServer(server,
525 sp<RpcServer::EventListener>::fromExisting(
526 static_cast<RpcServer::EventListener*>(
527 server.get())),
Steven Moreland51c44a92021-10-14 16:50:35 -0700528 sessionId, sessionSpecificRoot)) {
Steven Morelanda8b44292021-06-08 01:27:53 +0000529 ALOGE("Failed to attach server to session");
530 return;
531 }
Steven Morelanda63ff932021-05-12 00:03:15 +0000532
Steven Moreland01a6bad2021-06-11 00:59:20 +0000533 server->mSessions[sessionId] = session;
Steven Morelanda63ff932021-05-12 00:03:15 +0000534 } else {
Steven Moreland01a6bad2021-06-11 00:59:20 +0000535 auto it = server->mSessions.find(sessionId);
Yifan Hongb3005502021-05-19 15:37:00 -0700536 if (it == server->mSessions.end()) {
Steven Moreland01a6bad2021-06-11 00:59:20 +0000537 ALOGE("Cannot add thread, no record of session with ID %s",
Tomasz Wasilczyk891f6b02023-10-11 18:35:42 +0000538 HexString(sessionId.data(), sessionId.size()).c_str());
Steven Morelanda63ff932021-05-12 00:03:15 +0000539 return;
540 }
541 session = it->second;
542 }
Steven Moreland5802c2b2021-05-12 20:13:04 +0000543
Steven Moreland1b304292021-07-15 22:59:34 +0000544 if (incoming) {
Steven Moreland2372f9d2021-08-05 15:42:01 -0700545 LOG_ALWAYS_FATAL_IF(OK != session->addOutgoingConnection(std::move(client), true),
Steven Moreland659416d2021-05-11 00:47:50 +0000546 "server state must already be initialized");
547 return;
548 }
549
Steven Moreland5802c2b2021-05-12 20:13:04 +0000550 detachGuard.Disable();
Steven Morelandc88b7fc2021-06-10 00:40:39 +0000551 session->preJoinThreadOwnership(std::move(thisThread));
Steven Morelanda63ff932021-05-12 00:03:15 +0000552 }
553
Yifan Hong702115c2021-06-24 15:39:18 -0700554 auto setupResult = session->preJoinSetup(std::move(client));
Steven Morelandc88b7fc2021-06-10 00:40:39 +0000555
Steven Morelanda63ff932021-05-12 00:03:15 +0000556 // avoid strong cycle
557 server = nullptr;
Steven Morelanda63ff932021-05-12 00:03:15 +0000558
Andrei Homescu74a54452021-12-10 05:30:21 +0000559 joinFn(std::move(session), std::move(setupResult));
Steven Morelanda63ff932021-05-12 00:03:15 +0000560}
561
Steven Moreland2372f9d2021-08-05 15:42:01 -0700562status_t RpcServer::setupSocketServer(const RpcSocketAddress& addr) {
Steven Moreland704fc1a2021-05-04 23:13:14 +0000563 LOG_RPC_DETAIL("Setting up socket server %s", addr.toString().c_str());
Yifan Hong0eb5a672021-05-12 18:00:25 -0700564 LOG_ALWAYS_FATAL_IF(hasServer(), "Each RpcServer can only have one server.");
Steven Moreland611d15f2021-05-01 01:28:27 +0000565
Alice Wang0b138ed2022-11-15 16:22:44 +0000566 unique_fd socket_fd(TEMP_FAILURE_RETRY(
567 socket(addr.addr()->sa_family, SOCK_STREAM | SOCK_CLOEXEC | SOCK_NONBLOCK, 0)));
568 if (!socket_fd.ok()) {
Steven Moreland2372f9d2021-08-05 15:42:01 -0700569 int savedErrno = errno;
Steven Moreland8925ebb2023-04-10 21:52:17 +0000570 ALOGE("Could not create socket at %s: %s", addr.toString().c_str(), strerror(savedErrno));
Steven Moreland2372f9d2021-08-05 15:42:01 -0700571 return -savedErrno;
Steven Moreland611d15f2021-05-01 01:28:27 +0000572 }
Tomasz Wasilczyk7c8dd482023-03-23 15:30:03 -0700573
574 {
575 RpcMutexLockGuard _l(mLock);
576 if (mServerSocketModifier != nullptr) {
577 mServerSocketModifier(socket_fd);
578 }
579 }
580
Alice Wang0b138ed2022-11-15 16:22:44 +0000581 if (0 != TEMP_FAILURE_RETRY(bind(socket_fd.get(), addr.addr(), addr.addrSize()))) {
Steven Moreland611d15f2021-05-01 01:28:27 +0000582 int savedErrno = errno;
583 ALOGE("Could not bind socket at %s: %s", addr.toString().c_str(), strerror(savedErrno));
Steven Moreland2372f9d2021-08-05 15:42:01 -0700584 return -savedErrno;
Steven Moreland611d15f2021-05-01 01:28:27 +0000585 }
586
Alice Wang0b138ed2022-11-15 16:22:44 +0000587 return setupRawSocketServer(std::move(socket_fd));
Steven Moreland611d15f2021-05-01 01:28:27 +0000588}
589
Alice Wang0b138ed2022-11-15 16:22:44 +0000590status_t RpcServer::setupRawSocketServer(unique_fd socket_fd) {
Alice Wang30c204d2022-11-15 12:50:51 +0000591 LOG_ALWAYS_FATAL_IF(!socket_fd.ok(), "Socket must be setup to listen.");
Alice Wang30c204d2022-11-15 12:50:51 +0000592
Alice Wang893a9912022-10-24 10:44:09 +0000593 // Right now, we create all threads at once, making accept4 slow. To avoid hanging the client,
594 // the backlog is increased to a large number.
595 // TODO(b/189955605): Once we create threads dynamically & lazily, the backlog can be reduced
596 // to 1.
Alice Wangdf741782022-11-16 08:37:04 +0000597 if (0 != TEMP_FAILURE_RETRY(listen(socket_fd.get(), 50 /*backlog*/))) {
Alice Wang893a9912022-10-24 10:44:09 +0000598 int savedErrno = errno;
599 ALOGE("Could not listen initialized Unix socket: %s", strerror(savedErrno));
600 return -savedErrno;
601 }
Alice Wangdf741782022-11-16 08:37:04 +0000602 if (status_t status = setupExternalServer(std::move(socket_fd)); status != OK) {
Alice Wang893a9912022-10-24 10:44:09 +0000603 ALOGE("Another thread has set up server while calling setupSocketServer. Race?");
604 return status;
605 }
606 return OK;
607}
608
Steven Morelanddd67b942021-07-23 17:15:41 -0700609void RpcServer::onSessionAllIncomingThreadsEnded(const sp<RpcSession>& session) {
Steven Moreland826367f2021-09-10 14:05:31 -0700610 const std::vector<uint8_t>& id = session->mId;
611 LOG_ALWAYS_FATAL_IF(id.empty(), "Server sessions must be initialized with ID");
Tomasz Wasilczyk891f6b02023-10-11 18:35:42 +0000612 LOG_RPC_DETAIL("Dropping session with address %s", HexString(id.data(), id.size()).c_str());
Steven Morelandee78e762021-05-05 21:12:51 +0000613
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000614 RpcMutexLockGuard _l(mLock);
Steven Moreland826367f2021-09-10 14:05:31 -0700615 auto it = mSessions.find(id);
Steven Moreland01a6bad2021-06-11 00:59:20 +0000616 LOG_ALWAYS_FATAL_IF(it == mSessions.end(), "Bad state, unknown session id %s",
Tomasz Wasilczyk891f6b02023-10-11 18:35:42 +0000617 HexString(id.data(), id.size()).c_str());
Steven Moreland01a6bad2021-06-11 00:59:20 +0000618 LOG_ALWAYS_FATAL_IF(it->second != session, "Bad state, session has id mismatch %s",
Tomasz Wasilczyk891f6b02023-10-11 18:35:42 +0000619 HexString(id.data(), id.size()).c_str());
Steven Morelandee78e762021-05-05 21:12:51 +0000620 (void)mSessions.erase(it);
621}
622
Steven Moreland19fc9f72021-06-10 03:57:30 +0000623void RpcServer::onSessionIncomingThreadEnded() {
Steven Morelandee3f4662021-05-22 01:07:33 +0000624 mShutdownCv.notify_all();
625}
626
Yifan Hong0eb5a672021-05-12 18:00:25 -0700627bool RpcServer::hasServer() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000628 RpcMutexLockGuard _l(mLock);
Pawan49d74cb2022-08-03 21:19:11 +0000629 return mServer.fd.ok();
Yifan Hong0eb5a672021-05-12 18:00:25 -0700630}
631
Yifan Hong00aeb762021-05-12 17:07:36 -0700632unique_fd RpcServer::releaseServer() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000633 RpcMutexLockGuard _l(mLock);
Pawan49d74cb2022-08-03 21:19:11 +0000634 return std::move(mServer.fd);
Yifan Hong00aeb762021-05-12 17:07:36 -0700635}
636
David Brazdil21c887c2022-09-23 12:25:18 +0100637status_t RpcServer::setupExternalServer(
638 base::unique_fd serverFd,
639 std::function<status_t(const RpcServer&, RpcTransportFd*)>&& acceptFn) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000640 RpcMutexLockGuard _l(mLock);
Pawan49d74cb2022-08-03 21:19:11 +0000641 if (mServer.fd.ok()) {
Yifan Hong00aeb762021-05-12 17:07:36 -0700642 ALOGE("Each RpcServer can only have one server.");
Steven Moreland2372f9d2021-08-05 15:42:01 -0700643 return INVALID_OPERATION;
Yifan Hong00aeb762021-05-12 17:07:36 -0700644 }
645 mServer = std::move(serverFd);
David Brazdil21c887c2022-09-23 12:25:18 +0100646 mAcceptFn = std::move(acceptFn);
Steven Moreland2372f9d2021-08-05 15:42:01 -0700647 return OK;
Yifan Hong00aeb762021-05-12 17:07:36 -0700648}
649
David Brazdil21c887c2022-09-23 12:25:18 +0100650status_t RpcServer::setupExternalServer(base::unique_fd serverFd) {
651 return setupExternalServer(std::move(serverFd), &RpcServer::acceptSocketConnection);
652}
653
Pawan1c24f9c2022-08-26 23:23:15 +0000654bool RpcServer::hasActiveRequests() {
655 RpcMutexLockGuard _l(mLock);
656 for (const auto& [_, session] : mSessions) {
657 if (session->hasActiveRequests()) {
658 return true;
659 }
660 }
661 return !mServer.isInPollingState();
662}
663
Steven Moreland5553ac42020-11-11 02:14:45 +0000664} // namespace android