blob: 1635e2a3c46e9534dde9715ac0a8c8f01169fe92 [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 Moreland826367f2021-09-10 14:05:31 -070027#include <android-base/hex.h>
Steven Moreland5802c2b2021-05-12 20:13:04 +000028#include <android-base/scopeguard.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>
Andrei Homescu1d935e82022-04-25 04:58:23 +000033#include <utils/Compat.h>
Steven Moreland5553ac42020-11-11 02:14:45 +000034
Andrei Homescuffa3aaa2022-04-07 05:06:33 +000035#include "BuildFlags.h"
Yifan Hong8c950422021-08-05 17:13:55 -070036#include "FdTrigger.h"
Andrei Homescu7c0b79f2022-06-30 02:00:46 +000037#include "OS.h"
Steven Moreland611d15f2021-05-01 01:28:27 +000038#include "RpcSocketAddress.h"
Yifan Hong1a235852021-05-13 16:07:47 -070039#include "RpcState.h"
David Brazdil21c887c2022-09-23 12:25:18 +010040#include "RpcTransportUtils.h"
Steven Moreland5553ac42020-11-11 02:14:45 +000041#include "RpcWireFormat.h"
Andrei Homescuc24c8792022-04-19 00:24:51 +000042#include "Utils.h"
Steven Moreland5553ac42020-11-11 02:14:45 +000043
44namespace android {
45
Steven Morelandc5032042021-09-30 15:40:27 -070046constexpr size_t kSessionIdBytes = 32;
47
Steven Moreland5802c2b2021-05-12 20:13:04 +000048using base::ScopeGuard;
Steven Moreland611d15f2021-05-01 01:28:27 +000049using base::unique_fd;
50
Yifan Hongecf937d2021-08-11 17:29:28 -070051RpcServer::RpcServer(std::unique_ptr<RpcTransportCtx> ctx) : mCtx(std::move(ctx)) {}
Yifan Hong436f0e62021-05-19 15:25:34 -070052RpcServer::~RpcServer() {
David Brazdil4766a1f2022-12-19 21:58:25 +000053 RpcMutexUniqueLock _l(mLock);
54 LOG_ALWAYS_FATAL_IF(mShutdownTrigger != nullptr, "Must call shutdown() before destructor");
Yifan Hong436f0e62021-05-19 15:25:34 -070055}
Steven Moreland5553ac42020-11-11 02:14:45 +000056
Yifan Hong702115c2021-06-24 15:39:18 -070057sp<RpcServer> RpcServer::make(std::unique_ptr<RpcTransportCtxFactory> rpcTransportCtxFactory) {
58 // Default is without TLS.
59 if (rpcTransportCtxFactory == nullptr)
Andrei Homescu024727b2022-08-24 23:54:59 +000060 rpcTransportCtxFactory = makeDefaultRpcTransportCtxFactory();
Yifan Hongecf937d2021-08-11 17:29:28 -070061 auto ctx = rpcTransportCtxFactory->newServerCtx();
62 if (ctx == nullptr) return nullptr;
63 return sp<RpcServer>::make(std::move(ctx));
Steven Moreland5553ac42020-11-11 02:14:45 +000064}
65
David Brazdil21c887c2022-09-23 12:25:18 +010066status_t RpcServer::setupUnixDomainSocketBootstrapServer(unique_fd bootstrapFd) {
67 return setupExternalServer(std::move(bootstrapFd), &RpcServer::recvmsgSocketConnection);
68}
69
Steven Moreland2372f9d2021-08-05 15:42:01 -070070status_t RpcServer::setupUnixDomainServer(const char* path) {
Steven Moreland611d15f2021-05-01 01:28:27 +000071 return setupSocketServer(UnixSocketAddress(path));
72}
73
David Brazdila47dfda2022-11-22 22:52:19 +000074status_t RpcServer::setupVsockServer(unsigned int bindCid, unsigned int port) {
75 return setupSocketServer(VsockSocketAddress(bindCid, port));
Steven Moreland611d15f2021-05-01 01:28:27 +000076}
77
Steven Moreland2372f9d2021-08-05 15:42:01 -070078status_t RpcServer::setupInetServer(const char* address, unsigned int port,
79 unsigned int* assignedPort) {
Steven Moreland611d15f2021-05-01 01:28:27 +000080 if (assignedPort != nullptr) *assignedPort = 0;
Devin Mooref3b9c4f2021-08-03 15:50:13 +000081 auto aiStart = InetSocketAddress::getAddrInfo(address, port);
Steven Moreland2372f9d2021-08-05 15:42:01 -070082 if (aiStart == nullptr) return UNKNOWN_ERROR;
Steven Moreland611d15f2021-05-01 01:28:27 +000083 for (auto ai = aiStart.get(); ai != nullptr; ai = ai->ai_next) {
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 Morelandbf57bce2021-07-26 15:26:12 -0700126void RpcServer::setProtocolVersion(uint32_t version) {
127 mProtocolVersion = version;
128}
129
Frederick Mayle69a0c992022-05-26 20:38:39 +0000130void RpcServer::setSupportedFileDescriptorTransportModes(
131 const std::vector<RpcSession::FileDescriptorTransportMode>& modes) {
132 mSupportedFileDescriptorTransportModes.reset();
133 for (RpcSession::FileDescriptorTransportMode mode : modes) {
134 mSupportedFileDescriptorTransportModes.set(static_cast<size_t>(mode));
135 }
136}
137
Steven Moreland5553ac42020-11-11 02:14:45 +0000138void RpcServer::setRootObject(const sp<IBinder>& binder) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000139 RpcMutexLockGuard _l(mLock);
Steven Moreland51c44a92021-10-14 16:50:35 -0700140 mRootObjectFactory = nullptr;
Yifan Hong4ffb0c72021-05-07 18:35:14 -0700141 mRootObjectWeak = mRootObject = binder;
142}
143
144void RpcServer::setRootObjectWeak(const wp<IBinder>& binder) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000145 RpcMutexLockGuard _l(mLock);
Yifan Hong4ffb0c72021-05-07 18:35:14 -0700146 mRootObject.clear();
Steven Moreland51c44a92021-10-14 16:50:35 -0700147 mRootObjectFactory = nullptr;
Yifan Hong4ffb0c72021-05-07 18:35:14 -0700148 mRootObjectWeak = binder;
Steven Moreland5553ac42020-11-11 02:14:45 +0000149}
Steven Moreland51c44a92021-10-14 16:50:35 -0700150void RpcServer::setPerSessionRootObject(
Andrei Homescu86124ca2022-04-21 22:22:48 +0000151 std::function<sp<IBinder>(const void*, size_t)>&& makeObject) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000152 RpcMutexLockGuard _l(mLock);
Steven Moreland51c44a92021-10-14 16:50:35 -0700153 mRootObject.clear();
154 mRootObjectWeak.clear();
155 mRootObjectFactory = std::move(makeObject);
156}
Steven Moreland5553ac42020-11-11 02:14:45 +0000157
David Brazdila47dfda2022-11-22 22:52:19 +0000158void RpcServer::setConnectionFilter(std::function<bool(const void*, size_t)>&& filter) {
159 RpcMutexLockGuard _l(mLock);
160 LOG_ALWAYS_FATAL_IF(mShutdownTrigger != nullptr, "Already joined");
161 mConnectionFilter = std::move(filter);
162}
163
Tomasz Wasilczyk7c8dd482023-03-23 15:30:03 -0700164void RpcServer::setServerSocketModifier(std::function<void(base::borrowed_fd)>&& modifier) {
165 RpcMutexLockGuard _l(mLock);
166 LOG_ALWAYS_FATAL_IF(mServer.fd != -1, "Already started");
167 mServerSocketModifier = std::move(modifier);
168}
169
Steven Moreland5553ac42020-11-11 02:14:45 +0000170sp<IBinder> RpcServer::getRootObject() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000171 RpcMutexLockGuard _l(mLock);
Yifan Hong4ffb0c72021-05-07 18:35:14 -0700172 bool hasWeak = mRootObjectWeak.unsafe_get();
173 sp<IBinder> ret = mRootObjectWeak.promote();
174 ALOGW_IF(hasWeak && ret == nullptr, "RpcServer root object is freed, returning nullptr");
175 return ret;
Steven Moreland5553ac42020-11-11 02:14:45 +0000176}
177
Yifan Hong9734cfc2021-09-13 16:14:09 -0700178std::vector<uint8_t> RpcServer::getCertificate(RpcCertificateFormat format) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000179 RpcMutexLockGuard _l(mLock);
Yifan Hongecf937d2021-08-11 17:29:28 -0700180 return mCtx->getCertificate(format);
181}
182
Yifan Hong326afd12021-05-19 15:24:54 -0700183static void joinRpcServer(sp<RpcServer>&& thiz) {
184 thiz->join();
185}
186
187void RpcServer::start() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000188 RpcMutexLockGuard _l(mLock);
Yifan Hong326afd12021-05-19 15:24:54 -0700189 LOG_ALWAYS_FATAL_IF(mJoinThread.get(), "Already started!");
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000190 mJoinThread =
191 std::make_unique<RpcMaybeThread>(&joinRpcServer, sp<RpcServer>::fromExisting(this));
192 rpcJoinIfSingleThreaded(*mJoinThread);
Yifan Hong326afd12021-05-19 15:24:54 -0700193}
194
David Brazdil21c887c2022-09-23 12:25:18 +0100195status_t RpcServer::acceptSocketConnection(const RpcServer& server, RpcTransportFd* out) {
196 RpcTransportFd clientSocket(unique_fd(TEMP_FAILURE_RETRY(
197 accept4(server.mServer.fd.get(), nullptr, nullptr, SOCK_CLOEXEC | SOCK_NONBLOCK))));
198 if (clientSocket.fd < 0) {
199 int savedErrno = errno;
200 ALOGE("Could not accept4 socket: %s", strerror(savedErrno));
201 return -savedErrno;
202 }
203
204 *out = std::move(clientSocket);
205 return OK;
206}
207
208status_t RpcServer::recvmsgSocketConnection(const RpcServer& server, RpcTransportFd* out) {
209 int zero = 0;
210 iovec iov{&zero, sizeof(zero)};
211 std::vector<std::variant<base::unique_fd, base::borrowed_fd>> fds;
212
David Brazdil8a741902022-12-17 21:41:04 +0000213 ssize_t num_bytes = receiveMessageFromSocket(server.mServer, &iov, 1, &fds);
214 if (num_bytes < 0) {
David Brazdil21c887c2022-09-23 12:25:18 +0100215 int savedErrno = errno;
216 ALOGE("Failed recvmsg: %s", strerror(savedErrno));
217 return -savedErrno;
218 }
David Brazdil8a741902022-12-17 21:41:04 +0000219 if (num_bytes == 0) {
220 return DEAD_OBJECT;
221 }
David Brazdil21c887c2022-09-23 12:25:18 +0100222 if (fds.size() != 1) {
223 ALOGE("Expected exactly one fd from recvmsg, got %zu", fds.size());
224 return -EINVAL;
225 }
226
227 unique_fd fd(std::move(std::get<unique_fd>(fds.back())));
228 if (auto res = setNonBlocking(fd); !res.ok()) {
229 ALOGE("Failed setNonBlocking: %s", res.error().message().c_str());
230 return res.error().code() == 0 ? UNKNOWN_ERROR : -res.error().code();
231 }
232
233 *out = RpcTransportFd(std::move(fd));
234 return OK;
235}
236
Steven Moreland611d15f2021-05-01 01:28:27 +0000237void RpcServer::join() {
Yifan Hong1a235852021-05-13 16:07:47 -0700238
239 {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000240 RpcMutexLockGuard _l(mLock);
Pawan49d74cb2022-08-03 21:19:11 +0000241 LOG_ALWAYS_FATAL_IF(!mServer.fd.ok(), "RpcServer must be setup to join.");
David Brazdil21c887c2022-09-23 12:25:18 +0100242 LOG_ALWAYS_FATAL_IF(mAcceptFn == nullptr, "RpcServer must have an accept() function");
Yifan Hong1a235852021-05-13 16:07:47 -0700243 LOG_ALWAYS_FATAL_IF(mShutdownTrigger != nullptr, "Already joined");
244 mJoinThreadRunning = true;
Yifan Hong8c950422021-08-05 17:13:55 -0700245 mShutdownTrigger = FdTrigger::make();
Yifan Hong1a235852021-05-13 16:07:47 -0700246 LOG_ALWAYS_FATAL_IF(mShutdownTrigger == nullptr, "Cannot create join signaler");
Steven Morelandd539fbf2021-05-05 23:40:25 +0000247 }
Yifan Hong1a235852021-05-13 16:07:47 -0700248
Steven Moreland2b4f3802021-05-22 01:46:27 +0000249 status_t status;
Steven Moreland798e0d12021-07-14 23:19:25 +0000250 while ((status = mShutdownTrigger->triggerablePoll(mServer, POLLIN)) == OK) {
Andrei Homescu86124ca2022-04-21 22:22:48 +0000251 std::array<uint8_t, kRpcAddressSize> addr;
252 static_assert(addr.size() >= sizeof(sockaddr_storage), "kRpcAddressSize is too small");
Andrei Homescu86124ca2022-04-21 22:22:48 +0000253 socklen_t addrLen = addr.size();
Steven Moreland51c44a92021-10-14 16:50:35 -0700254
David Brazdil21c887c2022-09-23 12:25:18 +0100255 RpcTransportFd clientSocket;
David Brazdil8a741902022-12-17 21:41:04 +0000256 if ((status = mAcceptFn(*this, &clientSocket)) != OK) {
257 if (status == DEAD_OBJECT)
258 break;
259 else
260 continue;
Steven Moreland410325a2021-06-02 18:37:42 +0000261 }
David Brazdila47dfda2022-11-22 22:52:19 +0000262
263 LOG_RPC_DETAIL("accept on fd %d yields fd %d", mServer.fd.get(), clientSocket.fd.get());
264
David Brazdil21c887c2022-09-23 12:25:18 +0100265 if (getpeername(clientSocket.fd.get(), reinterpret_cast<sockaddr*>(addr.data()),
266 &addrLen)) {
267 ALOGE("Could not getpeername socket: %s", strerror(errno));
268 continue;
269 }
270
David Brazdila47dfda2022-11-22 22:52:19 +0000271 if (mConnectionFilter != nullptr && !mConnectionFilter(addr.data(), addrLen)) {
272 ALOGE("Dropped client connection fd %d", clientSocket.fd.get());
273 continue;
274 }
Steven Moreland410325a2021-06-02 18:37:42 +0000275
276 {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000277 RpcMutexLockGuard _l(mLock);
Andrei Homescu74a54452021-12-10 05:30:21 +0000278 RpcMaybeThread thread =
279 RpcMaybeThread(&RpcServer::establishConnection,
Pawan49d74cb2022-08-03 21:19:11 +0000280 sp<RpcServer>::fromExisting(this), std::move(clientSocket), addr,
Andrei Homescu74a54452021-12-10 05:30:21 +0000281 addrLen, RpcSession::join);
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000282
283 auto& threadRef = mConnectingThreads[thread.get_id()];
284 threadRef = std::move(thread);
285 rpcJoinIfSingleThreaded(threadRef);
Steven Moreland410325a2021-06-02 18:37:42 +0000286 }
Yifan Hong1a235852021-05-13 16:07:47 -0700287 }
Steven Moreland2b4f3802021-05-22 01:46:27 +0000288 LOG_RPC_DETAIL("RpcServer::join exiting with %s", statusToString(status).c_str());
Yifan Hong1a235852021-05-13 16:07:47 -0700289
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000290 if constexpr (kEnableRpcThreads) {
291 RpcMutexLockGuard _l(mLock);
Yifan Hong1a235852021-05-13 16:07:47 -0700292 mJoinThreadRunning = false;
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000293 } else {
294 // Multi-threaded builds clear this in shutdown(), but we need it valid
295 // so the loop above exits cleanly
296 mShutdownTrigger = nullptr;
Yifan Hong1a235852021-05-13 16:07:47 -0700297 }
298 mShutdownCv.notify_all();
Steven Morelandd539fbf2021-05-05 23:40:25 +0000299}
300
Yifan Hong1a235852021-05-13 16:07:47 -0700301bool RpcServer::shutdown() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000302 RpcMutexUniqueLock _l(mLock);
Steven Moreland9d11b922021-05-20 01:22:58 +0000303 if (mShutdownTrigger == nullptr) {
Devin Moore06add172023-03-22 22:49:29 +0000304 LOG_RPC_DETAIL("Cannot shutdown. No shutdown trigger installed (already shutdown, or not "
305 "joined yet?)");
Steven Moreland9d11b922021-05-20 01:22:58 +0000306 return false;
307 }
Yifan Hong1a235852021-05-13 16:07:47 -0700308
309 mShutdownTrigger->trigger();
Steven Morelandab3f4422021-09-27 18:38:20 -0700310
Steven Morelanda8b44292021-06-08 01:27:53 +0000311 for (auto& [id, session] : mSessions) {
312 (void)id;
Steven Morelandab3f4422021-09-27 18:38:20 -0700313 // server lock is a more general lock
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000314 RpcMutexLockGuard _lSession(session->mMutex);
Steven Morelanda8b44292021-06-08 01:27:53 +0000315 session->mShutdownTrigger->trigger();
316 }
317
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000318 if constexpr (!kEnableRpcThreads) {
319 // In single-threaded mode we're done here, everything else that
320 // needs to happen should be at the end of RpcServer::join()
321 return true;
322 }
323
Steven Morelandee3f4662021-05-22 01:07:33 +0000324 while (mJoinThreadRunning || !mConnectingThreads.empty() || !mSessions.empty()) {
Steven Morelandaf4ca712021-05-24 23:22:08 +0000325 if (std::cv_status::timeout == mShutdownCv.wait_for(_l, std::chrono::seconds(1))) {
326 ALOGE("Waiting for RpcServer to shut down (1s w/o progress). Join thread running: %d, "
327 "Connecting threads: "
328 "%zu, Sessions: %zu. Is your server deadlocked?",
329 mJoinThreadRunning, mConnectingThreads.size(), mSessions.size());
330 }
Steven Moreland9d11b922021-05-20 01:22:58 +0000331 }
Yifan Hong1a235852021-05-13 16:07:47 -0700332
Yifan Hong326afd12021-05-19 15:24:54 -0700333 // At this point, we know join() is about to exit, but the thread that calls
334 // join() may not have exited yet.
335 // If RpcServer owns the join thread (aka start() is called), make sure the thread exits;
336 // otherwise ~thread() may call std::terminate(), which may crash the process.
337 // If RpcServer does not own the join thread (aka join() is called directly),
338 // then the owner of RpcServer is responsible for cleaning up that thread.
339 if (mJoinThread.get()) {
340 mJoinThread->join();
341 mJoinThread.reset();
342 }
343
Tomasz Wasilczyk7c8dd482023-03-23 15:30:03 -0700344 mServer = RpcTransportFd();
345
Steven Moreland1c943ec2021-07-13 23:57:56 +0000346 LOG_RPC_DETAIL("Finished waiting on shutdown.");
347
Yifan Hong1a235852021-05-13 16:07:47 -0700348 mShutdownTrigger = nullptr;
349 return true;
350}
351
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000352std::vector<sp<RpcSession>> RpcServer::listSessions() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000353 RpcMutexLockGuard _l(mLock);
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000354 std::vector<sp<RpcSession>> sessions;
355 for (auto& [id, session] : mSessions) {
Steven Moreland736664b2021-05-01 04:27:25 +0000356 (void)id;
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000357 sessions.push_back(session);
Steven Moreland736664b2021-05-01 04:27:25 +0000358 }
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000359 return sessions;
Steven Moreland611d15f2021-05-01 01:28:27 +0000360}
361
Steven Morelandd539fbf2021-05-05 23:40:25 +0000362size_t RpcServer::numUninitializedSessions() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000363 RpcMutexLockGuard _l(mLock);
Steven Morelandd539fbf2021-05-05 23:40:25 +0000364 return mConnectingThreads.size();
365}
366
Andrei Homescu74a54452021-12-10 05:30:21 +0000367void RpcServer::establishConnection(
Pawan3e0061c2022-08-26 21:08:34 +0000368 sp<RpcServer>&& server, RpcTransportFd clientFd, std::array<uint8_t, kRpcAddressSize> addr,
Andrei Homescu74a54452021-12-10 05:30:21 +0000369 size_t addrLen,
370 std::function<void(sp<RpcSession>&&, RpcSession::PreJoinSetupResult&&)>&& joinFn) {
Steven Moreland9d11b922021-05-20 01:22:58 +0000371 // mShutdownTrigger can only be cleared once connection threads have joined.
372 // It must be set before this thread is started
373 LOG_ALWAYS_FATAL_IF(server->mShutdownTrigger == nullptr);
Yifan Hong702115c2021-06-24 15:39:18 -0700374 LOG_ALWAYS_FATAL_IF(server->mCtx == nullptr);
375
376 status_t status = OK;
377
Pawan49d74cb2022-08-03 21:19:11 +0000378 int clientFdForLog = clientFd.fd.get();
Yifan Hongf6d42292021-08-05 23:43:05 -0700379 auto client = server->mCtx->newTransport(std::move(clientFd), server->mShutdownTrigger.get());
Yifan Hong702115c2021-06-24 15:39:18 -0700380 if (client == nullptr) {
381 ALOGE("Dropping accept4()-ed socket because sslAccept fails");
382 status = DEAD_OBJECT;
383 // still need to cleanup before we can return
384 } else {
385 LOG_RPC_DETAIL("Created RpcTransport %p for client fd %d", client.get(), clientFdForLog);
386 }
Steven Moreland9d11b922021-05-20 01:22:58 +0000387
Steven Moreland659416d2021-05-11 00:47:50 +0000388 RpcConnectionHeader header;
Yifan Hong702115c2021-06-24 15:39:18 -0700389 if (status == OK) {
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000390 iovec iov{&header, sizeof(header)};
Devin Moore695368f2022-06-03 22:29:14 +0000391 status = client->interruptableReadFully(server->mShutdownTrigger.get(), &iov, 1,
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000392 std::nullopt, /*ancillaryFds=*/nullptr);
Yifan Hong702115c2021-06-24 15:39:18 -0700393 if (status != OK) {
394 ALOGE("Failed to read ID for client connecting to RPC server: %s",
395 statusToString(status).c_str());
396 // still need to cleanup before we can return
397 }
Steven Morelanda63ff932021-05-12 00:03:15 +0000398 }
Steven Morelandbf57bce2021-07-26 15:26:12 -0700399
Steven Moreland826367f2021-09-10 14:05:31 -0700400 std::vector<uint8_t> sessionId;
401 if (status == OK) {
402 if (header.sessionIdSize > 0) {
Steven Morelandc5032042021-09-30 15:40:27 -0700403 if (header.sessionIdSize == kSessionIdBytes) {
404 sessionId.resize(header.sessionIdSize);
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000405 iovec iov{sessionId.data(), sessionId.size()};
Devin Moore695368f2022-06-03 22:29:14 +0000406 status = client->interruptableReadFully(server->mShutdownTrigger.get(), &iov, 1,
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000407 std::nullopt, /*ancillaryFds=*/nullptr);
Steven Morelandc5032042021-09-30 15:40:27 -0700408 if (status != OK) {
409 ALOGE("Failed to read session ID for client connecting to RPC server: %s",
410 statusToString(status).c_str());
411 // still need to cleanup before we can return
412 }
413 } else {
414 ALOGE("Malformed session ID. Expecting session ID of size %zu but got %" PRIu16,
415 kSessionIdBytes, header.sessionIdSize);
416 status = BAD_VALUE;
Steven Moreland826367f2021-09-10 14:05:31 -0700417 }
418 }
419 }
420
Steven Morelandbf57bce2021-07-26 15:26:12 -0700421 bool incoming = false;
422 uint32_t protocolVersion = 0;
Steven Morelandbf57bce2021-07-26 15:26:12 -0700423 bool requestingNewSession = false;
424
425 if (status == OK) {
426 incoming = header.options & RPC_CONNECTION_OPTION_INCOMING;
427 protocolVersion = std::min(header.version,
428 server->mProtocolVersion.value_or(RPC_WIRE_PROTOCOL_VERSION));
Steven Moreland826367f2021-09-10 14:05:31 -0700429 requestingNewSession = sessionId.empty();
Steven Morelandbf57bce2021-07-26 15:26:12 -0700430
431 if (requestingNewSession) {
432 RpcNewSessionResponse response{
433 .version = protocolVersion,
434 };
435
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000436 iovec iov{&response, sizeof(response)};
Devin Moore695368f2022-06-03 22:29:14 +0000437 status = client->interruptableWriteFully(server->mShutdownTrigger.get(), &iov, 1,
Frederick Mayle69a0c992022-05-26 20:38:39 +0000438 std::nullopt, nullptr);
Steven Morelandbf57bce2021-07-26 15:26:12 -0700439 if (status != OK) {
440 ALOGE("Failed to send new session response: %s", statusToString(status).c_str());
441 // still need to cleanup before we can return
442 }
443 }
444 }
Steven Morelanda63ff932021-05-12 00:03:15 +0000445
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000446 RpcMaybeThread thisThread;
Steven Morelanda63ff932021-05-12 00:03:15 +0000447 sp<RpcSession> session;
448 {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000449 RpcMutexUniqueLock _l(server->mLock);
Steven Morelanda63ff932021-05-12 00:03:15 +0000450
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000451 auto threadId = server->mConnectingThreads.find(rpc_this_thread::get_id());
Yifan Hongb3005502021-05-19 15:37:00 -0700452 LOG_ALWAYS_FATAL_IF(threadId == server->mConnectingThreads.end(),
Steven Morelanda63ff932021-05-12 00:03:15 +0000453 "Must establish connection on owned thread");
454 thisThread = std::move(threadId->second);
Steven Morelandadc5dca2021-05-25 02:06:03 +0000455 ScopeGuard detachGuard = [&]() {
456 thisThread.detach();
Steven Moreland9d11b922021-05-20 01:22:58 +0000457 _l.unlock();
458 server->mShutdownCv.notify_all();
459 };
Steven Morelandadc5dca2021-05-25 02:06:03 +0000460 server->mConnectingThreads.erase(threadId);
Steven Moreland9d11b922021-05-20 01:22:58 +0000461
Steven Morelandbf57bce2021-07-26 15:26:12 -0700462 if (status != OK || server->mShutdownTrigger->isTriggered()) {
Steven Moreland5802c2b2021-05-12 20:13:04 +0000463 return;
464 }
465
Steven Morelandbf57bce2021-07-26 15:26:12 -0700466 if (requestingNewSession) {
Steven Moreland1b304292021-07-15 22:59:34 +0000467 if (incoming) {
468 ALOGE("Cannot create a new session with an incoming connection, would leak");
Steven Moreland659416d2021-05-11 00:47:50 +0000469 return;
470 }
471
Steven Moreland826367f2021-09-10 14:05:31 -0700472 // Uniquely identify session at the application layer. Even if a
473 // client/server use the same certificates, if they create multiple
474 // sessions, we still want to distinguish between them.
Steven Morelandc5032042021-09-30 15:40:27 -0700475 sessionId.resize(kSessionIdBytes);
Steven Moreland01a6bad2021-06-11 00:59:20 +0000476 size_t tries = 0;
477 do {
478 // don't block if there is some entropy issue
479 if (tries++ > 5) {
Steven Moreland826367f2021-09-10 14:05:31 -0700480 ALOGE("Cannot find new address: %s",
481 base::HexString(sessionId.data(), sessionId.size()).c_str());
Steven Moreland01a6bad2021-06-11 00:59:20 +0000482 return;
483 }
484
Andrei Homescuc24c8792022-04-19 00:24:51 +0000485 auto status = getRandomBytes(sessionId.data(), sessionId.size());
486 if (status != OK) {
487 ALOGE("Failed to read random session ID: %s", strerror(-status));
Steven Moreland826367f2021-09-10 14:05:31 -0700488 return;
489 }
Steven Moreland01a6bad2021-06-11 00:59:20 +0000490 } while (server->mSessions.end() != server->mSessions.find(sessionId));
Steven Morelanda63ff932021-05-12 00:03:15 +0000491
Andrei Homescu5e301462022-05-12 00:52:34 +0000492 session = sp<RpcSession>::make(nullptr);
Yifan Hong10423062021-10-08 16:26:32 -0700493 session->setMaxIncomingThreads(server->mMaxThreads);
Steven Morelandbf57bce2021-07-26 15:26:12 -0700494 if (!session->setProtocolVersion(protocolVersion)) return;
Steven Moreland51c44a92021-10-14 16:50:35 -0700495
Frederick Mayle26b494e2022-07-08 22:09:58 +0000496 if (header.fileDescriptorTransportMode <
497 server->mSupportedFileDescriptorTransportModes.size() &&
498 server->mSupportedFileDescriptorTransportModes.test(
Frederick Mayle69a0c992022-05-26 20:38:39 +0000499 header.fileDescriptorTransportMode)) {
500 session->setFileDescriptorTransportMode(
501 static_cast<RpcSession::FileDescriptorTransportMode>(
502 header.fileDescriptorTransportMode));
503 } else {
504 ALOGE("Rejecting connection: FileDescriptorTransportMode is not supported: %hhu",
505 header.fileDescriptorTransportMode);
506 return;
507 }
508
Steven Moreland51c44a92021-10-14 16:50:35 -0700509 // if null, falls back to server root
510 sp<IBinder> sessionSpecificRoot;
511 if (server->mRootObjectFactory != nullptr) {
Andrei Homescu86124ca2022-04-21 22:22:48 +0000512 sessionSpecificRoot = server->mRootObjectFactory(addr.data(), addrLen);
Steven Moreland51c44a92021-10-14 16:50:35 -0700513 if (sessionSpecificRoot == nullptr) {
514 ALOGE("Warning: server returned null from root object factory");
515 }
516 }
517
Steven Morelanda8b44292021-06-08 01:27:53 +0000518 if (!session->setForServer(server,
519 sp<RpcServer::EventListener>::fromExisting(
520 static_cast<RpcServer::EventListener*>(
521 server.get())),
Steven Moreland51c44a92021-10-14 16:50:35 -0700522 sessionId, sessionSpecificRoot)) {
Steven Morelanda8b44292021-06-08 01:27:53 +0000523 ALOGE("Failed to attach server to session");
524 return;
525 }
Steven Morelanda63ff932021-05-12 00:03:15 +0000526
Steven Moreland01a6bad2021-06-11 00:59:20 +0000527 server->mSessions[sessionId] = session;
Steven Morelanda63ff932021-05-12 00:03:15 +0000528 } else {
Steven Moreland01a6bad2021-06-11 00:59:20 +0000529 auto it = server->mSessions.find(sessionId);
Yifan Hongb3005502021-05-19 15:37:00 -0700530 if (it == server->mSessions.end()) {
Steven Moreland01a6bad2021-06-11 00:59:20 +0000531 ALOGE("Cannot add thread, no record of session with ID %s",
Steven Moreland826367f2021-09-10 14:05:31 -0700532 base::HexString(sessionId.data(), sessionId.size()).c_str());
Steven Morelanda63ff932021-05-12 00:03:15 +0000533 return;
534 }
535 session = it->second;
536 }
Steven Moreland5802c2b2021-05-12 20:13:04 +0000537
Steven Moreland1b304292021-07-15 22:59:34 +0000538 if (incoming) {
Steven Moreland2372f9d2021-08-05 15:42:01 -0700539 LOG_ALWAYS_FATAL_IF(OK != session->addOutgoingConnection(std::move(client), true),
Steven Moreland659416d2021-05-11 00:47:50 +0000540 "server state must already be initialized");
541 return;
542 }
543
Steven Moreland5802c2b2021-05-12 20:13:04 +0000544 detachGuard.Disable();
Steven Morelandc88b7fc2021-06-10 00:40:39 +0000545 session->preJoinThreadOwnership(std::move(thisThread));
Steven Morelanda63ff932021-05-12 00:03:15 +0000546 }
547
Yifan Hong702115c2021-06-24 15:39:18 -0700548 auto setupResult = session->preJoinSetup(std::move(client));
Steven Morelandc88b7fc2021-06-10 00:40:39 +0000549
Steven Morelanda63ff932021-05-12 00:03:15 +0000550 // avoid strong cycle
551 server = nullptr;
Steven Morelanda63ff932021-05-12 00:03:15 +0000552
Andrei Homescu74a54452021-12-10 05:30:21 +0000553 joinFn(std::move(session), std::move(setupResult));
Steven Morelanda63ff932021-05-12 00:03:15 +0000554}
555
Steven Moreland2372f9d2021-08-05 15:42:01 -0700556status_t RpcServer::setupSocketServer(const RpcSocketAddress& addr) {
Steven Moreland704fc1a2021-05-04 23:13:14 +0000557 LOG_RPC_DETAIL("Setting up socket server %s", addr.toString().c_str());
Yifan Hong0eb5a672021-05-12 18:00:25 -0700558 LOG_ALWAYS_FATAL_IF(hasServer(), "Each RpcServer can only have one server.");
Steven Moreland611d15f2021-05-01 01:28:27 +0000559
Alice Wang0b138ed2022-11-15 16:22:44 +0000560 unique_fd socket_fd(TEMP_FAILURE_RETRY(
561 socket(addr.addr()->sa_family, SOCK_STREAM | SOCK_CLOEXEC | SOCK_NONBLOCK, 0)));
562 if (!socket_fd.ok()) {
Steven Moreland2372f9d2021-08-05 15:42:01 -0700563 int savedErrno = errno;
Steven Moreland8925ebb2023-04-10 21:52:17 +0000564 ALOGE("Could not create socket at %s: %s", addr.toString().c_str(), strerror(savedErrno));
Steven Moreland2372f9d2021-08-05 15:42:01 -0700565 return -savedErrno;
Steven Moreland611d15f2021-05-01 01:28:27 +0000566 }
Tomasz Wasilczyk7c8dd482023-03-23 15:30:03 -0700567
568 {
569 RpcMutexLockGuard _l(mLock);
570 if (mServerSocketModifier != nullptr) {
571 mServerSocketModifier(socket_fd);
572 }
573 }
574
Alice Wang0b138ed2022-11-15 16:22:44 +0000575 if (0 != TEMP_FAILURE_RETRY(bind(socket_fd.get(), addr.addr(), addr.addrSize()))) {
Steven Moreland611d15f2021-05-01 01:28:27 +0000576 int savedErrno = errno;
577 ALOGE("Could not bind socket at %s: %s", addr.toString().c_str(), strerror(savedErrno));
Steven Moreland2372f9d2021-08-05 15:42:01 -0700578 return -savedErrno;
Steven Moreland611d15f2021-05-01 01:28:27 +0000579 }
580
Alice Wang0b138ed2022-11-15 16:22:44 +0000581 return setupRawSocketServer(std::move(socket_fd));
Steven Moreland611d15f2021-05-01 01:28:27 +0000582}
583
Alice Wang0b138ed2022-11-15 16:22:44 +0000584status_t RpcServer::setupRawSocketServer(unique_fd socket_fd) {
Alice Wang30c204d2022-11-15 12:50:51 +0000585 LOG_ALWAYS_FATAL_IF(!socket_fd.ok(), "Socket must be setup to listen.");
Alice Wang30c204d2022-11-15 12:50:51 +0000586
Alice Wang893a9912022-10-24 10:44:09 +0000587 // Right now, we create all threads at once, making accept4 slow. To avoid hanging the client,
588 // the backlog is increased to a large number.
589 // TODO(b/189955605): Once we create threads dynamically & lazily, the backlog can be reduced
590 // to 1.
Alice Wangdf741782022-11-16 08:37:04 +0000591 if (0 != TEMP_FAILURE_RETRY(listen(socket_fd.get(), 50 /*backlog*/))) {
Alice Wang893a9912022-10-24 10:44:09 +0000592 int savedErrno = errno;
593 ALOGE("Could not listen initialized Unix socket: %s", strerror(savedErrno));
594 return -savedErrno;
595 }
Alice Wangdf741782022-11-16 08:37:04 +0000596 if (status_t status = setupExternalServer(std::move(socket_fd)); status != OK) {
Alice Wang893a9912022-10-24 10:44:09 +0000597 ALOGE("Another thread has set up server while calling setupSocketServer. Race?");
598 return status;
599 }
600 return OK;
601}
602
Steven Morelanddd67b942021-07-23 17:15:41 -0700603void RpcServer::onSessionAllIncomingThreadsEnded(const sp<RpcSession>& session) {
Steven Moreland826367f2021-09-10 14:05:31 -0700604 const std::vector<uint8_t>& id = session->mId;
605 LOG_ALWAYS_FATAL_IF(id.empty(), "Server sessions must be initialized with ID");
606 LOG_RPC_DETAIL("Dropping session with address %s",
607 base::HexString(id.data(), id.size()).c_str());
Steven Morelandee78e762021-05-05 21:12:51 +0000608
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000609 RpcMutexLockGuard _l(mLock);
Steven Moreland826367f2021-09-10 14:05:31 -0700610 auto it = mSessions.find(id);
Steven Moreland01a6bad2021-06-11 00:59:20 +0000611 LOG_ALWAYS_FATAL_IF(it == mSessions.end(), "Bad state, unknown session id %s",
Steven Moreland826367f2021-09-10 14:05:31 -0700612 base::HexString(id.data(), id.size()).c_str());
Steven Moreland01a6bad2021-06-11 00:59:20 +0000613 LOG_ALWAYS_FATAL_IF(it->second != session, "Bad state, session has id mismatch %s",
Steven Moreland826367f2021-09-10 14:05:31 -0700614 base::HexString(id.data(), id.size()).c_str());
Steven Morelandee78e762021-05-05 21:12:51 +0000615 (void)mSessions.erase(it);
616}
617
Steven Moreland19fc9f72021-06-10 03:57:30 +0000618void RpcServer::onSessionIncomingThreadEnded() {
Steven Morelandee3f4662021-05-22 01:07:33 +0000619 mShutdownCv.notify_all();
620}
621
Yifan Hong0eb5a672021-05-12 18:00:25 -0700622bool RpcServer::hasServer() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000623 RpcMutexLockGuard _l(mLock);
Pawan49d74cb2022-08-03 21:19:11 +0000624 return mServer.fd.ok();
Yifan Hong0eb5a672021-05-12 18:00:25 -0700625}
626
Yifan Hong00aeb762021-05-12 17:07:36 -0700627unique_fd RpcServer::releaseServer() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000628 RpcMutexLockGuard _l(mLock);
Pawan49d74cb2022-08-03 21:19:11 +0000629 return std::move(mServer.fd);
Yifan Hong00aeb762021-05-12 17:07:36 -0700630}
631
David Brazdil21c887c2022-09-23 12:25:18 +0100632status_t RpcServer::setupExternalServer(
633 base::unique_fd serverFd,
634 std::function<status_t(const RpcServer&, RpcTransportFd*)>&& acceptFn) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000635 RpcMutexLockGuard _l(mLock);
Pawan49d74cb2022-08-03 21:19:11 +0000636 if (mServer.fd.ok()) {
Yifan Hong00aeb762021-05-12 17:07:36 -0700637 ALOGE("Each RpcServer can only have one server.");
Steven Moreland2372f9d2021-08-05 15:42:01 -0700638 return INVALID_OPERATION;
Yifan Hong00aeb762021-05-12 17:07:36 -0700639 }
640 mServer = std::move(serverFd);
David Brazdil21c887c2022-09-23 12:25:18 +0100641 mAcceptFn = std::move(acceptFn);
Steven Moreland2372f9d2021-08-05 15:42:01 -0700642 return OK;
Yifan Hong00aeb762021-05-12 17:07:36 -0700643}
644
David Brazdil21c887c2022-09-23 12:25:18 +0100645status_t RpcServer::setupExternalServer(base::unique_fd serverFd) {
646 return setupExternalServer(std::move(serverFd), &RpcServer::acceptSocketConnection);
647}
648
Pawan1c24f9c2022-08-26 23:23:15 +0000649bool RpcServer::hasActiveRequests() {
650 RpcMutexLockGuard _l(mLock);
651 for (const auto& [_, session] : mSessions) {
652 if (session->hasActiveRequests()) {
653 return true;
654 }
655 }
656 return !mServer.isInPollingState();
657}
658
Steven Moreland5553ac42020-11-11 02:14:45 +0000659} // namespace android