blob: 03dad2bacaf34464a649a221b97ef1ca0ae82155 [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>
Keith Mok442907b2023-10-11 20:36:18 +000020#include <netinet/tcp.h>
Steven Moreland798e0d12021-07-14 23:19:25 +000021#include <poll.h>
Steven Moreland5553ac42020-11-11 02:14:45 +000022#include <sys/socket.h>
23#include <sys/un.h>
24
Steven Morelandf137de92021-04-24 01:54:26 +000025#include <thread>
Steven Moreland5553ac42020-11-11 02:14:45 +000026#include <vector>
27
Steven Moreland826367f2021-09-10 14:05:31 -070028#include <android-base/hex.h>
Steven Moreland5802c2b2021-05-12 20:13:04 +000029#include <android-base/scopeguard.h>
Steven Moreland5553ac42020-11-11 02:14:45 +000030#include <binder/Parcel.h>
31#include <binder/RpcServer.h>
Yifan Hong702115c2021-06-24 15:39:18 -070032#include <binder/RpcTransportRaw.h>
Steven Moreland5553ac42020-11-11 02:14:45 +000033#include <log/log.h>
Andrei Homescu1d935e82022-04-25 04:58:23 +000034#include <utils/Compat.h>
Steven Moreland5553ac42020-11-11 02:14:45 +000035
Andrei Homescuffa3aaa2022-04-07 05:06:33 +000036#include "BuildFlags.h"
Yifan Hong8c950422021-08-05 17:13:55 -070037#include "FdTrigger.h"
Andrei Homescu7c0b79f2022-06-30 02:00:46 +000038#include "OS.h"
Steven Moreland611d15f2021-05-01 01:28:27 +000039#include "RpcSocketAddress.h"
Yifan Hong1a235852021-05-13 16:07:47 -070040#include "RpcState.h"
David Brazdil21c887c2022-09-23 12:25:18 +010041#include "RpcTransportUtils.h"
Steven Moreland5553ac42020-11-11 02:14:45 +000042#include "RpcWireFormat.h"
Andrei Homescuc24c8792022-04-19 00:24:51 +000043#include "Utils.h"
Steven Moreland5553ac42020-11-11 02:14:45 +000044
45namespace android {
46
Steven Morelandc5032042021-09-30 15:40:27 -070047constexpr size_t kSessionIdBytes = 32;
48
Steven Moreland5802c2b2021-05-12 20:13:04 +000049using base::ScopeGuard;
Steven Moreland611d15f2021-05-01 01:28:27 +000050using base::unique_fd;
51
Yifan Hongecf937d2021-08-11 17:29:28 -070052RpcServer::RpcServer(std::unique_ptr<RpcTransportCtx> ctx) : mCtx(std::move(ctx)) {}
Yifan Hong436f0e62021-05-19 15:25:34 -070053RpcServer::~RpcServer() {
David Brazdil4766a1f2022-12-19 21:58:25 +000054 RpcMutexUniqueLock _l(mLock);
55 LOG_ALWAYS_FATAL_IF(mShutdownTrigger != nullptr, "Must call shutdown() before destructor");
Yifan Hong436f0e62021-05-19 15:25:34 -070056}
Steven Moreland5553ac42020-11-11 02:14:45 +000057
Yifan Hong702115c2021-06-24 15:39:18 -070058sp<RpcServer> RpcServer::make(std::unique_ptr<RpcTransportCtxFactory> rpcTransportCtxFactory) {
59 // Default is without TLS.
60 if (rpcTransportCtxFactory == nullptr)
Andrei Homescu024727b2022-08-24 23:54:59 +000061 rpcTransportCtxFactory = makeDefaultRpcTransportCtxFactory();
Yifan Hongecf937d2021-08-11 17:29:28 -070062 auto ctx = rpcTransportCtxFactory->newServerCtx();
63 if (ctx == nullptr) return nullptr;
64 return sp<RpcServer>::make(std::move(ctx));
Steven Moreland5553ac42020-11-11 02:14:45 +000065}
66
David Brazdil21c887c2022-09-23 12:25:18 +010067status_t RpcServer::setupUnixDomainSocketBootstrapServer(unique_fd bootstrapFd) {
68 return setupExternalServer(std::move(bootstrapFd), &RpcServer::recvmsgSocketConnection);
69}
70
Steven Moreland2372f9d2021-08-05 15:42:01 -070071status_t RpcServer::setupUnixDomainServer(const char* path) {
Steven Moreland611d15f2021-05-01 01:28:27 +000072 return setupSocketServer(UnixSocketAddress(path));
73}
74
David Brazdila47dfda2022-11-22 22:52:19 +000075status_t RpcServer::setupVsockServer(unsigned int bindCid, unsigned int port) {
76 return setupSocketServer(VsockSocketAddress(bindCid, port));
Steven Moreland611d15f2021-05-01 01:28:27 +000077}
78
Steven Moreland2372f9d2021-08-05 15:42:01 -070079status_t RpcServer::setupInetServer(const char* address, unsigned int port,
80 unsigned int* assignedPort) {
Steven Moreland611d15f2021-05-01 01:28:27 +000081 if (assignedPort != nullptr) *assignedPort = 0;
Devin Mooref3b9c4f2021-08-03 15:50:13 +000082 auto aiStart = InetSocketAddress::getAddrInfo(address, port);
Steven Moreland2372f9d2021-08-05 15:42:01 -070083 if (aiStart == nullptr) return UNKNOWN_ERROR;
Steven Moreland611d15f2021-05-01 01:28:27 +000084 for (auto ai = aiStart.get(); ai != nullptr; ai = ai->ai_next) {
zijunzhaoa2013362023-05-11 21:27:19 +000085 if (ai->ai_addr == nullptr) continue;
Devin Mooref3b9c4f2021-08-03 15:50:13 +000086 InetSocketAddress socketAddress(ai->ai_addr, ai->ai_addrlen, address, port);
Steven Moreland2372f9d2021-08-05 15:42:01 -070087 if (status_t status = setupSocketServer(socketAddress); status != OK) {
Steven Moreland611d15f2021-05-01 01:28:27 +000088 continue;
89 }
90
91 LOG_ALWAYS_FATAL_IF(socketAddress.addr()->sa_family != AF_INET, "expecting inet");
92 sockaddr_in addr{};
93 socklen_t len = sizeof(addr);
Pawan49d74cb2022-08-03 21:19:11 +000094 if (0 != getsockname(mServer.fd.get(), reinterpret_cast<sockaddr*>(&addr), &len)) {
Steven Moreland611d15f2021-05-01 01:28:27 +000095 int savedErrno = errno;
96 ALOGE("Could not getsockname at %s: %s", socketAddress.toString().c_str(),
97 strerror(savedErrno));
Steven Moreland2372f9d2021-08-05 15:42:01 -070098 return -savedErrno;
Steven Moreland611d15f2021-05-01 01:28:27 +000099 }
100 LOG_ALWAYS_FATAL_IF(len != sizeof(addr), "Wrong socket type: len %zu vs len %zu",
101 static_cast<size_t>(len), sizeof(addr));
102 unsigned int realPort = ntohs(addr.sin_port);
103 LOG_ALWAYS_FATAL_IF(port != 0 && realPort != port,
104 "Requesting inet server on %s but it is set up on %u.",
105 socketAddress.toString().c_str(), realPort);
106
107 if (assignedPort != nullptr) {
108 *assignedPort = realPort;
109 }
110
Steven Moreland2372f9d2021-08-05 15:42:01 -0700111 return OK;
Steven Moreland611d15f2021-05-01 01:28:27 +0000112 }
Devin Mooref3b9c4f2021-08-03 15:50:13 +0000113 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 +0000114 port);
Steven Moreland2372f9d2021-08-05 15:42:01 -0700115 return UNKNOWN_ERROR;
Steven Moreland611d15f2021-05-01 01:28:27 +0000116}
117
Steven Morelandf137de92021-04-24 01:54:26 +0000118void RpcServer::setMaxThreads(size_t threads) {
119 LOG_ALWAYS_FATAL_IF(threads <= 0, "RpcServer is useless without threads");
Yifan Hong1a235852021-05-13 16:07:47 -0700120 LOG_ALWAYS_FATAL_IF(mJoinThreadRunning, "Cannot set max threads while running");
Steven Morelandf137de92021-04-24 01:54:26 +0000121 mMaxThreads = threads;
122}
123
124size_t RpcServer::getMaxThreads() {
125 return mMaxThreads;
Steven Moreland5553ac42020-11-11 02:14:45 +0000126}
127
Steven Morelandca3f6382023-05-11 23:23:26 +0000128bool RpcServer::setProtocolVersion(uint32_t version) {
129 if (!RpcState::validateProtocolVersion(version)) {
130 return false;
131 }
132
Steven Morelandbf57bce2021-07-26 15:26:12 -0700133 mProtocolVersion = version;
Steven Morelandca3f6382023-05-11 23:23:26 +0000134 return true;
Steven Morelandbf57bce2021-07-26 15:26:12 -0700135}
136
Frederick Mayle69a0c992022-05-26 20:38:39 +0000137void RpcServer::setSupportedFileDescriptorTransportModes(
138 const std::vector<RpcSession::FileDescriptorTransportMode>& modes) {
139 mSupportedFileDescriptorTransportModes.reset();
140 for (RpcSession::FileDescriptorTransportMode mode : modes) {
141 mSupportedFileDescriptorTransportModes.set(static_cast<size_t>(mode));
142 }
143}
144
Steven Moreland5553ac42020-11-11 02:14:45 +0000145void RpcServer::setRootObject(const sp<IBinder>& binder) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000146 RpcMutexLockGuard _l(mLock);
Steven Moreland51c44a92021-10-14 16:50:35 -0700147 mRootObjectFactory = nullptr;
Yifan Hong4ffb0c72021-05-07 18:35:14 -0700148 mRootObjectWeak = mRootObject = binder;
149}
150
151void RpcServer::setRootObjectWeak(const wp<IBinder>& binder) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000152 RpcMutexLockGuard _l(mLock);
Yifan Hong4ffb0c72021-05-07 18:35:14 -0700153 mRootObject.clear();
Steven Moreland51c44a92021-10-14 16:50:35 -0700154 mRootObjectFactory = nullptr;
Yifan Hong4ffb0c72021-05-07 18:35:14 -0700155 mRootObjectWeak = binder;
Steven Moreland5553ac42020-11-11 02:14:45 +0000156}
Steven Moreland51c44a92021-10-14 16:50:35 -0700157void RpcServer::setPerSessionRootObject(
Steven Morelanddfb92182023-05-24 17:48:59 +0000158 std::function<sp<IBinder>(wp<RpcSession> session, const void*, size_t)>&& makeObject) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000159 RpcMutexLockGuard _l(mLock);
Steven Moreland51c44a92021-10-14 16:50:35 -0700160 mRootObject.clear();
161 mRootObjectWeak.clear();
162 mRootObjectFactory = std::move(makeObject);
163}
Steven Moreland5553ac42020-11-11 02:14:45 +0000164
David Brazdila47dfda2022-11-22 22:52:19 +0000165void RpcServer::setConnectionFilter(std::function<bool(const void*, size_t)>&& filter) {
166 RpcMutexLockGuard _l(mLock);
167 LOG_ALWAYS_FATAL_IF(mShutdownTrigger != nullptr, "Already joined");
168 mConnectionFilter = std::move(filter);
169}
170
Tomasz Wasilczyk7c8dd482023-03-23 15:30:03 -0700171void RpcServer::setServerSocketModifier(std::function<void(base::borrowed_fd)>&& modifier) {
172 RpcMutexLockGuard _l(mLock);
173 LOG_ALWAYS_FATAL_IF(mServer.fd != -1, "Already started");
174 mServerSocketModifier = std::move(modifier);
175}
176
Steven Moreland5553ac42020-11-11 02:14:45 +0000177sp<IBinder> RpcServer::getRootObject() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000178 RpcMutexLockGuard _l(mLock);
Yifan Hong4ffb0c72021-05-07 18:35:14 -0700179 bool hasWeak = mRootObjectWeak.unsafe_get();
180 sp<IBinder> ret = mRootObjectWeak.promote();
181 ALOGW_IF(hasWeak && ret == nullptr, "RpcServer root object is freed, returning nullptr");
182 return ret;
Steven Moreland5553ac42020-11-11 02:14:45 +0000183}
184
Yifan Hong9734cfc2021-09-13 16:14:09 -0700185std::vector<uint8_t> RpcServer::getCertificate(RpcCertificateFormat format) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000186 RpcMutexLockGuard _l(mLock);
Yifan Hongecf937d2021-08-11 17:29:28 -0700187 return mCtx->getCertificate(format);
188}
189
Yifan Hong326afd12021-05-19 15:24:54 -0700190static void joinRpcServer(sp<RpcServer>&& thiz) {
191 thiz->join();
192}
193
194void RpcServer::start() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000195 RpcMutexLockGuard _l(mLock);
Yifan Hong326afd12021-05-19 15:24:54 -0700196 LOG_ALWAYS_FATAL_IF(mJoinThread.get(), "Already started!");
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000197 mJoinThread =
198 std::make_unique<RpcMaybeThread>(&joinRpcServer, sp<RpcServer>::fromExisting(this));
199 rpcJoinIfSingleThreaded(*mJoinThread);
Yifan Hong326afd12021-05-19 15:24:54 -0700200}
201
David Brazdil21c887c2022-09-23 12:25:18 +0100202status_t RpcServer::acceptSocketConnection(const RpcServer& server, RpcTransportFd* out) {
203 RpcTransportFd clientSocket(unique_fd(TEMP_FAILURE_RETRY(
204 accept4(server.mServer.fd.get(), nullptr, nullptr, SOCK_CLOEXEC | SOCK_NONBLOCK))));
205 if (clientSocket.fd < 0) {
206 int savedErrno = errno;
207 ALOGE("Could not accept4 socket: %s", strerror(savedErrno));
208 return -savedErrno;
209 }
210
211 *out = std::move(clientSocket);
212 return OK;
213}
214
215status_t RpcServer::recvmsgSocketConnection(const RpcServer& server, RpcTransportFd* out) {
216 int zero = 0;
217 iovec iov{&zero, sizeof(zero)};
218 std::vector<std::variant<base::unique_fd, base::borrowed_fd>> fds;
219
David Brazdil8a741902022-12-17 21:41:04 +0000220 ssize_t num_bytes = receiveMessageFromSocket(server.mServer, &iov, 1, &fds);
221 if (num_bytes < 0) {
David Brazdil21c887c2022-09-23 12:25:18 +0100222 int savedErrno = errno;
223 ALOGE("Failed recvmsg: %s", strerror(savedErrno));
224 return -savedErrno;
225 }
David Brazdil8a741902022-12-17 21:41:04 +0000226 if (num_bytes == 0) {
227 return DEAD_OBJECT;
228 }
David Brazdil21c887c2022-09-23 12:25:18 +0100229 if (fds.size() != 1) {
230 ALOGE("Expected exactly one fd from recvmsg, got %zu", fds.size());
231 return -EINVAL;
232 }
233
234 unique_fd fd(std::move(std::get<unique_fd>(fds.back())));
235 if (auto res = setNonBlocking(fd); !res.ok()) {
236 ALOGE("Failed setNonBlocking: %s", res.error().message().c_str());
237 return res.error().code() == 0 ? UNKNOWN_ERROR : -res.error().code();
238 }
239
240 *out = RpcTransportFd(std::move(fd));
241 return OK;
242}
243
Steven Moreland611d15f2021-05-01 01:28:27 +0000244void RpcServer::join() {
Yifan Hong1a235852021-05-13 16:07:47 -0700245
246 {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000247 RpcMutexLockGuard _l(mLock);
Pawan49d74cb2022-08-03 21:19:11 +0000248 LOG_ALWAYS_FATAL_IF(!mServer.fd.ok(), "RpcServer must be setup to join.");
David Brazdil21c887c2022-09-23 12:25:18 +0100249 LOG_ALWAYS_FATAL_IF(mAcceptFn == nullptr, "RpcServer must have an accept() function");
Yifan Hong1a235852021-05-13 16:07:47 -0700250 LOG_ALWAYS_FATAL_IF(mShutdownTrigger != nullptr, "Already joined");
251 mJoinThreadRunning = true;
Yifan Hong8c950422021-08-05 17:13:55 -0700252 mShutdownTrigger = FdTrigger::make();
Yifan Hong1a235852021-05-13 16:07:47 -0700253 LOG_ALWAYS_FATAL_IF(mShutdownTrigger == nullptr, "Cannot create join signaler");
Steven Morelandd539fbf2021-05-05 23:40:25 +0000254 }
Yifan Hong1a235852021-05-13 16:07:47 -0700255
Steven Moreland2b4f3802021-05-22 01:46:27 +0000256 status_t status;
Steven Moreland798e0d12021-07-14 23:19:25 +0000257 while ((status = mShutdownTrigger->triggerablePoll(mServer, POLLIN)) == OK) {
Andrei Homescu86124ca2022-04-21 22:22:48 +0000258 std::array<uint8_t, kRpcAddressSize> addr;
259 static_assert(addr.size() >= sizeof(sockaddr_storage), "kRpcAddressSize is too small");
Andrei Homescu86124ca2022-04-21 22:22:48 +0000260 socklen_t addrLen = addr.size();
Steven Moreland51c44a92021-10-14 16:50:35 -0700261
David Brazdil21c887c2022-09-23 12:25:18 +0100262 RpcTransportFd clientSocket;
David Brazdil8a741902022-12-17 21:41:04 +0000263 if ((status = mAcceptFn(*this, &clientSocket)) != OK) {
264 if (status == DEAD_OBJECT)
265 break;
266 else
267 continue;
Steven Moreland410325a2021-06-02 18:37:42 +0000268 }
David Brazdila47dfda2022-11-22 22:52:19 +0000269
270 LOG_RPC_DETAIL("accept on fd %d yields fd %d", mServer.fd.get(), clientSocket.fd.get());
271
David Brazdil21c887c2022-09-23 12:25:18 +0100272 if (getpeername(clientSocket.fd.get(), reinterpret_cast<sockaddr*>(addr.data()),
273 &addrLen)) {
274 ALOGE("Could not getpeername socket: %s", strerror(errno));
275 continue;
276 }
277
David Brazdila47dfda2022-11-22 22:52:19 +0000278 if (mConnectionFilter != nullptr && !mConnectionFilter(addr.data(), addrLen)) {
279 ALOGE("Dropped client connection fd %d", clientSocket.fd.get());
280 continue;
281 }
Steven Moreland410325a2021-06-02 18:37:42 +0000282
283 {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000284 RpcMutexLockGuard _l(mLock);
Andrei Homescu74a54452021-12-10 05:30:21 +0000285 RpcMaybeThread thread =
286 RpcMaybeThread(&RpcServer::establishConnection,
Pawan49d74cb2022-08-03 21:19:11 +0000287 sp<RpcServer>::fromExisting(this), std::move(clientSocket), addr,
Andrei Homescu74a54452021-12-10 05:30:21 +0000288 addrLen, RpcSession::join);
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000289
290 auto& threadRef = mConnectingThreads[thread.get_id()];
291 threadRef = std::move(thread);
292 rpcJoinIfSingleThreaded(threadRef);
Steven Moreland410325a2021-06-02 18:37:42 +0000293 }
Yifan Hong1a235852021-05-13 16:07:47 -0700294 }
Steven Moreland2b4f3802021-05-22 01:46:27 +0000295 LOG_RPC_DETAIL("RpcServer::join exiting with %s", statusToString(status).c_str());
Yifan Hong1a235852021-05-13 16:07:47 -0700296
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000297 if constexpr (kEnableRpcThreads) {
298 RpcMutexLockGuard _l(mLock);
Yifan Hong1a235852021-05-13 16:07:47 -0700299 mJoinThreadRunning = false;
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000300 } else {
301 // Multi-threaded builds clear this in shutdown(), but we need it valid
302 // so the loop above exits cleanly
303 mShutdownTrigger = nullptr;
Yifan Hong1a235852021-05-13 16:07:47 -0700304 }
305 mShutdownCv.notify_all();
Steven Morelandd539fbf2021-05-05 23:40:25 +0000306}
307
Yifan Hong1a235852021-05-13 16:07:47 -0700308bool RpcServer::shutdown() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000309 RpcMutexUniqueLock _l(mLock);
Steven Moreland9d11b922021-05-20 01:22:58 +0000310 if (mShutdownTrigger == nullptr) {
Devin Moore06add172023-03-22 22:49:29 +0000311 LOG_RPC_DETAIL("Cannot shutdown. No shutdown trigger installed (already shutdown, or not "
312 "joined yet?)");
Steven Moreland9d11b922021-05-20 01:22:58 +0000313 return false;
314 }
Yifan Hong1a235852021-05-13 16:07:47 -0700315
316 mShutdownTrigger->trigger();
Steven Morelandab3f4422021-09-27 18:38:20 -0700317
Steven Morelanda8b44292021-06-08 01:27:53 +0000318 for (auto& [id, session] : mSessions) {
319 (void)id;
Steven Morelandab3f4422021-09-27 18:38:20 -0700320 // server lock is a more general lock
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000321 RpcMutexLockGuard _lSession(session->mMutex);
Steven Morelanda8b44292021-06-08 01:27:53 +0000322 session->mShutdownTrigger->trigger();
323 }
324
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000325 if constexpr (!kEnableRpcThreads) {
326 // In single-threaded mode we're done here, everything else that
327 // needs to happen should be at the end of RpcServer::join()
328 return true;
329 }
330
Steven Morelandee3f4662021-05-22 01:07:33 +0000331 while (mJoinThreadRunning || !mConnectingThreads.empty() || !mSessions.empty()) {
Steven Morelandaf4ca712021-05-24 23:22:08 +0000332 if (std::cv_status::timeout == mShutdownCv.wait_for(_l, std::chrono::seconds(1))) {
333 ALOGE("Waiting for RpcServer to shut down (1s w/o progress). Join thread running: %d, "
334 "Connecting threads: "
335 "%zu, Sessions: %zu. Is your server deadlocked?",
336 mJoinThreadRunning, mConnectingThreads.size(), mSessions.size());
337 }
Steven Moreland9d11b922021-05-20 01:22:58 +0000338 }
Yifan Hong1a235852021-05-13 16:07:47 -0700339
Yifan Hong326afd12021-05-19 15:24:54 -0700340 // At this point, we know join() is about to exit, but the thread that calls
341 // join() may not have exited yet.
342 // If RpcServer owns the join thread (aka start() is called), make sure the thread exits;
343 // otherwise ~thread() may call std::terminate(), which may crash the process.
344 // If RpcServer does not own the join thread (aka join() is called directly),
345 // then the owner of RpcServer is responsible for cleaning up that thread.
346 if (mJoinThread.get()) {
347 mJoinThread->join();
348 mJoinThread.reset();
349 }
350
Tomasz Wasilczyk7c8dd482023-03-23 15:30:03 -0700351 mServer = RpcTransportFd();
352
Steven Moreland1c943ec2021-07-13 23:57:56 +0000353 LOG_RPC_DETAIL("Finished waiting on shutdown.");
354
Yifan Hong1a235852021-05-13 16:07:47 -0700355 mShutdownTrigger = nullptr;
356 return true;
357}
358
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000359std::vector<sp<RpcSession>> RpcServer::listSessions() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000360 RpcMutexLockGuard _l(mLock);
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000361 std::vector<sp<RpcSession>> sessions;
362 for (auto& [id, session] : mSessions) {
Steven Moreland736664b2021-05-01 04:27:25 +0000363 (void)id;
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000364 sessions.push_back(session);
Steven Moreland736664b2021-05-01 04:27:25 +0000365 }
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000366 return sessions;
Steven Moreland611d15f2021-05-01 01:28:27 +0000367}
368
Steven Morelandd539fbf2021-05-05 23:40:25 +0000369size_t RpcServer::numUninitializedSessions() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000370 RpcMutexLockGuard _l(mLock);
Steven Morelandd539fbf2021-05-05 23:40:25 +0000371 return mConnectingThreads.size();
372}
373
Andrei Homescu74a54452021-12-10 05:30:21 +0000374void RpcServer::establishConnection(
Pawan3e0061c2022-08-26 21:08:34 +0000375 sp<RpcServer>&& server, RpcTransportFd clientFd, std::array<uint8_t, kRpcAddressSize> addr,
Andrei Homescu74a54452021-12-10 05:30:21 +0000376 size_t addrLen,
377 std::function<void(sp<RpcSession>&&, RpcSession::PreJoinSetupResult&&)>&& joinFn) {
Steven Moreland9d11b922021-05-20 01:22:58 +0000378 // mShutdownTrigger can only be cleared once connection threads have joined.
379 // It must be set before this thread is started
380 LOG_ALWAYS_FATAL_IF(server->mShutdownTrigger == nullptr);
Yifan Hong702115c2021-06-24 15:39:18 -0700381 LOG_ALWAYS_FATAL_IF(server->mCtx == nullptr);
382
383 status_t status = OK;
384
Pawan49d74cb2022-08-03 21:19:11 +0000385 int clientFdForLog = clientFd.fd.get();
Yifan Hongf6d42292021-08-05 23:43:05 -0700386 auto client = server->mCtx->newTransport(std::move(clientFd), server->mShutdownTrigger.get());
Yifan Hong702115c2021-06-24 15:39:18 -0700387 if (client == nullptr) {
388 ALOGE("Dropping accept4()-ed socket because sslAccept fails");
389 status = DEAD_OBJECT;
390 // still need to cleanup before we can return
391 } else {
392 LOG_RPC_DETAIL("Created RpcTransport %p for client fd %d", client.get(), clientFdForLog);
393 }
Steven Moreland9d11b922021-05-20 01:22:58 +0000394
Steven Moreland659416d2021-05-11 00:47:50 +0000395 RpcConnectionHeader header;
Yifan Hong702115c2021-06-24 15:39:18 -0700396 if (status == OK) {
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000397 iovec iov{&header, sizeof(header)};
Devin Moore695368f2022-06-03 22:29:14 +0000398 status = client->interruptableReadFully(server->mShutdownTrigger.get(), &iov, 1,
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000399 std::nullopt, /*ancillaryFds=*/nullptr);
Yifan Hong702115c2021-06-24 15:39:18 -0700400 if (status != OK) {
401 ALOGE("Failed to read ID for client connecting to RPC server: %s",
402 statusToString(status).c_str());
403 // still need to cleanup before we can return
404 }
Steven Morelanda63ff932021-05-12 00:03:15 +0000405 }
Steven Morelandbf57bce2021-07-26 15:26:12 -0700406
Steven Moreland826367f2021-09-10 14:05:31 -0700407 std::vector<uint8_t> sessionId;
408 if (status == OK) {
409 if (header.sessionIdSize > 0) {
Steven Morelandc5032042021-09-30 15:40:27 -0700410 if (header.sessionIdSize == kSessionIdBytes) {
411 sessionId.resize(header.sessionIdSize);
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000412 iovec iov{sessionId.data(), sessionId.size()};
Devin Moore695368f2022-06-03 22:29:14 +0000413 status = client->interruptableReadFully(server->mShutdownTrigger.get(), &iov, 1,
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000414 std::nullopt, /*ancillaryFds=*/nullptr);
Steven Morelandc5032042021-09-30 15:40:27 -0700415 if (status != OK) {
416 ALOGE("Failed to read session ID for client connecting to RPC server: %s",
417 statusToString(status).c_str());
418 // still need to cleanup before we can return
419 }
420 } else {
421 ALOGE("Malformed session ID. Expecting session ID of size %zu but got %" PRIu16,
422 kSessionIdBytes, header.sessionIdSize);
423 status = BAD_VALUE;
Steven Moreland826367f2021-09-10 14:05:31 -0700424 }
425 }
426 }
427
Steven Morelandbf57bce2021-07-26 15:26:12 -0700428 bool incoming = false;
429 uint32_t protocolVersion = 0;
Steven Morelandbf57bce2021-07-26 15:26:12 -0700430 bool requestingNewSession = false;
431
432 if (status == OK) {
433 incoming = header.options & RPC_CONNECTION_OPTION_INCOMING;
434 protocolVersion = std::min(header.version,
435 server->mProtocolVersion.value_or(RPC_WIRE_PROTOCOL_VERSION));
Steven Moreland826367f2021-09-10 14:05:31 -0700436 requestingNewSession = sessionId.empty();
Steven Morelandbf57bce2021-07-26 15:26:12 -0700437
438 if (requestingNewSession) {
439 RpcNewSessionResponse response{
440 .version = protocolVersion,
441 };
442
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000443 iovec iov{&response, sizeof(response)};
Devin Moore695368f2022-06-03 22:29:14 +0000444 status = client->interruptableWriteFully(server->mShutdownTrigger.get(), &iov, 1,
Frederick Mayle69a0c992022-05-26 20:38:39 +0000445 std::nullopt, nullptr);
Steven Morelandbf57bce2021-07-26 15:26:12 -0700446 if (status != OK) {
447 ALOGE("Failed to send new session response: %s", statusToString(status).c_str());
448 // still need to cleanup before we can return
449 }
450 }
451 }
Steven Morelanda63ff932021-05-12 00:03:15 +0000452
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000453 RpcMaybeThread thisThread;
Steven Morelanda63ff932021-05-12 00:03:15 +0000454 sp<RpcSession> session;
455 {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000456 RpcMutexUniqueLock _l(server->mLock);
Steven Morelanda63ff932021-05-12 00:03:15 +0000457
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000458 auto threadId = server->mConnectingThreads.find(rpc_this_thread::get_id());
Yifan Hongb3005502021-05-19 15:37:00 -0700459 LOG_ALWAYS_FATAL_IF(threadId == server->mConnectingThreads.end(),
Steven Morelanda63ff932021-05-12 00:03:15 +0000460 "Must establish connection on owned thread");
461 thisThread = std::move(threadId->second);
Steven Morelandadc5dca2021-05-25 02:06:03 +0000462 ScopeGuard detachGuard = [&]() {
463 thisThread.detach();
Steven Moreland9d11b922021-05-20 01:22:58 +0000464 _l.unlock();
465 server->mShutdownCv.notify_all();
466 };
Steven Morelandadc5dca2021-05-25 02:06:03 +0000467 server->mConnectingThreads.erase(threadId);
Steven Moreland9d11b922021-05-20 01:22:58 +0000468
Steven Morelandbf57bce2021-07-26 15:26:12 -0700469 if (status != OK || server->mShutdownTrigger->isTriggered()) {
Steven Moreland5802c2b2021-05-12 20:13:04 +0000470 return;
471 }
472
Steven Morelandbf57bce2021-07-26 15:26:12 -0700473 if (requestingNewSession) {
Steven Moreland1b304292021-07-15 22:59:34 +0000474 if (incoming) {
475 ALOGE("Cannot create a new session with an incoming connection, would leak");
Steven Moreland659416d2021-05-11 00:47:50 +0000476 return;
477 }
478
Steven Moreland826367f2021-09-10 14:05:31 -0700479 // Uniquely identify session at the application layer. Even if a
480 // client/server use the same certificates, if they create multiple
481 // sessions, we still want to distinguish between them.
Steven Morelandc5032042021-09-30 15:40:27 -0700482 sessionId.resize(kSessionIdBytes);
Steven Moreland01a6bad2021-06-11 00:59:20 +0000483 size_t tries = 0;
484 do {
485 // don't block if there is some entropy issue
486 if (tries++ > 5) {
Steven Moreland826367f2021-09-10 14:05:31 -0700487 ALOGE("Cannot find new address: %s",
488 base::HexString(sessionId.data(), sessionId.size()).c_str());
Steven Moreland01a6bad2021-06-11 00:59:20 +0000489 return;
490 }
491
Andrei Homescuc24c8792022-04-19 00:24:51 +0000492 auto status = getRandomBytes(sessionId.data(), sessionId.size());
493 if (status != OK) {
494 ALOGE("Failed to read random session ID: %s", strerror(-status));
Steven Moreland826367f2021-09-10 14:05:31 -0700495 return;
496 }
Steven Moreland01a6bad2021-06-11 00:59:20 +0000497 } while (server->mSessions.end() != server->mSessions.find(sessionId));
Steven Morelanda63ff932021-05-12 00:03:15 +0000498
Andrei Homescu5e301462022-05-12 00:52:34 +0000499 session = sp<RpcSession>::make(nullptr);
Yifan Hong10423062021-10-08 16:26:32 -0700500 session->setMaxIncomingThreads(server->mMaxThreads);
Steven Morelandbf57bce2021-07-26 15:26:12 -0700501 if (!session->setProtocolVersion(protocolVersion)) return;
Steven Moreland51c44a92021-10-14 16:50:35 -0700502
Frederick Mayle26b494e2022-07-08 22:09:58 +0000503 if (header.fileDescriptorTransportMode <
504 server->mSupportedFileDescriptorTransportModes.size() &&
505 server->mSupportedFileDescriptorTransportModes.test(
Frederick Mayle69a0c992022-05-26 20:38:39 +0000506 header.fileDescriptorTransportMode)) {
507 session->setFileDescriptorTransportMode(
508 static_cast<RpcSession::FileDescriptorTransportMode>(
509 header.fileDescriptorTransportMode));
510 } else {
511 ALOGE("Rejecting connection: FileDescriptorTransportMode is not supported: %hhu",
512 header.fileDescriptorTransportMode);
513 return;
514 }
515
Steven Moreland51c44a92021-10-14 16:50:35 -0700516 // if null, falls back to server root
517 sp<IBinder> sessionSpecificRoot;
518 if (server->mRootObjectFactory != nullptr) {
Steven Morelanddfb92182023-05-24 17:48:59 +0000519 sessionSpecificRoot =
520 server->mRootObjectFactory(wp<RpcSession>(session), addr.data(), addrLen);
Steven Moreland51c44a92021-10-14 16:50:35 -0700521 if (sessionSpecificRoot == nullptr) {
522 ALOGE("Warning: server returned null from root object factory");
523 }
524 }
525
Steven Morelanda8b44292021-06-08 01:27:53 +0000526 if (!session->setForServer(server,
527 sp<RpcServer::EventListener>::fromExisting(
528 static_cast<RpcServer::EventListener*>(
529 server.get())),
Steven Moreland51c44a92021-10-14 16:50:35 -0700530 sessionId, sessionSpecificRoot)) {
Steven Morelanda8b44292021-06-08 01:27:53 +0000531 ALOGE("Failed to attach server to session");
532 return;
533 }
Steven Morelanda63ff932021-05-12 00:03:15 +0000534
Steven Moreland01a6bad2021-06-11 00:59:20 +0000535 server->mSessions[sessionId] = session;
Steven Morelanda63ff932021-05-12 00:03:15 +0000536 } else {
Steven Moreland01a6bad2021-06-11 00:59:20 +0000537 auto it = server->mSessions.find(sessionId);
Yifan Hongb3005502021-05-19 15:37:00 -0700538 if (it == server->mSessions.end()) {
Steven Moreland01a6bad2021-06-11 00:59:20 +0000539 ALOGE("Cannot add thread, no record of session with ID %s",
Steven Moreland826367f2021-09-10 14:05:31 -0700540 base::HexString(sessionId.data(), sessionId.size()).c_str());
Steven Morelanda63ff932021-05-12 00:03:15 +0000541 return;
542 }
543 session = it->second;
544 }
Steven Moreland5802c2b2021-05-12 20:13:04 +0000545
Steven Moreland1b304292021-07-15 22:59:34 +0000546 if (incoming) {
Steven Moreland2372f9d2021-08-05 15:42:01 -0700547 LOG_ALWAYS_FATAL_IF(OK != session->addOutgoingConnection(std::move(client), true),
Steven Moreland659416d2021-05-11 00:47:50 +0000548 "server state must already be initialized");
549 return;
550 }
551
Steven Moreland5802c2b2021-05-12 20:13:04 +0000552 detachGuard.Disable();
Steven Morelandc88b7fc2021-06-10 00:40:39 +0000553 session->preJoinThreadOwnership(std::move(thisThread));
Steven Morelanda63ff932021-05-12 00:03:15 +0000554 }
555
Yifan Hong702115c2021-06-24 15:39:18 -0700556 auto setupResult = session->preJoinSetup(std::move(client));
Steven Morelandc88b7fc2021-06-10 00:40:39 +0000557
Steven Morelanda63ff932021-05-12 00:03:15 +0000558 // avoid strong cycle
559 server = nullptr;
Steven Morelanda63ff932021-05-12 00:03:15 +0000560
Andrei Homescu74a54452021-12-10 05:30:21 +0000561 joinFn(std::move(session), std::move(setupResult));
Steven Morelanda63ff932021-05-12 00:03:15 +0000562}
563
Steven Moreland2372f9d2021-08-05 15:42:01 -0700564status_t RpcServer::setupSocketServer(const RpcSocketAddress& addr) {
Steven Moreland704fc1a2021-05-04 23:13:14 +0000565 LOG_RPC_DETAIL("Setting up socket server %s", addr.toString().c_str());
Yifan Hong0eb5a672021-05-12 18:00:25 -0700566 LOG_ALWAYS_FATAL_IF(hasServer(), "Each RpcServer can only have one server.");
Steven Moreland611d15f2021-05-01 01:28:27 +0000567
Alice Wang0b138ed2022-11-15 16:22:44 +0000568 unique_fd socket_fd(TEMP_FAILURE_RETRY(
569 socket(addr.addr()->sa_family, SOCK_STREAM | SOCK_CLOEXEC | SOCK_NONBLOCK, 0)));
570 if (!socket_fd.ok()) {
Steven Moreland2372f9d2021-08-05 15:42:01 -0700571 int savedErrno = errno;
Steven Moreland8925ebb2023-04-10 21:52:17 +0000572 ALOGE("Could not create socket at %s: %s", addr.toString().c_str(), strerror(savedErrno));
Steven Moreland2372f9d2021-08-05 15:42:01 -0700573 return -savedErrno;
Steven Moreland611d15f2021-05-01 01:28:27 +0000574 }
Tomasz Wasilczyk7c8dd482023-03-23 15:30:03 -0700575
Keith Mok442907b2023-10-11 20:36:18 +0000576 if (addr.addr()->sa_family == AF_INET || addr.addr()->sa_family == AF_INET6) {
577 int noDelay = 1;
578 int result =
579 setsockopt(socket_fd.get(), IPPROTO_TCP, TCP_NODELAY, &noDelay, sizeof(noDelay));
580 if (result < 0) {
581 int savedErrno = errno;
582 ALOGE("Could not set TCP_NODELAY on %s", strerror(savedErrno));
583 return -savedErrno;
584 }
585 }
586
Tomasz Wasilczyk7c8dd482023-03-23 15:30:03 -0700587 {
588 RpcMutexLockGuard _l(mLock);
589 if (mServerSocketModifier != nullptr) {
590 mServerSocketModifier(socket_fd);
591 }
592 }
593
Alice Wang0b138ed2022-11-15 16:22:44 +0000594 if (0 != TEMP_FAILURE_RETRY(bind(socket_fd.get(), addr.addr(), addr.addrSize()))) {
Steven Moreland611d15f2021-05-01 01:28:27 +0000595 int savedErrno = errno;
596 ALOGE("Could not bind socket at %s: %s", addr.toString().c_str(), strerror(savedErrno));
Steven Moreland2372f9d2021-08-05 15:42:01 -0700597 return -savedErrno;
Steven Moreland611d15f2021-05-01 01:28:27 +0000598 }
599
Alice Wang0b138ed2022-11-15 16:22:44 +0000600 return setupRawSocketServer(std::move(socket_fd));
Steven Moreland611d15f2021-05-01 01:28:27 +0000601}
602
Alice Wang0b138ed2022-11-15 16:22:44 +0000603status_t RpcServer::setupRawSocketServer(unique_fd socket_fd) {
Alice Wang30c204d2022-11-15 12:50:51 +0000604 LOG_ALWAYS_FATAL_IF(!socket_fd.ok(), "Socket must be setup to listen.");
Alice Wang30c204d2022-11-15 12:50:51 +0000605
Alice Wang893a9912022-10-24 10:44:09 +0000606 // Right now, we create all threads at once, making accept4 slow. To avoid hanging the client,
607 // the backlog is increased to a large number.
608 // TODO(b/189955605): Once we create threads dynamically & lazily, the backlog can be reduced
609 // to 1.
Alice Wangdf741782022-11-16 08:37:04 +0000610 if (0 != TEMP_FAILURE_RETRY(listen(socket_fd.get(), 50 /*backlog*/))) {
Alice Wang893a9912022-10-24 10:44:09 +0000611 int savedErrno = errno;
612 ALOGE("Could not listen initialized Unix socket: %s", strerror(savedErrno));
613 return -savedErrno;
614 }
Alice Wangdf741782022-11-16 08:37:04 +0000615 if (status_t status = setupExternalServer(std::move(socket_fd)); status != OK) {
Alice Wang893a9912022-10-24 10:44:09 +0000616 ALOGE("Another thread has set up server while calling setupSocketServer. Race?");
617 return status;
618 }
619 return OK;
620}
621
Steven Morelanddd67b942021-07-23 17:15:41 -0700622void RpcServer::onSessionAllIncomingThreadsEnded(const sp<RpcSession>& session) {
Steven Moreland826367f2021-09-10 14:05:31 -0700623 const std::vector<uint8_t>& id = session->mId;
624 LOG_ALWAYS_FATAL_IF(id.empty(), "Server sessions must be initialized with ID");
625 LOG_RPC_DETAIL("Dropping session with address %s",
626 base::HexString(id.data(), id.size()).c_str());
Steven Morelandee78e762021-05-05 21:12:51 +0000627
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000628 RpcMutexLockGuard _l(mLock);
Steven Moreland826367f2021-09-10 14:05:31 -0700629 auto it = mSessions.find(id);
Steven Moreland01a6bad2021-06-11 00:59:20 +0000630 LOG_ALWAYS_FATAL_IF(it == mSessions.end(), "Bad state, unknown session id %s",
Steven Moreland826367f2021-09-10 14:05:31 -0700631 base::HexString(id.data(), id.size()).c_str());
Steven Moreland01a6bad2021-06-11 00:59:20 +0000632 LOG_ALWAYS_FATAL_IF(it->second != session, "Bad state, session has id mismatch %s",
Steven Moreland826367f2021-09-10 14:05:31 -0700633 base::HexString(id.data(), id.size()).c_str());
Steven Morelandee78e762021-05-05 21:12:51 +0000634 (void)mSessions.erase(it);
635}
636
Steven Moreland19fc9f72021-06-10 03:57:30 +0000637void RpcServer::onSessionIncomingThreadEnded() {
Steven Morelandee3f4662021-05-22 01:07:33 +0000638 mShutdownCv.notify_all();
639}
640
Yifan Hong0eb5a672021-05-12 18:00:25 -0700641bool RpcServer::hasServer() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000642 RpcMutexLockGuard _l(mLock);
Pawan49d74cb2022-08-03 21:19:11 +0000643 return mServer.fd.ok();
Yifan Hong0eb5a672021-05-12 18:00:25 -0700644}
645
Yifan Hong00aeb762021-05-12 17:07:36 -0700646unique_fd RpcServer::releaseServer() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000647 RpcMutexLockGuard _l(mLock);
Pawan49d74cb2022-08-03 21:19:11 +0000648 return std::move(mServer.fd);
Yifan Hong00aeb762021-05-12 17:07:36 -0700649}
650
David Brazdil21c887c2022-09-23 12:25:18 +0100651status_t RpcServer::setupExternalServer(
652 base::unique_fd serverFd,
653 std::function<status_t(const RpcServer&, RpcTransportFd*)>&& acceptFn) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000654 RpcMutexLockGuard _l(mLock);
Pawan49d74cb2022-08-03 21:19:11 +0000655 if (mServer.fd.ok()) {
Yifan Hong00aeb762021-05-12 17:07:36 -0700656 ALOGE("Each RpcServer can only have one server.");
Steven Moreland2372f9d2021-08-05 15:42:01 -0700657 return INVALID_OPERATION;
Yifan Hong00aeb762021-05-12 17:07:36 -0700658 }
659 mServer = std::move(serverFd);
David Brazdil21c887c2022-09-23 12:25:18 +0100660 mAcceptFn = std::move(acceptFn);
Steven Moreland2372f9d2021-08-05 15:42:01 -0700661 return OK;
Yifan Hong00aeb762021-05-12 17:07:36 -0700662}
663
David Brazdil21c887c2022-09-23 12:25:18 +0100664status_t RpcServer::setupExternalServer(base::unique_fd serverFd) {
665 return setupExternalServer(std::move(serverFd), &RpcServer::acceptSocketConnection);
666}
667
Pawan1c24f9c2022-08-26 23:23:15 +0000668bool RpcServer::hasActiveRequests() {
669 RpcMutexLockGuard _l(mLock);
670 for (const auto& [_, session] : mSessions) {
671 if (session->hasActiveRequests()) {
672 return true;
673 }
674 }
675 return !mServer.isInPollingState();
676}
677
Steven Moreland5553ac42020-11-11 02:14:45 +0000678} // namespace android