blob: 354a4b329407b7a2650334111a80d24733dedcb1 [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)
Tomasz Wasilczyk0d9dec22023-10-06 20:28:49 +000060 rpcTransportCtxFactory = binder::os::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) {
zijunzhaoa2013362023-05-11 21:27:19 +000084 if (ai->ai_addr == nullptr) continue;
Devin Mooref3b9c4f2021-08-03 15:50:13 +000085 InetSocketAddress socketAddress(ai->ai_addr, ai->ai_addrlen, address, port);
Steven Moreland2372f9d2021-08-05 15:42:01 -070086 if (status_t status = setupSocketServer(socketAddress); status != OK) {
Steven Moreland611d15f2021-05-01 01:28:27 +000087 continue;
88 }
89
90 LOG_ALWAYS_FATAL_IF(socketAddress.addr()->sa_family != AF_INET, "expecting inet");
91 sockaddr_in addr{};
92 socklen_t len = sizeof(addr);
Pawan49d74cb2022-08-03 21:19:11 +000093 if (0 != getsockname(mServer.fd.get(), reinterpret_cast<sockaddr*>(&addr), &len)) {
Steven Moreland611d15f2021-05-01 01:28:27 +000094 int savedErrno = errno;
95 ALOGE("Could not getsockname at %s: %s", socketAddress.toString().c_str(),
96 strerror(savedErrno));
Steven Moreland2372f9d2021-08-05 15:42:01 -070097 return -savedErrno;
Steven Moreland611d15f2021-05-01 01:28:27 +000098 }
99 LOG_ALWAYS_FATAL_IF(len != sizeof(addr), "Wrong socket type: len %zu vs len %zu",
100 static_cast<size_t>(len), sizeof(addr));
101 unsigned int realPort = ntohs(addr.sin_port);
102 LOG_ALWAYS_FATAL_IF(port != 0 && realPort != port,
103 "Requesting inet server on %s but it is set up on %u.",
104 socketAddress.toString().c_str(), realPort);
105
106 if (assignedPort != nullptr) {
107 *assignedPort = realPort;
108 }
109
Steven Moreland2372f9d2021-08-05 15:42:01 -0700110 return OK;
Steven Moreland611d15f2021-05-01 01:28:27 +0000111 }
Devin Mooref3b9c4f2021-08-03 15:50:13 +0000112 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 +0000113 port);
Steven Moreland2372f9d2021-08-05 15:42:01 -0700114 return UNKNOWN_ERROR;
Steven Moreland611d15f2021-05-01 01:28:27 +0000115}
116
Steven Morelandf137de92021-04-24 01:54:26 +0000117void RpcServer::setMaxThreads(size_t threads) {
118 LOG_ALWAYS_FATAL_IF(threads <= 0, "RpcServer is useless without threads");
Yifan Hong1a235852021-05-13 16:07:47 -0700119 LOG_ALWAYS_FATAL_IF(mJoinThreadRunning, "Cannot set max threads while running");
Steven Morelandf137de92021-04-24 01:54:26 +0000120 mMaxThreads = threads;
121}
122
123size_t RpcServer::getMaxThreads() {
124 return mMaxThreads;
Steven Moreland5553ac42020-11-11 02:14:45 +0000125}
126
Steven Morelandca3f6382023-05-11 23:23:26 +0000127bool RpcServer::setProtocolVersion(uint32_t version) {
128 if (!RpcState::validateProtocolVersion(version)) {
129 return false;
130 }
131
Steven Morelandbf57bce2021-07-26 15:26:12 -0700132 mProtocolVersion = version;
Steven Morelandca3f6382023-05-11 23:23:26 +0000133 return true;
Steven Morelandbf57bce2021-07-26 15:26:12 -0700134}
135
Frederick Mayle69a0c992022-05-26 20:38:39 +0000136void RpcServer::setSupportedFileDescriptorTransportModes(
137 const std::vector<RpcSession::FileDescriptorTransportMode>& modes) {
138 mSupportedFileDescriptorTransportModes.reset();
139 for (RpcSession::FileDescriptorTransportMode mode : modes) {
140 mSupportedFileDescriptorTransportModes.set(static_cast<size_t>(mode));
141 }
142}
143
Steven Moreland5553ac42020-11-11 02:14:45 +0000144void RpcServer::setRootObject(const sp<IBinder>& binder) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000145 RpcMutexLockGuard _l(mLock);
Steven Moreland51c44a92021-10-14 16:50:35 -0700146 mRootObjectFactory = nullptr;
Yifan Hong4ffb0c72021-05-07 18:35:14 -0700147 mRootObjectWeak = mRootObject = binder;
148}
149
150void RpcServer::setRootObjectWeak(const wp<IBinder>& binder) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000151 RpcMutexLockGuard _l(mLock);
Yifan Hong4ffb0c72021-05-07 18:35:14 -0700152 mRootObject.clear();
Steven Moreland51c44a92021-10-14 16:50:35 -0700153 mRootObjectFactory = nullptr;
Yifan Hong4ffb0c72021-05-07 18:35:14 -0700154 mRootObjectWeak = binder;
Steven Moreland5553ac42020-11-11 02:14:45 +0000155}
Steven Moreland51c44a92021-10-14 16:50:35 -0700156void RpcServer::setPerSessionRootObject(
Steven Morelanddfb92182023-05-24 17:48:59 +0000157 std::function<sp<IBinder>(wp<RpcSession> session, const void*, size_t)>&& makeObject) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000158 RpcMutexLockGuard _l(mLock);
Steven Moreland51c44a92021-10-14 16:50:35 -0700159 mRootObject.clear();
160 mRootObjectWeak.clear();
161 mRootObjectFactory = std::move(makeObject);
162}
Steven Moreland5553ac42020-11-11 02:14:45 +0000163
David Brazdila47dfda2022-11-22 22:52:19 +0000164void RpcServer::setConnectionFilter(std::function<bool(const void*, size_t)>&& filter) {
165 RpcMutexLockGuard _l(mLock);
166 LOG_ALWAYS_FATAL_IF(mShutdownTrigger != nullptr, "Already joined");
167 mConnectionFilter = std::move(filter);
168}
169
Tomasz Wasilczyk7c8dd482023-03-23 15:30:03 -0700170void RpcServer::setServerSocketModifier(std::function<void(base::borrowed_fd)>&& modifier) {
171 RpcMutexLockGuard _l(mLock);
172 LOG_ALWAYS_FATAL_IF(mServer.fd != -1, "Already started");
173 mServerSocketModifier = std::move(modifier);
174}
175
Steven Moreland5553ac42020-11-11 02:14:45 +0000176sp<IBinder> RpcServer::getRootObject() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000177 RpcMutexLockGuard _l(mLock);
Yifan Hong4ffb0c72021-05-07 18:35:14 -0700178 bool hasWeak = mRootObjectWeak.unsafe_get();
179 sp<IBinder> ret = mRootObjectWeak.promote();
180 ALOGW_IF(hasWeak && ret == nullptr, "RpcServer root object is freed, returning nullptr");
181 return ret;
Steven Moreland5553ac42020-11-11 02:14:45 +0000182}
183
Yifan Hong9734cfc2021-09-13 16:14:09 -0700184std::vector<uint8_t> RpcServer::getCertificate(RpcCertificateFormat format) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000185 RpcMutexLockGuard _l(mLock);
Yifan Hongecf937d2021-08-11 17:29:28 -0700186 return mCtx->getCertificate(format);
187}
188
Yifan Hong326afd12021-05-19 15:24:54 -0700189static void joinRpcServer(sp<RpcServer>&& thiz) {
190 thiz->join();
191}
192
193void RpcServer::start() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000194 RpcMutexLockGuard _l(mLock);
Yifan Hong326afd12021-05-19 15:24:54 -0700195 LOG_ALWAYS_FATAL_IF(mJoinThread.get(), "Already started!");
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000196 mJoinThread =
197 std::make_unique<RpcMaybeThread>(&joinRpcServer, sp<RpcServer>::fromExisting(this));
198 rpcJoinIfSingleThreaded(*mJoinThread);
Yifan Hong326afd12021-05-19 15:24:54 -0700199}
200
David Brazdil21c887c2022-09-23 12:25:18 +0100201status_t RpcServer::acceptSocketConnection(const RpcServer& server, RpcTransportFd* out) {
202 RpcTransportFd clientSocket(unique_fd(TEMP_FAILURE_RETRY(
203 accept4(server.mServer.fd.get(), nullptr, nullptr, SOCK_CLOEXEC | SOCK_NONBLOCK))));
204 if (clientSocket.fd < 0) {
205 int savedErrno = errno;
206 ALOGE("Could not accept4 socket: %s", strerror(savedErrno));
207 return -savedErrno;
208 }
209
210 *out = std::move(clientSocket);
211 return OK;
212}
213
214status_t RpcServer::recvmsgSocketConnection(const RpcServer& server, RpcTransportFd* out) {
215 int zero = 0;
216 iovec iov{&zero, sizeof(zero)};
217 std::vector<std::variant<base::unique_fd, base::borrowed_fd>> fds;
218
Tomasz Wasilczyk0d9dec22023-10-06 20:28:49 +0000219 ssize_t num_bytes = binder::os::receiveMessageFromSocket(server.mServer, &iov, 1, &fds);
David Brazdil8a741902022-12-17 21:41:04 +0000220 if (num_bytes < 0) {
David Brazdil21c887c2022-09-23 12:25:18 +0100221 int savedErrno = errno;
222 ALOGE("Failed recvmsg: %s", strerror(savedErrno));
223 return -savedErrno;
224 }
David Brazdil8a741902022-12-17 21:41:04 +0000225 if (num_bytes == 0) {
226 return DEAD_OBJECT;
227 }
David Brazdil21c887c2022-09-23 12:25:18 +0100228 if (fds.size() != 1) {
229 ALOGE("Expected exactly one fd from recvmsg, got %zu", fds.size());
230 return -EINVAL;
231 }
232
233 unique_fd fd(std::move(std::get<unique_fd>(fds.back())));
Tomasz Wasilczyk0d9dec22023-10-06 20:28:49 +0000234 if (auto res = binder::os::setNonBlocking(fd); !res.ok()) {
David Brazdil21c887c2022-09-23 12:25:18 +0100235 ALOGE("Failed setNonBlocking: %s", res.error().message().c_str());
236 return res.error().code() == 0 ? UNKNOWN_ERROR : -res.error().code();
237 }
238
239 *out = RpcTransportFd(std::move(fd));
240 return OK;
241}
242
Steven Moreland611d15f2021-05-01 01:28:27 +0000243void RpcServer::join() {
Yifan Hong1a235852021-05-13 16:07:47 -0700244
245 {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000246 RpcMutexLockGuard _l(mLock);
Pawan49d74cb2022-08-03 21:19:11 +0000247 LOG_ALWAYS_FATAL_IF(!mServer.fd.ok(), "RpcServer must be setup to join.");
David Brazdil21c887c2022-09-23 12:25:18 +0100248 LOG_ALWAYS_FATAL_IF(mAcceptFn == nullptr, "RpcServer must have an accept() function");
Yifan Hong1a235852021-05-13 16:07:47 -0700249 LOG_ALWAYS_FATAL_IF(mShutdownTrigger != nullptr, "Already joined");
250 mJoinThreadRunning = true;
Yifan Hong8c950422021-08-05 17:13:55 -0700251 mShutdownTrigger = FdTrigger::make();
Yifan Hong1a235852021-05-13 16:07:47 -0700252 LOG_ALWAYS_FATAL_IF(mShutdownTrigger == nullptr, "Cannot create join signaler");
Steven Morelandd539fbf2021-05-05 23:40:25 +0000253 }
Yifan Hong1a235852021-05-13 16:07:47 -0700254
Steven Moreland2b4f3802021-05-22 01:46:27 +0000255 status_t status;
Steven Moreland798e0d12021-07-14 23:19:25 +0000256 while ((status = mShutdownTrigger->triggerablePoll(mServer, POLLIN)) == OK) {
Andrei Homescu86124ca2022-04-21 22:22:48 +0000257 std::array<uint8_t, kRpcAddressSize> addr;
258 static_assert(addr.size() >= sizeof(sockaddr_storage), "kRpcAddressSize is too small");
Andrei Homescu86124ca2022-04-21 22:22:48 +0000259 socklen_t addrLen = addr.size();
Steven Moreland51c44a92021-10-14 16:50:35 -0700260
David Brazdil21c887c2022-09-23 12:25:18 +0100261 RpcTransportFd clientSocket;
David Brazdil8a741902022-12-17 21:41:04 +0000262 if ((status = mAcceptFn(*this, &clientSocket)) != OK) {
263 if (status == DEAD_OBJECT)
264 break;
265 else
266 continue;
Steven Moreland410325a2021-06-02 18:37:42 +0000267 }
David Brazdila47dfda2022-11-22 22:52:19 +0000268
269 LOG_RPC_DETAIL("accept on fd %d yields fd %d", mServer.fd.get(), clientSocket.fd.get());
270
David Brazdil21c887c2022-09-23 12:25:18 +0100271 if (getpeername(clientSocket.fd.get(), reinterpret_cast<sockaddr*>(addr.data()),
272 &addrLen)) {
273 ALOGE("Could not getpeername socket: %s", strerror(errno));
274 continue;
275 }
276
David Brazdila47dfda2022-11-22 22:52:19 +0000277 if (mConnectionFilter != nullptr && !mConnectionFilter(addr.data(), addrLen)) {
278 ALOGE("Dropped client connection fd %d", clientSocket.fd.get());
279 continue;
280 }
Steven Moreland410325a2021-06-02 18:37:42 +0000281
282 {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000283 RpcMutexLockGuard _l(mLock);
Andrei Homescu74a54452021-12-10 05:30:21 +0000284 RpcMaybeThread thread =
285 RpcMaybeThread(&RpcServer::establishConnection,
Pawan49d74cb2022-08-03 21:19:11 +0000286 sp<RpcServer>::fromExisting(this), std::move(clientSocket), addr,
Andrei Homescu74a54452021-12-10 05:30:21 +0000287 addrLen, RpcSession::join);
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000288
289 auto& threadRef = mConnectingThreads[thread.get_id()];
290 threadRef = std::move(thread);
291 rpcJoinIfSingleThreaded(threadRef);
Steven Moreland410325a2021-06-02 18:37:42 +0000292 }
Yifan Hong1a235852021-05-13 16:07:47 -0700293 }
Steven Moreland2b4f3802021-05-22 01:46:27 +0000294 LOG_RPC_DETAIL("RpcServer::join exiting with %s", statusToString(status).c_str());
Yifan Hong1a235852021-05-13 16:07:47 -0700295
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000296 if constexpr (kEnableRpcThreads) {
297 RpcMutexLockGuard _l(mLock);
Yifan Hong1a235852021-05-13 16:07:47 -0700298 mJoinThreadRunning = false;
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000299 } else {
300 // Multi-threaded builds clear this in shutdown(), but we need it valid
301 // so the loop above exits cleanly
302 mShutdownTrigger = nullptr;
Yifan Hong1a235852021-05-13 16:07:47 -0700303 }
304 mShutdownCv.notify_all();
Steven Morelandd539fbf2021-05-05 23:40:25 +0000305}
306
Yifan Hong1a235852021-05-13 16:07:47 -0700307bool RpcServer::shutdown() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000308 RpcMutexUniqueLock _l(mLock);
Steven Moreland9d11b922021-05-20 01:22:58 +0000309 if (mShutdownTrigger == nullptr) {
Devin Moore06add172023-03-22 22:49:29 +0000310 LOG_RPC_DETAIL("Cannot shutdown. No shutdown trigger installed (already shutdown, or not "
311 "joined yet?)");
Steven Moreland9d11b922021-05-20 01:22:58 +0000312 return false;
313 }
Yifan Hong1a235852021-05-13 16:07:47 -0700314
315 mShutdownTrigger->trigger();
Steven Morelandab3f4422021-09-27 18:38:20 -0700316
Steven Morelanda8b44292021-06-08 01:27:53 +0000317 for (auto& [id, session] : mSessions) {
318 (void)id;
Steven Morelandab3f4422021-09-27 18:38:20 -0700319 // server lock is a more general lock
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000320 RpcMutexLockGuard _lSession(session->mMutex);
Steven Morelanda8b44292021-06-08 01:27:53 +0000321 session->mShutdownTrigger->trigger();
322 }
323
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000324 if constexpr (!kEnableRpcThreads) {
325 // In single-threaded mode we're done here, everything else that
326 // needs to happen should be at the end of RpcServer::join()
327 return true;
328 }
329
Steven Morelandee3f4662021-05-22 01:07:33 +0000330 while (mJoinThreadRunning || !mConnectingThreads.empty() || !mSessions.empty()) {
Steven Morelandaf4ca712021-05-24 23:22:08 +0000331 if (std::cv_status::timeout == mShutdownCv.wait_for(_l, std::chrono::seconds(1))) {
332 ALOGE("Waiting for RpcServer to shut down (1s w/o progress). Join thread running: %d, "
333 "Connecting threads: "
334 "%zu, Sessions: %zu. Is your server deadlocked?",
335 mJoinThreadRunning, mConnectingThreads.size(), mSessions.size());
336 }
Steven Moreland9d11b922021-05-20 01:22:58 +0000337 }
Yifan Hong1a235852021-05-13 16:07:47 -0700338
Yifan Hong326afd12021-05-19 15:24:54 -0700339 // At this point, we know join() is about to exit, but the thread that calls
340 // join() may not have exited yet.
341 // If RpcServer owns the join thread (aka start() is called), make sure the thread exits;
342 // otherwise ~thread() may call std::terminate(), which may crash the process.
343 // If RpcServer does not own the join thread (aka join() is called directly),
344 // then the owner of RpcServer is responsible for cleaning up that thread.
345 if (mJoinThread.get()) {
346 mJoinThread->join();
347 mJoinThread.reset();
348 }
349
Tomasz Wasilczyk7c8dd482023-03-23 15:30:03 -0700350 mServer = RpcTransportFd();
351
Steven Moreland1c943ec2021-07-13 23:57:56 +0000352 LOG_RPC_DETAIL("Finished waiting on shutdown.");
353
Yifan Hong1a235852021-05-13 16:07:47 -0700354 mShutdownTrigger = nullptr;
355 return true;
356}
357
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000358std::vector<sp<RpcSession>> RpcServer::listSessions() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000359 RpcMutexLockGuard _l(mLock);
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000360 std::vector<sp<RpcSession>> sessions;
361 for (auto& [id, session] : mSessions) {
Steven Moreland736664b2021-05-01 04:27:25 +0000362 (void)id;
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000363 sessions.push_back(session);
Steven Moreland736664b2021-05-01 04:27:25 +0000364 }
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000365 return sessions;
Steven Moreland611d15f2021-05-01 01:28:27 +0000366}
367
Steven Morelandd539fbf2021-05-05 23:40:25 +0000368size_t RpcServer::numUninitializedSessions() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000369 RpcMutexLockGuard _l(mLock);
Steven Morelandd539fbf2021-05-05 23:40:25 +0000370 return mConnectingThreads.size();
371}
372
Andrei Homescu74a54452021-12-10 05:30:21 +0000373void RpcServer::establishConnection(
Pawan3e0061c2022-08-26 21:08:34 +0000374 sp<RpcServer>&& server, RpcTransportFd clientFd, std::array<uint8_t, kRpcAddressSize> addr,
Andrei Homescu74a54452021-12-10 05:30:21 +0000375 size_t addrLen,
376 std::function<void(sp<RpcSession>&&, RpcSession::PreJoinSetupResult&&)>&& joinFn) {
Steven Moreland9d11b922021-05-20 01:22:58 +0000377 // mShutdownTrigger can only be cleared once connection threads have joined.
378 // It must be set before this thread is started
379 LOG_ALWAYS_FATAL_IF(server->mShutdownTrigger == nullptr);
Yifan Hong702115c2021-06-24 15:39:18 -0700380 LOG_ALWAYS_FATAL_IF(server->mCtx == nullptr);
381
382 status_t status = OK;
383
Pawan49d74cb2022-08-03 21:19:11 +0000384 int clientFdForLog = clientFd.fd.get();
Yifan Hongf6d42292021-08-05 23:43:05 -0700385 auto client = server->mCtx->newTransport(std::move(clientFd), server->mShutdownTrigger.get());
Yifan Hong702115c2021-06-24 15:39:18 -0700386 if (client == nullptr) {
387 ALOGE("Dropping accept4()-ed socket because sslAccept fails");
388 status = DEAD_OBJECT;
389 // still need to cleanup before we can return
390 } else {
391 LOG_RPC_DETAIL("Created RpcTransport %p for client fd %d", client.get(), clientFdForLog);
392 }
Steven Moreland9d11b922021-05-20 01:22:58 +0000393
Steven Moreland659416d2021-05-11 00:47:50 +0000394 RpcConnectionHeader header;
Yifan Hong702115c2021-06-24 15:39:18 -0700395 if (status == OK) {
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000396 iovec iov{&header, sizeof(header)};
Devin Moore695368f2022-06-03 22:29:14 +0000397 status = client->interruptableReadFully(server->mShutdownTrigger.get(), &iov, 1,
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000398 std::nullopt, /*ancillaryFds=*/nullptr);
Yifan Hong702115c2021-06-24 15:39:18 -0700399 if (status != OK) {
400 ALOGE("Failed to read ID for client connecting to RPC server: %s",
401 statusToString(status).c_str());
402 // still need to cleanup before we can return
403 }
Steven Morelanda63ff932021-05-12 00:03:15 +0000404 }
Steven Morelandbf57bce2021-07-26 15:26:12 -0700405
Steven Moreland826367f2021-09-10 14:05:31 -0700406 std::vector<uint8_t> sessionId;
407 if (status == OK) {
408 if (header.sessionIdSize > 0) {
Steven Morelandc5032042021-09-30 15:40:27 -0700409 if (header.sessionIdSize == kSessionIdBytes) {
410 sessionId.resize(header.sessionIdSize);
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000411 iovec iov{sessionId.data(), sessionId.size()};
Devin Moore695368f2022-06-03 22:29:14 +0000412 status = client->interruptableReadFully(server->mShutdownTrigger.get(), &iov, 1,
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000413 std::nullopt, /*ancillaryFds=*/nullptr);
Steven Morelandc5032042021-09-30 15:40:27 -0700414 if (status != OK) {
415 ALOGE("Failed to read session ID for client connecting to RPC server: %s",
416 statusToString(status).c_str());
417 // still need to cleanup before we can return
418 }
419 } else {
420 ALOGE("Malformed session ID. Expecting session ID of size %zu but got %" PRIu16,
421 kSessionIdBytes, header.sessionIdSize);
422 status = BAD_VALUE;
Steven Moreland826367f2021-09-10 14:05:31 -0700423 }
424 }
425 }
426
Steven Morelandbf57bce2021-07-26 15:26:12 -0700427 bool incoming = false;
428 uint32_t protocolVersion = 0;
Steven Morelandbf57bce2021-07-26 15:26:12 -0700429 bool requestingNewSession = false;
430
431 if (status == OK) {
432 incoming = header.options & RPC_CONNECTION_OPTION_INCOMING;
433 protocolVersion = std::min(header.version,
434 server->mProtocolVersion.value_or(RPC_WIRE_PROTOCOL_VERSION));
Steven Moreland826367f2021-09-10 14:05:31 -0700435 requestingNewSession = sessionId.empty();
Steven Morelandbf57bce2021-07-26 15:26:12 -0700436
437 if (requestingNewSession) {
438 RpcNewSessionResponse response{
439 .version = protocolVersion,
440 };
441
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000442 iovec iov{&response, sizeof(response)};
Devin Moore695368f2022-06-03 22:29:14 +0000443 status = client->interruptableWriteFully(server->mShutdownTrigger.get(), &iov, 1,
Frederick Mayle69a0c992022-05-26 20:38:39 +0000444 std::nullopt, nullptr);
Steven Morelandbf57bce2021-07-26 15:26:12 -0700445 if (status != OK) {
446 ALOGE("Failed to send new session response: %s", statusToString(status).c_str());
447 // still need to cleanup before we can return
448 }
449 }
450 }
Steven Morelanda63ff932021-05-12 00:03:15 +0000451
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000452 RpcMaybeThread thisThread;
Steven Morelanda63ff932021-05-12 00:03:15 +0000453 sp<RpcSession> session;
454 {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000455 RpcMutexUniqueLock _l(server->mLock);
Steven Morelanda63ff932021-05-12 00:03:15 +0000456
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000457 auto threadId = server->mConnectingThreads.find(rpc_this_thread::get_id());
Yifan Hongb3005502021-05-19 15:37:00 -0700458 LOG_ALWAYS_FATAL_IF(threadId == server->mConnectingThreads.end(),
Steven Morelanda63ff932021-05-12 00:03:15 +0000459 "Must establish connection on owned thread");
460 thisThread = std::move(threadId->second);
Steven Morelandadc5dca2021-05-25 02:06:03 +0000461 ScopeGuard detachGuard = [&]() {
462 thisThread.detach();
Steven Moreland9d11b922021-05-20 01:22:58 +0000463 _l.unlock();
464 server->mShutdownCv.notify_all();
465 };
Steven Morelandadc5dca2021-05-25 02:06:03 +0000466 server->mConnectingThreads.erase(threadId);
Steven Moreland9d11b922021-05-20 01:22:58 +0000467
Steven Morelandbf57bce2021-07-26 15:26:12 -0700468 if (status != OK || server->mShutdownTrigger->isTriggered()) {
Steven Moreland5802c2b2021-05-12 20:13:04 +0000469 return;
470 }
471
Steven Morelandbf57bce2021-07-26 15:26:12 -0700472 if (requestingNewSession) {
Steven Moreland1b304292021-07-15 22:59:34 +0000473 if (incoming) {
474 ALOGE("Cannot create a new session with an incoming connection, would leak");
Steven Moreland659416d2021-05-11 00:47:50 +0000475 return;
476 }
477
Steven Moreland826367f2021-09-10 14:05:31 -0700478 // Uniquely identify session at the application layer. Even if a
479 // client/server use the same certificates, if they create multiple
480 // sessions, we still want to distinguish between them.
Steven Morelandc5032042021-09-30 15:40:27 -0700481 sessionId.resize(kSessionIdBytes);
Steven Moreland01a6bad2021-06-11 00:59:20 +0000482 size_t tries = 0;
483 do {
484 // don't block if there is some entropy issue
485 if (tries++ > 5) {
Steven Moreland826367f2021-09-10 14:05:31 -0700486 ALOGE("Cannot find new address: %s",
487 base::HexString(sessionId.data(), sessionId.size()).c_str());
Steven Moreland01a6bad2021-06-11 00:59:20 +0000488 return;
489 }
490
Tomasz Wasilczyk0d9dec22023-10-06 20:28:49 +0000491 auto status = binder::os::getRandomBytes(sessionId.data(), sessionId.size());
Andrei Homescuc24c8792022-04-19 00:24:51 +0000492 if (status != OK) {
493 ALOGE("Failed to read random session ID: %s", strerror(-status));
Steven Moreland826367f2021-09-10 14:05:31 -0700494 return;
495 }
Steven Moreland01a6bad2021-06-11 00:59:20 +0000496 } while (server->mSessions.end() != server->mSessions.find(sessionId));
Steven Morelanda63ff932021-05-12 00:03:15 +0000497
Andrei Homescu5e301462022-05-12 00:52:34 +0000498 session = sp<RpcSession>::make(nullptr);
Yifan Hong10423062021-10-08 16:26:32 -0700499 session->setMaxIncomingThreads(server->mMaxThreads);
Steven Morelandbf57bce2021-07-26 15:26:12 -0700500 if (!session->setProtocolVersion(protocolVersion)) return;
Steven Moreland51c44a92021-10-14 16:50:35 -0700501
Frederick Mayle26b494e2022-07-08 22:09:58 +0000502 if (header.fileDescriptorTransportMode <
503 server->mSupportedFileDescriptorTransportModes.size() &&
504 server->mSupportedFileDescriptorTransportModes.test(
Frederick Mayle69a0c992022-05-26 20:38:39 +0000505 header.fileDescriptorTransportMode)) {
506 session->setFileDescriptorTransportMode(
507 static_cast<RpcSession::FileDescriptorTransportMode>(
508 header.fileDescriptorTransportMode));
509 } else {
510 ALOGE("Rejecting connection: FileDescriptorTransportMode is not supported: %hhu",
511 header.fileDescriptorTransportMode);
512 return;
513 }
514
Steven Moreland51c44a92021-10-14 16:50:35 -0700515 // if null, falls back to server root
516 sp<IBinder> sessionSpecificRoot;
517 if (server->mRootObjectFactory != nullptr) {
Steven Morelanddfb92182023-05-24 17:48:59 +0000518 sessionSpecificRoot =
519 server->mRootObjectFactory(wp<RpcSession>(session), addr.data(), addrLen);
Steven Moreland51c44a92021-10-14 16:50:35 -0700520 if (sessionSpecificRoot == nullptr) {
521 ALOGE("Warning: server returned null from root object factory");
522 }
523 }
524
Steven Morelanda8b44292021-06-08 01:27:53 +0000525 if (!session->setForServer(server,
526 sp<RpcServer::EventListener>::fromExisting(
527 static_cast<RpcServer::EventListener*>(
528 server.get())),
Steven Moreland51c44a92021-10-14 16:50:35 -0700529 sessionId, sessionSpecificRoot)) {
Steven Morelanda8b44292021-06-08 01:27:53 +0000530 ALOGE("Failed to attach server to session");
531 return;
532 }
Steven Morelanda63ff932021-05-12 00:03:15 +0000533
Steven Moreland01a6bad2021-06-11 00:59:20 +0000534 server->mSessions[sessionId] = session;
Steven Morelanda63ff932021-05-12 00:03:15 +0000535 } else {
Steven Moreland01a6bad2021-06-11 00:59:20 +0000536 auto it = server->mSessions.find(sessionId);
Yifan Hongb3005502021-05-19 15:37:00 -0700537 if (it == server->mSessions.end()) {
Steven Moreland01a6bad2021-06-11 00:59:20 +0000538 ALOGE("Cannot add thread, no record of session with ID %s",
Steven Moreland826367f2021-09-10 14:05:31 -0700539 base::HexString(sessionId.data(), sessionId.size()).c_str());
Steven Morelanda63ff932021-05-12 00:03:15 +0000540 return;
541 }
542 session = it->second;
543 }
Steven Moreland5802c2b2021-05-12 20:13:04 +0000544
Steven Moreland1b304292021-07-15 22:59:34 +0000545 if (incoming) {
Steven Moreland2372f9d2021-08-05 15:42:01 -0700546 LOG_ALWAYS_FATAL_IF(OK != session->addOutgoingConnection(std::move(client), true),
Steven Moreland659416d2021-05-11 00:47:50 +0000547 "server state must already be initialized");
548 return;
549 }
550
Steven Moreland5802c2b2021-05-12 20:13:04 +0000551 detachGuard.Disable();
Steven Morelandc88b7fc2021-06-10 00:40:39 +0000552 session->preJoinThreadOwnership(std::move(thisThread));
Steven Morelanda63ff932021-05-12 00:03:15 +0000553 }
554
Yifan Hong702115c2021-06-24 15:39:18 -0700555 auto setupResult = session->preJoinSetup(std::move(client));
Steven Morelandc88b7fc2021-06-10 00:40:39 +0000556
Steven Morelanda63ff932021-05-12 00:03:15 +0000557 // avoid strong cycle
558 server = nullptr;
Steven Morelanda63ff932021-05-12 00:03:15 +0000559
Andrei Homescu74a54452021-12-10 05:30:21 +0000560 joinFn(std::move(session), std::move(setupResult));
Steven Morelanda63ff932021-05-12 00:03:15 +0000561}
562
Steven Moreland2372f9d2021-08-05 15:42:01 -0700563status_t RpcServer::setupSocketServer(const RpcSocketAddress& addr) {
Steven Moreland704fc1a2021-05-04 23:13:14 +0000564 LOG_RPC_DETAIL("Setting up socket server %s", addr.toString().c_str());
Yifan Hong0eb5a672021-05-12 18:00:25 -0700565 LOG_ALWAYS_FATAL_IF(hasServer(), "Each RpcServer can only have one server.");
Steven Moreland611d15f2021-05-01 01:28:27 +0000566
Alice Wang0b138ed2022-11-15 16:22:44 +0000567 unique_fd socket_fd(TEMP_FAILURE_RETRY(
568 socket(addr.addr()->sa_family, SOCK_STREAM | SOCK_CLOEXEC | SOCK_NONBLOCK, 0)));
569 if (!socket_fd.ok()) {
Steven Moreland2372f9d2021-08-05 15:42:01 -0700570 int savedErrno = errno;
Steven Moreland8925ebb2023-04-10 21:52:17 +0000571 ALOGE("Could not create socket at %s: %s", addr.toString().c_str(), strerror(savedErrno));
Steven Moreland2372f9d2021-08-05 15:42:01 -0700572 return -savedErrno;
Steven Moreland611d15f2021-05-01 01:28:27 +0000573 }
Tomasz Wasilczyk7c8dd482023-03-23 15:30:03 -0700574
575 {
576 RpcMutexLockGuard _l(mLock);
577 if (mServerSocketModifier != nullptr) {
578 mServerSocketModifier(socket_fd);
579 }
580 }
581
Alice Wang0b138ed2022-11-15 16:22:44 +0000582 if (0 != TEMP_FAILURE_RETRY(bind(socket_fd.get(), addr.addr(), addr.addrSize()))) {
Steven Moreland611d15f2021-05-01 01:28:27 +0000583 int savedErrno = errno;
584 ALOGE("Could not bind socket at %s: %s", addr.toString().c_str(), strerror(savedErrno));
Steven Moreland2372f9d2021-08-05 15:42:01 -0700585 return -savedErrno;
Steven Moreland611d15f2021-05-01 01:28:27 +0000586 }
587
Alice Wang0b138ed2022-11-15 16:22:44 +0000588 return setupRawSocketServer(std::move(socket_fd));
Steven Moreland611d15f2021-05-01 01:28:27 +0000589}
590
Alice Wang0b138ed2022-11-15 16:22:44 +0000591status_t RpcServer::setupRawSocketServer(unique_fd socket_fd) {
Alice Wang30c204d2022-11-15 12:50:51 +0000592 LOG_ALWAYS_FATAL_IF(!socket_fd.ok(), "Socket must be setup to listen.");
Alice Wang30c204d2022-11-15 12:50:51 +0000593
Alice Wang893a9912022-10-24 10:44:09 +0000594 // Right now, we create all threads at once, making accept4 slow. To avoid hanging the client,
595 // the backlog is increased to a large number.
596 // TODO(b/189955605): Once we create threads dynamically & lazily, the backlog can be reduced
597 // to 1.
Alice Wangdf741782022-11-16 08:37:04 +0000598 if (0 != TEMP_FAILURE_RETRY(listen(socket_fd.get(), 50 /*backlog*/))) {
Alice Wang893a9912022-10-24 10:44:09 +0000599 int savedErrno = errno;
600 ALOGE("Could not listen initialized Unix socket: %s", strerror(savedErrno));
601 return -savedErrno;
602 }
Alice Wangdf741782022-11-16 08:37:04 +0000603 if (status_t status = setupExternalServer(std::move(socket_fd)); status != OK) {
Alice Wang893a9912022-10-24 10:44:09 +0000604 ALOGE("Another thread has set up server while calling setupSocketServer. Race?");
605 return status;
606 }
607 return OK;
608}
609
Steven Morelanddd67b942021-07-23 17:15:41 -0700610void RpcServer::onSessionAllIncomingThreadsEnded(const sp<RpcSession>& session) {
Steven Moreland826367f2021-09-10 14:05:31 -0700611 const std::vector<uint8_t>& id = session->mId;
612 LOG_ALWAYS_FATAL_IF(id.empty(), "Server sessions must be initialized with ID");
613 LOG_RPC_DETAIL("Dropping session with address %s",
614 base::HexString(id.data(), id.size()).c_str());
Steven Morelandee78e762021-05-05 21:12:51 +0000615
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000616 RpcMutexLockGuard _l(mLock);
Steven Moreland826367f2021-09-10 14:05:31 -0700617 auto it = mSessions.find(id);
Steven Moreland01a6bad2021-06-11 00:59:20 +0000618 LOG_ALWAYS_FATAL_IF(it == mSessions.end(), "Bad state, unknown session id %s",
Steven Moreland826367f2021-09-10 14:05:31 -0700619 base::HexString(id.data(), id.size()).c_str());
Steven Moreland01a6bad2021-06-11 00:59:20 +0000620 LOG_ALWAYS_FATAL_IF(it->second != session, "Bad state, session has id mismatch %s",
Steven Moreland826367f2021-09-10 14:05:31 -0700621 base::HexString(id.data(), id.size()).c_str());
Steven Morelandee78e762021-05-05 21:12:51 +0000622 (void)mSessions.erase(it);
623}
624
Steven Moreland19fc9f72021-06-10 03:57:30 +0000625void RpcServer::onSessionIncomingThreadEnded() {
Steven Morelandee3f4662021-05-22 01:07:33 +0000626 mShutdownCv.notify_all();
627}
628
Yifan Hong0eb5a672021-05-12 18:00:25 -0700629bool RpcServer::hasServer() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000630 RpcMutexLockGuard _l(mLock);
Pawan49d74cb2022-08-03 21:19:11 +0000631 return mServer.fd.ok();
Yifan Hong0eb5a672021-05-12 18:00:25 -0700632}
633
Yifan Hong00aeb762021-05-12 17:07:36 -0700634unique_fd RpcServer::releaseServer() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000635 RpcMutexLockGuard _l(mLock);
Pawan49d74cb2022-08-03 21:19:11 +0000636 return std::move(mServer.fd);
Yifan Hong00aeb762021-05-12 17:07:36 -0700637}
638
David Brazdil21c887c2022-09-23 12:25:18 +0100639status_t RpcServer::setupExternalServer(
640 base::unique_fd serverFd,
641 std::function<status_t(const RpcServer&, RpcTransportFd*)>&& acceptFn) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000642 RpcMutexLockGuard _l(mLock);
Pawan49d74cb2022-08-03 21:19:11 +0000643 if (mServer.fd.ok()) {
Yifan Hong00aeb762021-05-12 17:07:36 -0700644 ALOGE("Each RpcServer can only have one server.");
Steven Moreland2372f9d2021-08-05 15:42:01 -0700645 return INVALID_OPERATION;
Yifan Hong00aeb762021-05-12 17:07:36 -0700646 }
647 mServer = std::move(serverFd);
David Brazdil21c887c2022-09-23 12:25:18 +0100648 mAcceptFn = std::move(acceptFn);
Steven Moreland2372f9d2021-08-05 15:42:01 -0700649 return OK;
Yifan Hong00aeb762021-05-12 17:07:36 -0700650}
651
David Brazdil21c887c2022-09-23 12:25:18 +0100652status_t RpcServer::setupExternalServer(base::unique_fd serverFd) {
653 return setupExternalServer(std::move(serverFd), &RpcServer::acceptSocketConnection);
654}
655
Pawan1c24f9c2022-08-26 23:23:15 +0000656bool RpcServer::hasActiveRequests() {
657 RpcMutexLockGuard _l(mLock);
658 for (const auto& [_, session] : mSessions) {
659 if (session->hasActiveRequests()) {
660 return true;
661 }
662 }
663 return !mServer.isInPollingState();
664}
665
Steven Moreland5553ac42020-11-11 02:14:45 +0000666} // namespace android