blob: 1ba20b3103eaf4638d3795824e89c5b0b92ced3c [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
Tomasz Wasilczyk1de48a22023-10-30 14:19:19 +000028#include <binder/Functional.h>
Steven Moreland5553ac42020-11-11 02:14:45 +000029#include <binder/Parcel.h>
30#include <binder/RpcServer.h>
Yifan Hong702115c2021-06-24 15:39:18 -070031#include <binder/RpcTransportRaw.h>
Steven Moreland5553ac42020-11-11 02:14:45 +000032#include <log/log.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
Tomasz Wasilczyk1de48a22023-10-30 14:19:19 +000047using namespace android::binder::impl;
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)
Tomasz Wasilczyk0d9dec22023-10-06 20:28:49 +000059 rpcTransportCtxFactory = binder::os::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
Tomasz Wasilczyk0d9dec22023-10-06 20:28:49 +0000218 ssize_t num_bytes = binder::os::receiveMessageFromSocket(server.mServer, &iov, 1, &fds);
David Brazdil8a741902022-12-17 21:41:04 +0000219 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())));
Tomasz Wasilczyk88aa8c32023-11-01 09:46:07 -0700233 if (status_t res = binder::os::setNonBlocking(fd); res != OK) return res;
David Brazdil21c887c2022-09-23 12:25:18 +0100234
235 *out = RpcTransportFd(std::move(fd));
236 return OK;
237}
238
Steven Moreland611d15f2021-05-01 01:28:27 +0000239void RpcServer::join() {
Yifan Hong1a235852021-05-13 16:07:47 -0700240
241 {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000242 RpcMutexLockGuard _l(mLock);
Pawan49d74cb2022-08-03 21:19:11 +0000243 LOG_ALWAYS_FATAL_IF(!mServer.fd.ok(), "RpcServer must be setup to join.");
David Brazdil21c887c2022-09-23 12:25:18 +0100244 LOG_ALWAYS_FATAL_IF(mAcceptFn == nullptr, "RpcServer must have an accept() function");
Yifan Hong1a235852021-05-13 16:07:47 -0700245 LOG_ALWAYS_FATAL_IF(mShutdownTrigger != nullptr, "Already joined");
246 mJoinThreadRunning = true;
Yifan Hong8c950422021-08-05 17:13:55 -0700247 mShutdownTrigger = FdTrigger::make();
Yifan Hong1a235852021-05-13 16:07:47 -0700248 LOG_ALWAYS_FATAL_IF(mShutdownTrigger == nullptr, "Cannot create join signaler");
Steven Morelandd539fbf2021-05-05 23:40:25 +0000249 }
Yifan Hong1a235852021-05-13 16:07:47 -0700250
Steven Moreland2b4f3802021-05-22 01:46:27 +0000251 status_t status;
Steven Moreland798e0d12021-07-14 23:19:25 +0000252 while ((status = mShutdownTrigger->triggerablePoll(mServer, POLLIN)) == OK) {
Andrei Homescu86124ca2022-04-21 22:22:48 +0000253 std::array<uint8_t, kRpcAddressSize> addr;
254 static_assert(addr.size() >= sizeof(sockaddr_storage), "kRpcAddressSize is too small");
Andrei Homescu86124ca2022-04-21 22:22:48 +0000255 socklen_t addrLen = addr.size();
Steven Moreland51c44a92021-10-14 16:50:35 -0700256
David Brazdil21c887c2022-09-23 12:25:18 +0100257 RpcTransportFd clientSocket;
David Brazdil8a741902022-12-17 21:41:04 +0000258 if ((status = mAcceptFn(*this, &clientSocket)) != OK) {
259 if (status == DEAD_OBJECT)
260 break;
261 else
262 continue;
Steven Moreland410325a2021-06-02 18:37:42 +0000263 }
David Brazdila47dfda2022-11-22 22:52:19 +0000264
265 LOG_RPC_DETAIL("accept on fd %d yields fd %d", mServer.fd.get(), clientSocket.fd.get());
266
David Brazdil21c887c2022-09-23 12:25:18 +0100267 if (getpeername(clientSocket.fd.get(), reinterpret_cast<sockaddr*>(addr.data()),
268 &addrLen)) {
269 ALOGE("Could not getpeername socket: %s", strerror(errno));
270 continue;
271 }
272
David Brazdila47dfda2022-11-22 22:52:19 +0000273 if (mConnectionFilter != nullptr && !mConnectionFilter(addr.data(), addrLen)) {
274 ALOGE("Dropped client connection fd %d", clientSocket.fd.get());
275 continue;
276 }
Steven Moreland410325a2021-06-02 18:37:42 +0000277
278 {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000279 RpcMutexLockGuard _l(mLock);
Andrei Homescu74a54452021-12-10 05:30:21 +0000280 RpcMaybeThread thread =
281 RpcMaybeThread(&RpcServer::establishConnection,
Pawan49d74cb2022-08-03 21:19:11 +0000282 sp<RpcServer>::fromExisting(this), std::move(clientSocket), addr,
Andrei Homescu74a54452021-12-10 05:30:21 +0000283 addrLen, RpcSession::join);
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000284
285 auto& threadRef = mConnectingThreads[thread.get_id()];
286 threadRef = std::move(thread);
287 rpcJoinIfSingleThreaded(threadRef);
Steven Moreland410325a2021-06-02 18:37:42 +0000288 }
Yifan Hong1a235852021-05-13 16:07:47 -0700289 }
Steven Moreland2b4f3802021-05-22 01:46:27 +0000290 LOG_RPC_DETAIL("RpcServer::join exiting with %s", statusToString(status).c_str());
Yifan Hong1a235852021-05-13 16:07:47 -0700291
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000292 if constexpr (kEnableRpcThreads) {
293 RpcMutexLockGuard _l(mLock);
Yifan Hong1a235852021-05-13 16:07:47 -0700294 mJoinThreadRunning = false;
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000295 } else {
296 // Multi-threaded builds clear this in shutdown(), but we need it valid
297 // so the loop above exits cleanly
298 mShutdownTrigger = nullptr;
Yifan Hong1a235852021-05-13 16:07:47 -0700299 }
300 mShutdownCv.notify_all();
Steven Morelandd539fbf2021-05-05 23:40:25 +0000301}
302
Yifan Hong1a235852021-05-13 16:07:47 -0700303bool RpcServer::shutdown() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000304 RpcMutexUniqueLock _l(mLock);
Steven Moreland9d11b922021-05-20 01:22:58 +0000305 if (mShutdownTrigger == nullptr) {
Devin Moore06add172023-03-22 22:49:29 +0000306 LOG_RPC_DETAIL("Cannot shutdown. No shutdown trigger installed (already shutdown, or not "
307 "joined yet?)");
Steven Moreland9d11b922021-05-20 01:22:58 +0000308 return false;
309 }
Yifan Hong1a235852021-05-13 16:07:47 -0700310
311 mShutdownTrigger->trigger();
Steven Morelandab3f4422021-09-27 18:38:20 -0700312
Steven Morelanda8b44292021-06-08 01:27:53 +0000313 for (auto& [id, session] : mSessions) {
314 (void)id;
Steven Morelandab3f4422021-09-27 18:38:20 -0700315 // server lock is a more general lock
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000316 RpcMutexLockGuard _lSession(session->mMutex);
Steven Morelanda8b44292021-06-08 01:27:53 +0000317 session->mShutdownTrigger->trigger();
318 }
319
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000320 if constexpr (!kEnableRpcThreads) {
321 // In single-threaded mode we're done here, everything else that
322 // needs to happen should be at the end of RpcServer::join()
323 return true;
324 }
325
Steven Morelandee3f4662021-05-22 01:07:33 +0000326 while (mJoinThreadRunning || !mConnectingThreads.empty() || !mSessions.empty()) {
Steven Morelandaf4ca712021-05-24 23:22:08 +0000327 if (std::cv_status::timeout == mShutdownCv.wait_for(_l, std::chrono::seconds(1))) {
328 ALOGE("Waiting for RpcServer to shut down (1s w/o progress). Join thread running: %d, "
329 "Connecting threads: "
330 "%zu, Sessions: %zu. Is your server deadlocked?",
331 mJoinThreadRunning, mConnectingThreads.size(), mSessions.size());
332 }
Steven Moreland9d11b922021-05-20 01:22:58 +0000333 }
Yifan Hong1a235852021-05-13 16:07:47 -0700334
Yifan Hong326afd12021-05-19 15:24:54 -0700335 // At this point, we know join() is about to exit, but the thread that calls
336 // join() may not have exited yet.
337 // If RpcServer owns the join thread (aka start() is called), make sure the thread exits;
338 // otherwise ~thread() may call std::terminate(), which may crash the process.
339 // If RpcServer does not own the join thread (aka join() is called directly),
340 // then the owner of RpcServer is responsible for cleaning up that thread.
341 if (mJoinThread.get()) {
342 mJoinThread->join();
343 mJoinThread.reset();
344 }
345
Tomasz Wasilczyk7c8dd482023-03-23 15:30:03 -0700346 mServer = RpcTransportFd();
347
Steven Moreland1c943ec2021-07-13 23:57:56 +0000348 LOG_RPC_DETAIL("Finished waiting on shutdown.");
349
Yifan Hong1a235852021-05-13 16:07:47 -0700350 mShutdownTrigger = nullptr;
351 return true;
352}
353
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000354std::vector<sp<RpcSession>> RpcServer::listSessions() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000355 RpcMutexLockGuard _l(mLock);
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000356 std::vector<sp<RpcSession>> sessions;
357 for (auto& [id, session] : mSessions) {
Steven Moreland736664b2021-05-01 04:27:25 +0000358 (void)id;
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000359 sessions.push_back(session);
Steven Moreland736664b2021-05-01 04:27:25 +0000360 }
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000361 return sessions;
Steven Moreland611d15f2021-05-01 01:28:27 +0000362}
363
Steven Morelandd539fbf2021-05-05 23:40:25 +0000364size_t RpcServer::numUninitializedSessions() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000365 RpcMutexLockGuard _l(mLock);
Steven Morelandd539fbf2021-05-05 23:40:25 +0000366 return mConnectingThreads.size();
367}
368
Andrei Homescu74a54452021-12-10 05:30:21 +0000369void RpcServer::establishConnection(
Pawan3e0061c2022-08-26 21:08:34 +0000370 sp<RpcServer>&& server, RpcTransportFd clientFd, std::array<uint8_t, kRpcAddressSize> addr,
Andrei Homescu74a54452021-12-10 05:30:21 +0000371 size_t addrLen,
372 std::function<void(sp<RpcSession>&&, RpcSession::PreJoinSetupResult&&)>&& joinFn) {
Steven Moreland9d11b922021-05-20 01:22:58 +0000373 // mShutdownTrigger can only be cleared once connection threads have joined.
374 // It must be set before this thread is started
375 LOG_ALWAYS_FATAL_IF(server->mShutdownTrigger == nullptr);
Yifan Hong702115c2021-06-24 15:39:18 -0700376 LOG_ALWAYS_FATAL_IF(server->mCtx == nullptr);
377
378 status_t status = OK;
379
Pawan49d74cb2022-08-03 21:19:11 +0000380 int clientFdForLog = clientFd.fd.get();
Yifan Hongf6d42292021-08-05 23:43:05 -0700381 auto client = server->mCtx->newTransport(std::move(clientFd), server->mShutdownTrigger.get());
Yifan Hong702115c2021-06-24 15:39:18 -0700382 if (client == nullptr) {
383 ALOGE("Dropping accept4()-ed socket because sslAccept fails");
384 status = DEAD_OBJECT;
385 // still need to cleanup before we can return
386 } else {
387 LOG_RPC_DETAIL("Created RpcTransport %p for client fd %d", client.get(), clientFdForLog);
388 }
Steven Moreland9d11b922021-05-20 01:22:58 +0000389
Steven Moreland659416d2021-05-11 00:47:50 +0000390 RpcConnectionHeader header;
Yifan Hong702115c2021-06-24 15:39:18 -0700391 if (status == OK) {
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000392 iovec iov{&header, sizeof(header)};
Devin Moore695368f2022-06-03 22:29:14 +0000393 status = client->interruptableReadFully(server->mShutdownTrigger.get(), &iov, 1,
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000394 std::nullopt, /*ancillaryFds=*/nullptr);
Yifan Hong702115c2021-06-24 15:39:18 -0700395 if (status != OK) {
396 ALOGE("Failed to read ID for client connecting to RPC server: %s",
397 statusToString(status).c_str());
398 // still need to cleanup before we can return
399 }
Steven Morelanda63ff932021-05-12 00:03:15 +0000400 }
Steven Morelandbf57bce2021-07-26 15:26:12 -0700401
Steven Moreland826367f2021-09-10 14:05:31 -0700402 std::vector<uint8_t> sessionId;
403 if (status == OK) {
404 if (header.sessionIdSize > 0) {
Steven Morelandc5032042021-09-30 15:40:27 -0700405 if (header.sessionIdSize == kSessionIdBytes) {
406 sessionId.resize(header.sessionIdSize);
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000407 iovec iov{sessionId.data(), sessionId.size()};
Devin Moore695368f2022-06-03 22:29:14 +0000408 status = client->interruptableReadFully(server->mShutdownTrigger.get(), &iov, 1,
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000409 std::nullopt, /*ancillaryFds=*/nullptr);
Steven Morelandc5032042021-09-30 15:40:27 -0700410 if (status != OK) {
411 ALOGE("Failed to read session ID for client connecting to RPC server: %s",
412 statusToString(status).c_str());
413 // still need to cleanup before we can return
414 }
415 } else {
416 ALOGE("Malformed session ID. Expecting session ID of size %zu but got %" PRIu16,
417 kSessionIdBytes, header.sessionIdSize);
418 status = BAD_VALUE;
Steven Moreland826367f2021-09-10 14:05:31 -0700419 }
420 }
421 }
422
Steven Morelandbf57bce2021-07-26 15:26:12 -0700423 bool incoming = false;
424 uint32_t protocolVersion = 0;
Steven Morelandbf57bce2021-07-26 15:26:12 -0700425 bool requestingNewSession = false;
426
427 if (status == OK) {
428 incoming = header.options & RPC_CONNECTION_OPTION_INCOMING;
429 protocolVersion = std::min(header.version,
430 server->mProtocolVersion.value_or(RPC_WIRE_PROTOCOL_VERSION));
Steven Moreland826367f2021-09-10 14:05:31 -0700431 requestingNewSession = sessionId.empty();
Steven Morelandbf57bce2021-07-26 15:26:12 -0700432
433 if (requestingNewSession) {
434 RpcNewSessionResponse response{
435 .version = protocolVersion,
436 };
437
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000438 iovec iov{&response, sizeof(response)};
Devin Moore695368f2022-06-03 22:29:14 +0000439 status = client->interruptableWriteFully(server->mShutdownTrigger.get(), &iov, 1,
Frederick Mayle69a0c992022-05-26 20:38:39 +0000440 std::nullopt, nullptr);
Steven Morelandbf57bce2021-07-26 15:26:12 -0700441 if (status != OK) {
442 ALOGE("Failed to send new session response: %s", statusToString(status).c_str());
443 // still need to cleanup before we can return
444 }
445 }
446 }
Steven Morelanda63ff932021-05-12 00:03:15 +0000447
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000448 RpcMaybeThread thisThread;
Steven Morelanda63ff932021-05-12 00:03:15 +0000449 sp<RpcSession> session;
450 {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000451 RpcMutexUniqueLock _l(server->mLock);
Steven Morelanda63ff932021-05-12 00:03:15 +0000452
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000453 auto threadId = server->mConnectingThreads.find(rpc_this_thread::get_id());
Yifan Hongb3005502021-05-19 15:37:00 -0700454 LOG_ALWAYS_FATAL_IF(threadId == server->mConnectingThreads.end(),
Steven Morelanda63ff932021-05-12 00:03:15 +0000455 "Must establish connection on owned thread");
456 thisThread = std::move(threadId->second);
Tomasz Wasilczyk1de48a22023-10-30 14:19:19 +0000457 auto detachGuardLambda = [&]() {
Steven Morelandadc5dca2021-05-25 02:06:03 +0000458 thisThread.detach();
Steven Moreland9d11b922021-05-20 01:22:58 +0000459 _l.unlock();
460 server->mShutdownCv.notify_all();
461 };
Tomasz Wasilczyk1de48a22023-10-30 14:19:19 +0000462 auto detachGuard = make_scope_guard(std::ref(detachGuardLambda));
Steven Morelandadc5dca2021-05-25 02:06:03 +0000463 server->mConnectingThreads.erase(threadId);
Steven Moreland9d11b922021-05-20 01:22:58 +0000464
Steven Morelandbf57bce2021-07-26 15:26:12 -0700465 if (status != OK || server->mShutdownTrigger->isTriggered()) {
Steven Moreland5802c2b2021-05-12 20:13:04 +0000466 return;
467 }
468
Steven Morelandbf57bce2021-07-26 15:26:12 -0700469 if (requestingNewSession) {
Steven Moreland1b304292021-07-15 22:59:34 +0000470 if (incoming) {
471 ALOGE("Cannot create a new session with an incoming connection, would leak");
Steven Moreland659416d2021-05-11 00:47:50 +0000472 return;
473 }
474
Steven Moreland826367f2021-09-10 14:05:31 -0700475 // Uniquely identify session at the application layer. Even if a
476 // client/server use the same certificates, if they create multiple
477 // sessions, we still want to distinguish between them.
Steven Morelandc5032042021-09-30 15:40:27 -0700478 sessionId.resize(kSessionIdBytes);
Steven Moreland01a6bad2021-06-11 00:59:20 +0000479 size_t tries = 0;
480 do {
481 // don't block if there is some entropy issue
482 if (tries++ > 5) {
Steven Moreland826367f2021-09-10 14:05:31 -0700483 ALOGE("Cannot find new address: %s",
Tomasz Wasilczyk891f6b02023-10-11 18:35:42 +0000484 HexString(sessionId.data(), sessionId.size()).c_str());
Steven Moreland01a6bad2021-06-11 00:59:20 +0000485 return;
486 }
487
Tomasz Wasilczyk0d9dec22023-10-06 20:28:49 +0000488 auto status = binder::os::getRandomBytes(sessionId.data(), sessionId.size());
Andrei Homescuc24c8792022-04-19 00:24:51 +0000489 if (status != OK) {
490 ALOGE("Failed to read random session ID: %s", strerror(-status));
Steven Moreland826367f2021-09-10 14:05:31 -0700491 return;
492 }
Steven Moreland01a6bad2021-06-11 00:59:20 +0000493 } while (server->mSessions.end() != server->mSessions.find(sessionId));
Steven Morelanda63ff932021-05-12 00:03:15 +0000494
Andrei Homescu5e301462022-05-12 00:52:34 +0000495 session = sp<RpcSession>::make(nullptr);
Yifan Hong10423062021-10-08 16:26:32 -0700496 session->setMaxIncomingThreads(server->mMaxThreads);
Steven Morelandbf57bce2021-07-26 15:26:12 -0700497 if (!session->setProtocolVersion(protocolVersion)) return;
Steven Moreland51c44a92021-10-14 16:50:35 -0700498
Frederick Mayle26b494e2022-07-08 22:09:58 +0000499 if (header.fileDescriptorTransportMode <
500 server->mSupportedFileDescriptorTransportModes.size() &&
501 server->mSupportedFileDescriptorTransportModes.test(
Frederick Mayle69a0c992022-05-26 20:38:39 +0000502 header.fileDescriptorTransportMode)) {
503 session->setFileDescriptorTransportMode(
504 static_cast<RpcSession::FileDescriptorTransportMode>(
505 header.fileDescriptorTransportMode));
506 } else {
507 ALOGE("Rejecting connection: FileDescriptorTransportMode is not supported: %hhu",
508 header.fileDescriptorTransportMode);
509 return;
510 }
511
Steven Moreland51c44a92021-10-14 16:50:35 -0700512 // if null, falls back to server root
513 sp<IBinder> sessionSpecificRoot;
514 if (server->mRootObjectFactory != nullptr) {
Steven Morelanddfb92182023-05-24 17:48:59 +0000515 sessionSpecificRoot =
516 server->mRootObjectFactory(wp<RpcSession>(session), addr.data(), addrLen);
Steven Moreland51c44a92021-10-14 16:50:35 -0700517 if (sessionSpecificRoot == nullptr) {
518 ALOGE("Warning: server returned null from root object factory");
519 }
520 }
521
Steven Morelanda8b44292021-06-08 01:27:53 +0000522 if (!session->setForServer(server,
523 sp<RpcServer::EventListener>::fromExisting(
524 static_cast<RpcServer::EventListener*>(
525 server.get())),
Steven Moreland51c44a92021-10-14 16:50:35 -0700526 sessionId, sessionSpecificRoot)) {
Steven Morelanda8b44292021-06-08 01:27:53 +0000527 ALOGE("Failed to attach server to session");
528 return;
529 }
Steven Morelanda63ff932021-05-12 00:03:15 +0000530
Steven Moreland01a6bad2021-06-11 00:59:20 +0000531 server->mSessions[sessionId] = session;
Steven Morelanda63ff932021-05-12 00:03:15 +0000532 } else {
Steven Moreland01a6bad2021-06-11 00:59:20 +0000533 auto it = server->mSessions.find(sessionId);
Yifan Hongb3005502021-05-19 15:37:00 -0700534 if (it == server->mSessions.end()) {
Steven Moreland01a6bad2021-06-11 00:59:20 +0000535 ALOGE("Cannot add thread, no record of session with ID %s",
Tomasz Wasilczyk891f6b02023-10-11 18:35:42 +0000536 HexString(sessionId.data(), sessionId.size()).c_str());
Steven Morelanda63ff932021-05-12 00:03:15 +0000537 return;
538 }
539 session = it->second;
540 }
Steven Moreland5802c2b2021-05-12 20:13:04 +0000541
Steven Moreland1b304292021-07-15 22:59:34 +0000542 if (incoming) {
Steven Moreland2372f9d2021-08-05 15:42:01 -0700543 LOG_ALWAYS_FATAL_IF(OK != session->addOutgoingConnection(std::move(client), true),
Steven Moreland659416d2021-05-11 00:47:50 +0000544 "server state must already be initialized");
545 return;
546 }
547
Tomasz Wasilczyk1de48a22023-10-30 14:19:19 +0000548 detachGuard.release();
Steven Morelandc88b7fc2021-06-10 00:40:39 +0000549 session->preJoinThreadOwnership(std::move(thisThread));
Steven Morelanda63ff932021-05-12 00:03:15 +0000550 }
551
Yifan Hong702115c2021-06-24 15:39:18 -0700552 auto setupResult = session->preJoinSetup(std::move(client));
Steven Morelandc88b7fc2021-06-10 00:40:39 +0000553
Steven Morelanda63ff932021-05-12 00:03:15 +0000554 // avoid strong cycle
555 server = nullptr;
Steven Morelanda63ff932021-05-12 00:03:15 +0000556
Andrei Homescu74a54452021-12-10 05:30:21 +0000557 joinFn(std::move(session), std::move(setupResult));
Steven Morelanda63ff932021-05-12 00:03:15 +0000558}
559
Steven Moreland2372f9d2021-08-05 15:42:01 -0700560status_t RpcServer::setupSocketServer(const RpcSocketAddress& addr) {
Steven Moreland704fc1a2021-05-04 23:13:14 +0000561 LOG_RPC_DETAIL("Setting up socket server %s", addr.toString().c_str());
Yifan Hong0eb5a672021-05-12 18:00:25 -0700562 LOG_ALWAYS_FATAL_IF(hasServer(), "Each RpcServer can only have one server.");
Steven Moreland611d15f2021-05-01 01:28:27 +0000563
Alice Wang0b138ed2022-11-15 16:22:44 +0000564 unique_fd socket_fd(TEMP_FAILURE_RETRY(
565 socket(addr.addr()->sa_family, SOCK_STREAM | SOCK_CLOEXEC | SOCK_NONBLOCK, 0)));
566 if (!socket_fd.ok()) {
Steven Moreland2372f9d2021-08-05 15:42:01 -0700567 int savedErrno = errno;
Steven Moreland8925ebb2023-04-10 21:52:17 +0000568 ALOGE("Could not create socket at %s: %s", addr.toString().c_str(), strerror(savedErrno));
Steven Moreland2372f9d2021-08-05 15:42:01 -0700569 return -savedErrno;
Steven Moreland611d15f2021-05-01 01:28:27 +0000570 }
Tomasz Wasilczyk7c8dd482023-03-23 15:30:03 -0700571
Keith Mok442907b2023-10-11 20:36:18 +0000572 if (addr.addr()->sa_family == AF_INET || addr.addr()->sa_family == AF_INET6) {
573 int noDelay = 1;
574 int result =
575 setsockopt(socket_fd.get(), IPPROTO_TCP, TCP_NODELAY, &noDelay, sizeof(noDelay));
576 if (result < 0) {
577 int savedErrno = errno;
578 ALOGE("Could not set TCP_NODELAY on %s", strerror(savedErrno));
579 return -savedErrno;
580 }
581 }
582
Tomasz Wasilczyk7c8dd482023-03-23 15:30:03 -0700583 {
584 RpcMutexLockGuard _l(mLock);
585 if (mServerSocketModifier != nullptr) {
586 mServerSocketModifier(socket_fd);
587 }
588 }
589
Alice Wang0b138ed2022-11-15 16:22:44 +0000590 if (0 != TEMP_FAILURE_RETRY(bind(socket_fd.get(), addr.addr(), addr.addrSize()))) {
Steven Moreland611d15f2021-05-01 01:28:27 +0000591 int savedErrno = errno;
592 ALOGE("Could not bind socket at %s: %s", addr.toString().c_str(), strerror(savedErrno));
Steven Moreland2372f9d2021-08-05 15:42:01 -0700593 return -savedErrno;
Steven Moreland611d15f2021-05-01 01:28:27 +0000594 }
595
Alice Wang0b138ed2022-11-15 16:22:44 +0000596 return setupRawSocketServer(std::move(socket_fd));
Steven Moreland611d15f2021-05-01 01:28:27 +0000597}
598
Alice Wang0b138ed2022-11-15 16:22:44 +0000599status_t RpcServer::setupRawSocketServer(unique_fd socket_fd) {
Alice Wang30c204d2022-11-15 12:50:51 +0000600 LOG_ALWAYS_FATAL_IF(!socket_fd.ok(), "Socket must be setup to listen.");
Alice Wang30c204d2022-11-15 12:50:51 +0000601
Alice Wang893a9912022-10-24 10:44:09 +0000602 // Right now, we create all threads at once, making accept4 slow. To avoid hanging the client,
603 // the backlog is increased to a large number.
604 // TODO(b/189955605): Once we create threads dynamically & lazily, the backlog can be reduced
605 // to 1.
Alice Wangdf741782022-11-16 08:37:04 +0000606 if (0 != TEMP_FAILURE_RETRY(listen(socket_fd.get(), 50 /*backlog*/))) {
Alice Wang893a9912022-10-24 10:44:09 +0000607 int savedErrno = errno;
608 ALOGE("Could not listen initialized Unix socket: %s", strerror(savedErrno));
609 return -savedErrno;
610 }
Alice Wangdf741782022-11-16 08:37:04 +0000611 if (status_t status = setupExternalServer(std::move(socket_fd)); status != OK) {
Alice Wang893a9912022-10-24 10:44:09 +0000612 ALOGE("Another thread has set up server while calling setupSocketServer. Race?");
613 return status;
614 }
615 return OK;
616}
617
Steven Morelanddd67b942021-07-23 17:15:41 -0700618void RpcServer::onSessionAllIncomingThreadsEnded(const sp<RpcSession>& session) {
Steven Moreland826367f2021-09-10 14:05:31 -0700619 const std::vector<uint8_t>& id = session->mId;
620 LOG_ALWAYS_FATAL_IF(id.empty(), "Server sessions must be initialized with ID");
Tomasz Wasilczyk891f6b02023-10-11 18:35:42 +0000621 LOG_RPC_DETAIL("Dropping session with address %s", HexString(id.data(), id.size()).c_str());
Steven Morelandee78e762021-05-05 21:12:51 +0000622
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000623 RpcMutexLockGuard _l(mLock);
Steven Moreland826367f2021-09-10 14:05:31 -0700624 auto it = mSessions.find(id);
Steven Moreland01a6bad2021-06-11 00:59:20 +0000625 LOG_ALWAYS_FATAL_IF(it == mSessions.end(), "Bad state, unknown session id %s",
Tomasz Wasilczyk891f6b02023-10-11 18:35:42 +0000626 HexString(id.data(), id.size()).c_str());
Steven Moreland01a6bad2021-06-11 00:59:20 +0000627 LOG_ALWAYS_FATAL_IF(it->second != session, "Bad state, session has id mismatch %s",
Tomasz Wasilczyk891f6b02023-10-11 18:35:42 +0000628 HexString(id.data(), id.size()).c_str());
Steven Morelandee78e762021-05-05 21:12:51 +0000629 (void)mSessions.erase(it);
630}
631
Steven Moreland19fc9f72021-06-10 03:57:30 +0000632void RpcServer::onSessionIncomingThreadEnded() {
Steven Morelandee3f4662021-05-22 01:07:33 +0000633 mShutdownCv.notify_all();
634}
635
Yifan Hong0eb5a672021-05-12 18:00:25 -0700636bool RpcServer::hasServer() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000637 RpcMutexLockGuard _l(mLock);
Pawan49d74cb2022-08-03 21:19:11 +0000638 return mServer.fd.ok();
Yifan Hong0eb5a672021-05-12 18:00:25 -0700639}
640
Yifan Hong00aeb762021-05-12 17:07:36 -0700641unique_fd RpcServer::releaseServer() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000642 RpcMutexLockGuard _l(mLock);
Pawan49d74cb2022-08-03 21:19:11 +0000643 return std::move(mServer.fd);
Yifan Hong00aeb762021-05-12 17:07:36 -0700644}
645
David Brazdil21c887c2022-09-23 12:25:18 +0100646status_t RpcServer::setupExternalServer(
647 base::unique_fd serverFd,
648 std::function<status_t(const RpcServer&, RpcTransportFd*)>&& acceptFn) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000649 RpcMutexLockGuard _l(mLock);
Pawan49d74cb2022-08-03 21:19:11 +0000650 if (mServer.fd.ok()) {
Yifan Hong00aeb762021-05-12 17:07:36 -0700651 ALOGE("Each RpcServer can only have one server.");
Steven Moreland2372f9d2021-08-05 15:42:01 -0700652 return INVALID_OPERATION;
Yifan Hong00aeb762021-05-12 17:07:36 -0700653 }
654 mServer = std::move(serverFd);
David Brazdil21c887c2022-09-23 12:25:18 +0100655 mAcceptFn = std::move(acceptFn);
Steven Moreland2372f9d2021-08-05 15:42:01 -0700656 return OK;
Yifan Hong00aeb762021-05-12 17:07:36 -0700657}
658
David Brazdil21c887c2022-09-23 12:25:18 +0100659status_t RpcServer::setupExternalServer(base::unique_fd serverFd) {
660 return setupExternalServer(std::move(serverFd), &RpcServer::acceptSocketConnection);
661}
662
Pawan1c24f9c2022-08-26 23:23:15 +0000663bool RpcServer::hasActiveRequests() {
664 RpcMutexLockGuard _l(mLock);
665 for (const auto& [_, session] : mSessions) {
666 if (session->hasActiveRequests()) {
667 return true;
668 }
669 }
670 return !mServer.isInPollingState();
671}
672
Steven Moreland5553ac42020-11-11 02:14:45 +0000673} // namespace android