Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 1 | /* |
| 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 Moreland | c503204 | 2021-09-30 15:40:27 -0700 | [diff] [blame] | 19 | #include <inttypes.h> |
Keith Mok | 442907b | 2023-10-11 20:36:18 +0000 | [diff] [blame] | 20 | #include <netinet/tcp.h> |
Steven Moreland | 798e0d1 | 2021-07-14 23:19:25 +0000 | [diff] [blame] | 21 | #include <poll.h> |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 22 | #include <sys/socket.h> |
| 23 | #include <sys/un.h> |
| 24 | |
Steven Moreland | f137de9 | 2021-04-24 01:54:26 +0000 | [diff] [blame] | 25 | #include <thread> |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 26 | #include <vector> |
| 27 | |
Tomasz Wasilczyk | 1de48a2 | 2023-10-30 14:19:19 +0000 | [diff] [blame] | 28 | #include <binder/Functional.h> |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 29 | #include <binder/Parcel.h> |
| 30 | #include <binder/RpcServer.h> |
Yifan Hong | 702115c | 2021-06-24 15:39:18 -0700 | [diff] [blame] | 31 | #include <binder/RpcTransportRaw.h> |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 32 | #include <log/log.h> |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 33 | |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 34 | #include "BuildFlags.h" |
Yifan Hong | 8c95042 | 2021-08-05 17:13:55 -0700 | [diff] [blame] | 35 | #include "FdTrigger.h" |
Andrei Homescu | 7c0b79f | 2022-06-30 02:00:46 +0000 | [diff] [blame] | 36 | #include "OS.h" |
Steven Moreland | 611d15f | 2021-05-01 01:28:27 +0000 | [diff] [blame] | 37 | #include "RpcSocketAddress.h" |
Yifan Hong | 1a23585 | 2021-05-13 16:07:47 -0700 | [diff] [blame] | 38 | #include "RpcState.h" |
David Brazdil | 21c887c | 2022-09-23 12:25:18 +0100 | [diff] [blame] | 39 | #include "RpcTransportUtils.h" |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 40 | #include "RpcWireFormat.h" |
Andrei Homescu | c24c879 | 2022-04-19 00:24:51 +0000 | [diff] [blame] | 41 | #include "Utils.h" |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 42 | |
| 43 | namespace android { |
| 44 | |
Steven Moreland | c503204 | 2021-09-30 15:40:27 -0700 | [diff] [blame] | 45 | constexpr size_t kSessionIdBytes = 32; |
| 46 | |
Tomasz Wasilczyk | 1de48a2 | 2023-10-30 14:19:19 +0000 | [diff] [blame] | 47 | using namespace android::binder::impl; |
Tomasz Wasilczyk | 639490b | 2023-11-01 13:49:41 -0700 | [diff] [blame] | 48 | using android::binder::borrowed_fd; |
| 49 | using android::binder::unique_fd; |
Steven Moreland | 611d15f | 2021-05-01 01:28:27 +0000 | [diff] [blame] | 50 | |
Yifan Hong | ecf937d | 2021-08-11 17:29:28 -0700 | [diff] [blame] | 51 | RpcServer::RpcServer(std::unique_ptr<RpcTransportCtx> ctx) : mCtx(std::move(ctx)) {} |
Yifan Hong | 436f0e6 | 2021-05-19 15:25:34 -0700 | [diff] [blame] | 52 | RpcServer::~RpcServer() { |
David Brazdil | 4766a1f | 2022-12-19 21:58:25 +0000 | [diff] [blame] | 53 | RpcMutexUniqueLock _l(mLock); |
| 54 | LOG_ALWAYS_FATAL_IF(mShutdownTrigger != nullptr, "Must call shutdown() before destructor"); |
Yifan Hong | 436f0e6 | 2021-05-19 15:25:34 -0700 | [diff] [blame] | 55 | } |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 56 | |
Yifan Hong | 702115c | 2021-06-24 15:39:18 -0700 | [diff] [blame] | 57 | sp<RpcServer> RpcServer::make(std::unique_ptr<RpcTransportCtxFactory> rpcTransportCtxFactory) { |
| 58 | // Default is without TLS. |
| 59 | if (rpcTransportCtxFactory == nullptr) |
Tomasz Wasilczyk | 0d9dec2 | 2023-10-06 20:28:49 +0000 | [diff] [blame] | 60 | rpcTransportCtxFactory = binder::os::makeDefaultRpcTransportCtxFactory(); |
Yifan Hong | ecf937d | 2021-08-11 17:29:28 -0700 | [diff] [blame] | 61 | auto ctx = rpcTransportCtxFactory->newServerCtx(); |
| 62 | if (ctx == nullptr) return nullptr; |
| 63 | return sp<RpcServer>::make(std::move(ctx)); |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 64 | } |
| 65 | |
David Brazdil | 21c887c | 2022-09-23 12:25:18 +0100 | [diff] [blame] | 66 | status_t RpcServer::setupUnixDomainSocketBootstrapServer(unique_fd bootstrapFd) { |
| 67 | return setupExternalServer(std::move(bootstrapFd), &RpcServer::recvmsgSocketConnection); |
| 68 | } |
| 69 | |
Steven Moreland | 2372f9d | 2021-08-05 15:42:01 -0700 | [diff] [blame] | 70 | status_t RpcServer::setupUnixDomainServer(const char* path) { |
Steven Moreland | 611d15f | 2021-05-01 01:28:27 +0000 | [diff] [blame] | 71 | return setupSocketServer(UnixSocketAddress(path)); |
| 72 | } |
| 73 | |
Tomasz Wasilczyk | 022db68 | 2024-06-17 13:55:51 -0700 | [diff] [blame] | 74 | status_t RpcServer::setupVsockServer(unsigned bindCid, unsigned port, unsigned* assignedPort) { |
| 75 | auto status = setupSocketServer(VsockSocketAddress(bindCid, port)); |
| 76 | if (status != OK) return status; |
| 77 | |
| 78 | if (assignedPort == nullptr) return OK; |
| 79 | sockaddr_vm addr; |
| 80 | socklen_t len = sizeof(addr); |
| 81 | if (0 != getsockname(mServer.fd.get(), reinterpret_cast<sockaddr*>(&addr), &len)) { |
| 82 | status = -errno; |
| 83 | ALOGE("setupVsockServer: Failed to getsockname: %s", strerror(-status)); |
| 84 | return status; |
| 85 | } |
| 86 | |
| 87 | LOG_ALWAYS_FATAL_IF(len != sizeof(addr), "Wrong socket type: len %zu vs len %zu", |
| 88 | static_cast<size_t>(len), sizeof(addr)); |
| 89 | *assignedPort = addr.svm_port; |
| 90 | return OK; |
Steven Moreland | 611d15f | 2021-05-01 01:28:27 +0000 | [diff] [blame] | 91 | } |
| 92 | |
Steven Moreland | 2372f9d | 2021-08-05 15:42:01 -0700 | [diff] [blame] | 93 | status_t RpcServer::setupInetServer(const char* address, unsigned int port, |
| 94 | unsigned int* assignedPort) { |
Steven Moreland | 611d15f | 2021-05-01 01:28:27 +0000 | [diff] [blame] | 95 | if (assignedPort != nullptr) *assignedPort = 0; |
Devin Moore | f3b9c4f | 2021-08-03 15:50:13 +0000 | [diff] [blame] | 96 | auto aiStart = InetSocketAddress::getAddrInfo(address, port); |
Steven Moreland | 2372f9d | 2021-08-05 15:42:01 -0700 | [diff] [blame] | 97 | if (aiStart == nullptr) return UNKNOWN_ERROR; |
Steven Moreland | 611d15f | 2021-05-01 01:28:27 +0000 | [diff] [blame] | 98 | for (auto ai = aiStart.get(); ai != nullptr; ai = ai->ai_next) { |
zijunzhao | a201336 | 2023-05-11 21:27:19 +0000 | [diff] [blame] | 99 | if (ai->ai_addr == nullptr) continue; |
Devin Moore | f3b9c4f | 2021-08-03 15:50:13 +0000 | [diff] [blame] | 100 | InetSocketAddress socketAddress(ai->ai_addr, ai->ai_addrlen, address, port); |
Steven Moreland | 2372f9d | 2021-08-05 15:42:01 -0700 | [diff] [blame] | 101 | if (status_t status = setupSocketServer(socketAddress); status != OK) { |
Steven Moreland | 611d15f | 2021-05-01 01:28:27 +0000 | [diff] [blame] | 102 | continue; |
| 103 | } |
| 104 | |
| 105 | LOG_ALWAYS_FATAL_IF(socketAddress.addr()->sa_family != AF_INET, "expecting inet"); |
| 106 | sockaddr_in addr{}; |
| 107 | socklen_t len = sizeof(addr); |
Pawan | 49d74cb | 2022-08-03 21:19:11 +0000 | [diff] [blame] | 108 | if (0 != getsockname(mServer.fd.get(), reinterpret_cast<sockaddr*>(&addr), &len)) { |
Steven Moreland | 611d15f | 2021-05-01 01:28:27 +0000 | [diff] [blame] | 109 | int savedErrno = errno; |
| 110 | ALOGE("Could not getsockname at %s: %s", socketAddress.toString().c_str(), |
| 111 | strerror(savedErrno)); |
Steven Moreland | 2372f9d | 2021-08-05 15:42:01 -0700 | [diff] [blame] | 112 | return -savedErrno; |
Steven Moreland | 611d15f | 2021-05-01 01:28:27 +0000 | [diff] [blame] | 113 | } |
| 114 | LOG_ALWAYS_FATAL_IF(len != sizeof(addr), "Wrong socket type: len %zu vs len %zu", |
| 115 | static_cast<size_t>(len), sizeof(addr)); |
| 116 | unsigned int realPort = ntohs(addr.sin_port); |
| 117 | LOG_ALWAYS_FATAL_IF(port != 0 && realPort != port, |
| 118 | "Requesting inet server on %s but it is set up on %u.", |
| 119 | socketAddress.toString().c_str(), realPort); |
| 120 | |
| 121 | if (assignedPort != nullptr) { |
| 122 | *assignedPort = realPort; |
| 123 | } |
| 124 | |
Steven Moreland | 2372f9d | 2021-08-05 15:42:01 -0700 | [diff] [blame] | 125 | return OK; |
Steven Moreland | 611d15f | 2021-05-01 01:28:27 +0000 | [diff] [blame] | 126 | } |
Devin Moore | f3b9c4f | 2021-08-03 15:50:13 +0000 | [diff] [blame] | 127 | ALOGE("None of the socket address resolved for %s:%u can be set up as inet server.", address, |
Steven Moreland | 611d15f | 2021-05-01 01:28:27 +0000 | [diff] [blame] | 128 | port); |
Steven Moreland | 2372f9d | 2021-08-05 15:42:01 -0700 | [diff] [blame] | 129 | return UNKNOWN_ERROR; |
Steven Moreland | 611d15f | 2021-05-01 01:28:27 +0000 | [diff] [blame] | 130 | } |
| 131 | |
Steven Moreland | f137de9 | 2021-04-24 01:54:26 +0000 | [diff] [blame] | 132 | void RpcServer::setMaxThreads(size_t threads) { |
| 133 | LOG_ALWAYS_FATAL_IF(threads <= 0, "RpcServer is useless without threads"); |
Yifan Hong | 1a23585 | 2021-05-13 16:07:47 -0700 | [diff] [blame] | 134 | LOG_ALWAYS_FATAL_IF(mJoinThreadRunning, "Cannot set max threads while running"); |
Steven Moreland | f137de9 | 2021-04-24 01:54:26 +0000 | [diff] [blame] | 135 | mMaxThreads = threads; |
| 136 | } |
| 137 | |
| 138 | size_t RpcServer::getMaxThreads() { |
| 139 | return mMaxThreads; |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 140 | } |
| 141 | |
Steven Moreland | ca3f638 | 2023-05-11 23:23:26 +0000 | [diff] [blame] | 142 | bool RpcServer::setProtocolVersion(uint32_t version) { |
| 143 | if (!RpcState::validateProtocolVersion(version)) { |
| 144 | return false; |
| 145 | } |
| 146 | |
Steven Moreland | bf57bce | 2021-07-26 15:26:12 -0700 | [diff] [blame] | 147 | mProtocolVersion = version; |
Steven Moreland | ca3f638 | 2023-05-11 23:23:26 +0000 | [diff] [blame] | 148 | return true; |
Steven Moreland | bf57bce | 2021-07-26 15:26:12 -0700 | [diff] [blame] | 149 | } |
| 150 | |
Frederick Mayle | 69a0c99 | 2022-05-26 20:38:39 +0000 | [diff] [blame] | 151 | void RpcServer::setSupportedFileDescriptorTransportModes( |
| 152 | const std::vector<RpcSession::FileDescriptorTransportMode>& modes) { |
| 153 | mSupportedFileDescriptorTransportModes.reset(); |
| 154 | for (RpcSession::FileDescriptorTransportMode mode : modes) { |
| 155 | mSupportedFileDescriptorTransportModes.set(static_cast<size_t>(mode)); |
| 156 | } |
| 157 | } |
| 158 | |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 159 | void RpcServer::setRootObject(const sp<IBinder>& binder) { |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 160 | RpcMutexLockGuard _l(mLock); |
Steven Moreland | 51c44a9 | 2021-10-14 16:50:35 -0700 | [diff] [blame] | 161 | mRootObjectFactory = nullptr; |
Yifan Hong | 4ffb0c7 | 2021-05-07 18:35:14 -0700 | [diff] [blame] | 162 | mRootObjectWeak = mRootObject = binder; |
| 163 | } |
| 164 | |
| 165 | void RpcServer::setRootObjectWeak(const wp<IBinder>& binder) { |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 166 | RpcMutexLockGuard _l(mLock); |
Yifan Hong | 4ffb0c7 | 2021-05-07 18:35:14 -0700 | [diff] [blame] | 167 | mRootObject.clear(); |
Steven Moreland | 51c44a9 | 2021-10-14 16:50:35 -0700 | [diff] [blame] | 168 | mRootObjectFactory = nullptr; |
Yifan Hong | 4ffb0c7 | 2021-05-07 18:35:14 -0700 | [diff] [blame] | 169 | mRootObjectWeak = binder; |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 170 | } |
Steven Moreland | 51c44a9 | 2021-10-14 16:50:35 -0700 | [diff] [blame] | 171 | void RpcServer::setPerSessionRootObject( |
Steven Moreland | dfb9218 | 2023-05-24 17:48:59 +0000 | [diff] [blame] | 172 | std::function<sp<IBinder>(wp<RpcSession> session, const void*, size_t)>&& makeObject) { |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 173 | RpcMutexLockGuard _l(mLock); |
Steven Moreland | 51c44a9 | 2021-10-14 16:50:35 -0700 | [diff] [blame] | 174 | mRootObject.clear(); |
| 175 | mRootObjectWeak.clear(); |
| 176 | mRootObjectFactory = std::move(makeObject); |
| 177 | } |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 178 | |
David Brazdil | a47dfda | 2022-11-22 22:52:19 +0000 | [diff] [blame] | 179 | void RpcServer::setConnectionFilter(std::function<bool(const void*, size_t)>&& filter) { |
| 180 | RpcMutexLockGuard _l(mLock); |
| 181 | LOG_ALWAYS_FATAL_IF(mShutdownTrigger != nullptr, "Already joined"); |
| 182 | mConnectionFilter = std::move(filter); |
| 183 | } |
| 184 | |
Tomasz Wasilczyk | 639490b | 2023-11-01 13:49:41 -0700 | [diff] [blame] | 185 | void RpcServer::setServerSocketModifier(std::function<void(borrowed_fd)>&& modifier) { |
Tomasz Wasilczyk | 7c8dd48 | 2023-03-23 15:30:03 -0700 | [diff] [blame] | 186 | RpcMutexLockGuard _l(mLock); |
Tomasz Wasilczyk | bfb13a8 | 2023-11-14 11:33:10 -0800 | [diff] [blame] | 187 | LOG_ALWAYS_FATAL_IF(mServer.fd.ok(), "Already started"); |
Tomasz Wasilczyk | 7c8dd48 | 2023-03-23 15:30:03 -0700 | [diff] [blame] | 188 | mServerSocketModifier = std::move(modifier); |
| 189 | } |
| 190 | |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 191 | sp<IBinder> RpcServer::getRootObject() { |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 192 | RpcMutexLockGuard _l(mLock); |
Yifan Hong | 4ffb0c7 | 2021-05-07 18:35:14 -0700 | [diff] [blame] | 193 | bool hasWeak = mRootObjectWeak.unsafe_get(); |
| 194 | sp<IBinder> ret = mRootObjectWeak.promote(); |
| 195 | ALOGW_IF(hasWeak && ret == nullptr, "RpcServer root object is freed, returning nullptr"); |
| 196 | return ret; |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 197 | } |
| 198 | |
Yifan Hong | 9734cfc | 2021-09-13 16:14:09 -0700 | [diff] [blame] | 199 | std::vector<uint8_t> RpcServer::getCertificate(RpcCertificateFormat format) { |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 200 | RpcMutexLockGuard _l(mLock); |
Yifan Hong | ecf937d | 2021-08-11 17:29:28 -0700 | [diff] [blame] | 201 | return mCtx->getCertificate(format); |
| 202 | } |
| 203 | |
Yifan Hong | 326afd1 | 2021-05-19 15:24:54 -0700 | [diff] [blame] | 204 | static void joinRpcServer(sp<RpcServer>&& thiz) { |
| 205 | thiz->join(); |
| 206 | } |
| 207 | |
| 208 | void RpcServer::start() { |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 209 | RpcMutexLockGuard _l(mLock); |
Yifan Hong | 326afd1 | 2021-05-19 15:24:54 -0700 | [diff] [blame] | 210 | LOG_ALWAYS_FATAL_IF(mJoinThread.get(), "Already started!"); |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 211 | mJoinThread = |
| 212 | std::make_unique<RpcMaybeThread>(&joinRpcServer, sp<RpcServer>::fromExisting(this)); |
| 213 | rpcJoinIfSingleThreaded(*mJoinThread); |
Yifan Hong | 326afd1 | 2021-05-19 15:24:54 -0700 | [diff] [blame] | 214 | } |
| 215 | |
David Brazdil | 21c887c | 2022-09-23 12:25:18 +0100 | [diff] [blame] | 216 | status_t RpcServer::acceptSocketConnection(const RpcServer& server, RpcTransportFd* out) { |
| 217 | RpcTransportFd clientSocket(unique_fd(TEMP_FAILURE_RETRY( |
| 218 | accept4(server.mServer.fd.get(), nullptr, nullptr, SOCK_CLOEXEC | SOCK_NONBLOCK)))); |
Tomasz Wasilczyk | bfb13a8 | 2023-11-14 11:33:10 -0800 | [diff] [blame] | 219 | if (!clientSocket.fd.ok()) { |
David Brazdil | 21c887c | 2022-09-23 12:25:18 +0100 | [diff] [blame] | 220 | int savedErrno = errno; |
| 221 | ALOGE("Could not accept4 socket: %s", strerror(savedErrno)); |
| 222 | return -savedErrno; |
| 223 | } |
| 224 | |
| 225 | *out = std::move(clientSocket); |
| 226 | return OK; |
| 227 | } |
| 228 | |
| 229 | status_t RpcServer::recvmsgSocketConnection(const RpcServer& server, RpcTransportFd* out) { |
| 230 | int zero = 0; |
| 231 | iovec iov{&zero, sizeof(zero)}; |
Tomasz Wasilczyk | 639490b | 2023-11-01 13:49:41 -0700 | [diff] [blame] | 232 | std::vector<std::variant<unique_fd, borrowed_fd>> fds; |
David Brazdil | 21c887c | 2022-09-23 12:25:18 +0100 | [diff] [blame] | 233 | |
Tomasz Wasilczyk | 0d9dec2 | 2023-10-06 20:28:49 +0000 | [diff] [blame] | 234 | ssize_t num_bytes = binder::os::receiveMessageFromSocket(server.mServer, &iov, 1, &fds); |
David Brazdil | 8a74190 | 2022-12-17 21:41:04 +0000 | [diff] [blame] | 235 | if (num_bytes < 0) { |
David Brazdil | 21c887c | 2022-09-23 12:25:18 +0100 | [diff] [blame] | 236 | int savedErrno = errno; |
| 237 | ALOGE("Failed recvmsg: %s", strerror(savedErrno)); |
| 238 | return -savedErrno; |
| 239 | } |
David Brazdil | 8a74190 | 2022-12-17 21:41:04 +0000 | [diff] [blame] | 240 | if (num_bytes == 0) { |
| 241 | return DEAD_OBJECT; |
| 242 | } |
David Brazdil | 21c887c | 2022-09-23 12:25:18 +0100 | [diff] [blame] | 243 | if (fds.size() != 1) { |
| 244 | ALOGE("Expected exactly one fd from recvmsg, got %zu", fds.size()); |
| 245 | return -EINVAL; |
| 246 | } |
| 247 | |
| 248 | unique_fd fd(std::move(std::get<unique_fd>(fds.back()))); |
Tomasz Wasilczyk | 88aa8c3 | 2023-11-01 09:46:07 -0700 | [diff] [blame] | 249 | if (status_t res = binder::os::setNonBlocking(fd); res != OK) return res; |
David Brazdil | 21c887c | 2022-09-23 12:25:18 +0100 | [diff] [blame] | 250 | |
| 251 | *out = RpcTransportFd(std::move(fd)); |
| 252 | return OK; |
| 253 | } |
| 254 | |
Steven Moreland | 611d15f | 2021-05-01 01:28:27 +0000 | [diff] [blame] | 255 | void RpcServer::join() { |
Yifan Hong | 1a23585 | 2021-05-13 16:07:47 -0700 | [diff] [blame] | 256 | |
| 257 | { |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 258 | RpcMutexLockGuard _l(mLock); |
Pawan | 49d74cb | 2022-08-03 21:19:11 +0000 | [diff] [blame] | 259 | LOG_ALWAYS_FATAL_IF(!mServer.fd.ok(), "RpcServer must be setup to join."); |
David Brazdil | 21c887c | 2022-09-23 12:25:18 +0100 | [diff] [blame] | 260 | LOG_ALWAYS_FATAL_IF(mAcceptFn == nullptr, "RpcServer must have an accept() function"); |
Yifan Hong | 1a23585 | 2021-05-13 16:07:47 -0700 | [diff] [blame] | 261 | LOG_ALWAYS_FATAL_IF(mShutdownTrigger != nullptr, "Already joined"); |
| 262 | mJoinThreadRunning = true; |
Yifan Hong | 8c95042 | 2021-08-05 17:13:55 -0700 | [diff] [blame] | 263 | mShutdownTrigger = FdTrigger::make(); |
Yifan Hong | 1a23585 | 2021-05-13 16:07:47 -0700 | [diff] [blame] | 264 | LOG_ALWAYS_FATAL_IF(mShutdownTrigger == nullptr, "Cannot create join signaler"); |
Steven Moreland | d539fbf | 2021-05-05 23:40:25 +0000 | [diff] [blame] | 265 | } |
Yifan Hong | 1a23585 | 2021-05-13 16:07:47 -0700 | [diff] [blame] | 266 | |
Steven Moreland | 2b4f380 | 2021-05-22 01:46:27 +0000 | [diff] [blame] | 267 | status_t status; |
Steven Moreland | 798e0d1 | 2021-07-14 23:19:25 +0000 | [diff] [blame] | 268 | while ((status = mShutdownTrigger->triggerablePoll(mServer, POLLIN)) == OK) { |
Andrei Homescu | 86124ca | 2022-04-21 22:22:48 +0000 | [diff] [blame] | 269 | std::array<uint8_t, kRpcAddressSize> addr; |
| 270 | static_assert(addr.size() >= sizeof(sockaddr_storage), "kRpcAddressSize is too small"); |
Andrei Homescu | 86124ca | 2022-04-21 22:22:48 +0000 | [diff] [blame] | 271 | socklen_t addrLen = addr.size(); |
Steven Moreland | 51c44a9 | 2021-10-14 16:50:35 -0700 | [diff] [blame] | 272 | |
David Brazdil | 21c887c | 2022-09-23 12:25:18 +0100 | [diff] [blame] | 273 | RpcTransportFd clientSocket; |
David Brazdil | 8a74190 | 2022-12-17 21:41:04 +0000 | [diff] [blame] | 274 | if ((status = mAcceptFn(*this, &clientSocket)) != OK) { |
| 275 | if (status == DEAD_OBJECT) |
| 276 | break; |
| 277 | else |
| 278 | continue; |
Steven Moreland | 410325a | 2021-06-02 18:37:42 +0000 | [diff] [blame] | 279 | } |
David Brazdil | a47dfda | 2022-11-22 22:52:19 +0000 | [diff] [blame] | 280 | |
| 281 | LOG_RPC_DETAIL("accept on fd %d yields fd %d", mServer.fd.get(), clientSocket.fd.get()); |
| 282 | |
David Brazdil | 21c887c | 2022-09-23 12:25:18 +0100 | [diff] [blame] | 283 | if (getpeername(clientSocket.fd.get(), reinterpret_cast<sockaddr*>(addr.data()), |
| 284 | &addrLen)) { |
| 285 | ALOGE("Could not getpeername socket: %s", strerror(errno)); |
| 286 | continue; |
| 287 | } |
| 288 | |
David Brazdil | a47dfda | 2022-11-22 22:52:19 +0000 | [diff] [blame] | 289 | if (mConnectionFilter != nullptr && !mConnectionFilter(addr.data(), addrLen)) { |
| 290 | ALOGE("Dropped client connection fd %d", clientSocket.fd.get()); |
| 291 | continue; |
| 292 | } |
Steven Moreland | 410325a | 2021-06-02 18:37:42 +0000 | [diff] [blame] | 293 | |
| 294 | { |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 295 | RpcMutexLockGuard _l(mLock); |
Andrei Homescu | 74a5445 | 2021-12-10 05:30:21 +0000 | [diff] [blame] | 296 | RpcMaybeThread thread = |
| 297 | RpcMaybeThread(&RpcServer::establishConnection, |
Pawan | 49d74cb | 2022-08-03 21:19:11 +0000 | [diff] [blame] | 298 | sp<RpcServer>::fromExisting(this), std::move(clientSocket), addr, |
Andrei Homescu | 74a5445 | 2021-12-10 05:30:21 +0000 | [diff] [blame] | 299 | addrLen, RpcSession::join); |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 300 | |
| 301 | auto& threadRef = mConnectingThreads[thread.get_id()]; |
| 302 | threadRef = std::move(thread); |
| 303 | rpcJoinIfSingleThreaded(threadRef); |
Steven Moreland | 410325a | 2021-06-02 18:37:42 +0000 | [diff] [blame] | 304 | } |
Yifan Hong | 1a23585 | 2021-05-13 16:07:47 -0700 | [diff] [blame] | 305 | } |
Steven Moreland | 2b4f380 | 2021-05-22 01:46:27 +0000 | [diff] [blame] | 306 | LOG_RPC_DETAIL("RpcServer::join exiting with %s", statusToString(status).c_str()); |
Yifan Hong | 1a23585 | 2021-05-13 16:07:47 -0700 | [diff] [blame] | 307 | |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 308 | if constexpr (kEnableRpcThreads) { |
| 309 | RpcMutexLockGuard _l(mLock); |
Yifan Hong | 1a23585 | 2021-05-13 16:07:47 -0700 | [diff] [blame] | 310 | mJoinThreadRunning = false; |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 311 | } else { |
| 312 | // Multi-threaded builds clear this in shutdown(), but we need it valid |
| 313 | // so the loop above exits cleanly |
| 314 | mShutdownTrigger = nullptr; |
Yifan Hong | 1a23585 | 2021-05-13 16:07:47 -0700 | [diff] [blame] | 315 | } |
| 316 | mShutdownCv.notify_all(); |
Steven Moreland | d539fbf | 2021-05-05 23:40:25 +0000 | [diff] [blame] | 317 | } |
| 318 | |
Yifan Hong | 1a23585 | 2021-05-13 16:07:47 -0700 | [diff] [blame] | 319 | bool RpcServer::shutdown() { |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 320 | RpcMutexUniqueLock _l(mLock); |
Steven Moreland | 9d11b92 | 2021-05-20 01:22:58 +0000 | [diff] [blame] | 321 | if (mShutdownTrigger == nullptr) { |
Devin Moore | 06add17 | 2023-03-22 22:49:29 +0000 | [diff] [blame] | 322 | LOG_RPC_DETAIL("Cannot shutdown. No shutdown trigger installed (already shutdown, or not " |
| 323 | "joined yet?)"); |
Steven Moreland | 9d11b92 | 2021-05-20 01:22:58 +0000 | [diff] [blame] | 324 | return false; |
| 325 | } |
Yifan Hong | 1a23585 | 2021-05-13 16:07:47 -0700 | [diff] [blame] | 326 | |
| 327 | mShutdownTrigger->trigger(); |
Steven Moreland | ab3f442 | 2021-09-27 18:38:20 -0700 | [diff] [blame] | 328 | |
Steven Moreland | a8b4429 | 2021-06-08 01:27:53 +0000 | [diff] [blame] | 329 | for (auto& [id, session] : mSessions) { |
| 330 | (void)id; |
Steven Moreland | ab3f442 | 2021-09-27 18:38:20 -0700 | [diff] [blame] | 331 | // server lock is a more general lock |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 332 | RpcMutexLockGuard _lSession(session->mMutex); |
Steven Moreland | a8b4429 | 2021-06-08 01:27:53 +0000 | [diff] [blame] | 333 | session->mShutdownTrigger->trigger(); |
| 334 | } |
| 335 | |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 336 | if constexpr (!kEnableRpcThreads) { |
| 337 | // In single-threaded mode we're done here, everything else that |
| 338 | // needs to happen should be at the end of RpcServer::join() |
| 339 | return true; |
| 340 | } |
| 341 | |
Steven Moreland | ee3f466 | 2021-05-22 01:07:33 +0000 | [diff] [blame] | 342 | while (mJoinThreadRunning || !mConnectingThreads.empty() || !mSessions.empty()) { |
Steven Moreland | af4ca71 | 2021-05-24 23:22:08 +0000 | [diff] [blame] | 343 | if (std::cv_status::timeout == mShutdownCv.wait_for(_l, std::chrono::seconds(1))) { |
| 344 | ALOGE("Waiting for RpcServer to shut down (1s w/o progress). Join thread running: %d, " |
| 345 | "Connecting threads: " |
| 346 | "%zu, Sessions: %zu. Is your server deadlocked?", |
| 347 | mJoinThreadRunning, mConnectingThreads.size(), mSessions.size()); |
| 348 | } |
Steven Moreland | 9d11b92 | 2021-05-20 01:22:58 +0000 | [diff] [blame] | 349 | } |
Yifan Hong | 1a23585 | 2021-05-13 16:07:47 -0700 | [diff] [blame] | 350 | |
Yifan Hong | 326afd1 | 2021-05-19 15:24:54 -0700 | [diff] [blame] | 351 | // At this point, we know join() is about to exit, but the thread that calls |
| 352 | // join() may not have exited yet. |
| 353 | // If RpcServer owns the join thread (aka start() is called), make sure the thread exits; |
| 354 | // otherwise ~thread() may call std::terminate(), which may crash the process. |
| 355 | // If RpcServer does not own the join thread (aka join() is called directly), |
| 356 | // then the owner of RpcServer is responsible for cleaning up that thread. |
| 357 | if (mJoinThread.get()) { |
| 358 | mJoinThread->join(); |
| 359 | mJoinThread.reset(); |
| 360 | } |
| 361 | |
Tomasz Wasilczyk | 7c8dd48 | 2023-03-23 15:30:03 -0700 | [diff] [blame] | 362 | mServer = RpcTransportFd(); |
| 363 | |
Steven Moreland | 1c943ec | 2021-07-13 23:57:56 +0000 | [diff] [blame] | 364 | LOG_RPC_DETAIL("Finished waiting on shutdown."); |
| 365 | |
Yifan Hong | 1a23585 | 2021-05-13 16:07:47 -0700 | [diff] [blame] | 366 | mShutdownTrigger = nullptr; |
| 367 | return true; |
| 368 | } |
| 369 | |
Steven Moreland | bdb53ab | 2021-05-05 17:57:41 +0000 | [diff] [blame] | 370 | std::vector<sp<RpcSession>> RpcServer::listSessions() { |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 371 | RpcMutexLockGuard _l(mLock); |
Steven Moreland | bdb53ab | 2021-05-05 17:57:41 +0000 | [diff] [blame] | 372 | std::vector<sp<RpcSession>> sessions; |
| 373 | for (auto& [id, session] : mSessions) { |
Steven Moreland | 736664b | 2021-05-01 04:27:25 +0000 | [diff] [blame] | 374 | (void)id; |
Steven Moreland | bdb53ab | 2021-05-05 17:57:41 +0000 | [diff] [blame] | 375 | sessions.push_back(session); |
Steven Moreland | 736664b | 2021-05-01 04:27:25 +0000 | [diff] [blame] | 376 | } |
Steven Moreland | bdb53ab | 2021-05-05 17:57:41 +0000 | [diff] [blame] | 377 | return sessions; |
Steven Moreland | 611d15f | 2021-05-01 01:28:27 +0000 | [diff] [blame] | 378 | } |
| 379 | |
Steven Moreland | d539fbf | 2021-05-05 23:40:25 +0000 | [diff] [blame] | 380 | size_t RpcServer::numUninitializedSessions() { |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 381 | RpcMutexLockGuard _l(mLock); |
Steven Moreland | d539fbf | 2021-05-05 23:40:25 +0000 | [diff] [blame] | 382 | return mConnectingThreads.size(); |
| 383 | } |
| 384 | |
Andrei Homescu | 74a5445 | 2021-12-10 05:30:21 +0000 | [diff] [blame] | 385 | void RpcServer::establishConnection( |
Pawan | 3e0061c | 2022-08-26 21:08:34 +0000 | [diff] [blame] | 386 | sp<RpcServer>&& server, RpcTransportFd clientFd, std::array<uint8_t, kRpcAddressSize> addr, |
Andrei Homescu | 74a5445 | 2021-12-10 05:30:21 +0000 | [diff] [blame] | 387 | size_t addrLen, |
| 388 | std::function<void(sp<RpcSession>&&, RpcSession::PreJoinSetupResult&&)>&& joinFn) { |
Steven Moreland | 9d11b92 | 2021-05-20 01:22:58 +0000 | [diff] [blame] | 389 | // mShutdownTrigger can only be cleared once connection threads have joined. |
| 390 | // It must be set before this thread is started |
| 391 | LOG_ALWAYS_FATAL_IF(server->mShutdownTrigger == nullptr); |
Yifan Hong | 702115c | 2021-06-24 15:39:18 -0700 | [diff] [blame] | 392 | LOG_ALWAYS_FATAL_IF(server->mCtx == nullptr); |
| 393 | |
| 394 | status_t status = OK; |
| 395 | |
Pawan | 49d74cb | 2022-08-03 21:19:11 +0000 | [diff] [blame] | 396 | int clientFdForLog = clientFd.fd.get(); |
Yifan Hong | f6d4229 | 2021-08-05 23:43:05 -0700 | [diff] [blame] | 397 | auto client = server->mCtx->newTransport(std::move(clientFd), server->mShutdownTrigger.get()); |
Yifan Hong | 702115c | 2021-06-24 15:39:18 -0700 | [diff] [blame] | 398 | if (client == nullptr) { |
| 399 | ALOGE("Dropping accept4()-ed socket because sslAccept fails"); |
| 400 | status = DEAD_OBJECT; |
| 401 | // still need to cleanup before we can return |
| 402 | } else { |
| 403 | LOG_RPC_DETAIL("Created RpcTransport %p for client fd %d", client.get(), clientFdForLog); |
| 404 | } |
Steven Moreland | 9d11b92 | 2021-05-20 01:22:58 +0000 | [diff] [blame] | 405 | |
Steven Moreland | 659416d | 2021-05-11 00:47:50 +0000 | [diff] [blame] | 406 | RpcConnectionHeader header; |
Yifan Hong | 702115c | 2021-06-24 15:39:18 -0700 | [diff] [blame] | 407 | if (status == OK) { |
Andrei Homescu | a39e4ed | 2021-12-10 08:41:54 +0000 | [diff] [blame] | 408 | iovec iov{&header, sizeof(header)}; |
Devin Moore | 695368f | 2022-06-03 22:29:14 +0000 | [diff] [blame] | 409 | status = client->interruptableReadFully(server->mShutdownTrigger.get(), &iov, 1, |
Frederick Mayle | ffe9ac2 | 2022-06-30 02:07:36 +0000 | [diff] [blame] | 410 | std::nullopt, /*ancillaryFds=*/nullptr); |
Yifan Hong | 702115c | 2021-06-24 15:39:18 -0700 | [diff] [blame] | 411 | if (status != OK) { |
| 412 | ALOGE("Failed to read ID for client connecting to RPC server: %s", |
| 413 | statusToString(status).c_str()); |
| 414 | // still need to cleanup before we can return |
| 415 | } |
Steven Moreland | a63ff93 | 2021-05-12 00:03:15 +0000 | [diff] [blame] | 416 | } |
Steven Moreland | bf57bce | 2021-07-26 15:26:12 -0700 | [diff] [blame] | 417 | |
Steven Moreland | 826367f | 2021-09-10 14:05:31 -0700 | [diff] [blame] | 418 | std::vector<uint8_t> sessionId; |
| 419 | if (status == OK) { |
| 420 | if (header.sessionIdSize > 0) { |
Steven Moreland | c503204 | 2021-09-30 15:40:27 -0700 | [diff] [blame] | 421 | if (header.sessionIdSize == kSessionIdBytes) { |
| 422 | sessionId.resize(header.sessionIdSize); |
Andrei Homescu | a39e4ed | 2021-12-10 08:41:54 +0000 | [diff] [blame] | 423 | iovec iov{sessionId.data(), sessionId.size()}; |
Devin Moore | 695368f | 2022-06-03 22:29:14 +0000 | [diff] [blame] | 424 | status = client->interruptableReadFully(server->mShutdownTrigger.get(), &iov, 1, |
Frederick Mayle | ffe9ac2 | 2022-06-30 02:07:36 +0000 | [diff] [blame] | 425 | std::nullopt, /*ancillaryFds=*/nullptr); |
Steven Moreland | c503204 | 2021-09-30 15:40:27 -0700 | [diff] [blame] | 426 | if (status != OK) { |
| 427 | ALOGE("Failed to read session ID for client connecting to RPC server: %s", |
| 428 | statusToString(status).c_str()); |
| 429 | // still need to cleanup before we can return |
| 430 | } |
| 431 | } else { |
| 432 | ALOGE("Malformed session ID. Expecting session ID of size %zu but got %" PRIu16, |
| 433 | kSessionIdBytes, header.sessionIdSize); |
| 434 | status = BAD_VALUE; |
Steven Moreland | 826367f | 2021-09-10 14:05:31 -0700 | [diff] [blame] | 435 | } |
| 436 | } |
| 437 | } |
| 438 | |
Steven Moreland | bf57bce | 2021-07-26 15:26:12 -0700 | [diff] [blame] | 439 | bool incoming = false; |
| 440 | uint32_t protocolVersion = 0; |
Steven Moreland | bf57bce | 2021-07-26 15:26:12 -0700 | [diff] [blame] | 441 | bool requestingNewSession = false; |
| 442 | |
| 443 | if (status == OK) { |
| 444 | incoming = header.options & RPC_CONNECTION_OPTION_INCOMING; |
| 445 | protocolVersion = std::min(header.version, |
| 446 | server->mProtocolVersion.value_or(RPC_WIRE_PROTOCOL_VERSION)); |
Steven Moreland | 826367f | 2021-09-10 14:05:31 -0700 | [diff] [blame] | 447 | requestingNewSession = sessionId.empty(); |
Steven Moreland | bf57bce | 2021-07-26 15:26:12 -0700 | [diff] [blame] | 448 | |
| 449 | if (requestingNewSession) { |
| 450 | RpcNewSessionResponse response{ |
| 451 | .version = protocolVersion, |
| 452 | }; |
| 453 | |
Andrei Homescu | a39e4ed | 2021-12-10 08:41:54 +0000 | [diff] [blame] | 454 | iovec iov{&response, sizeof(response)}; |
Devin Moore | 695368f | 2022-06-03 22:29:14 +0000 | [diff] [blame] | 455 | status = client->interruptableWriteFully(server->mShutdownTrigger.get(), &iov, 1, |
Frederick Mayle | 69a0c99 | 2022-05-26 20:38:39 +0000 | [diff] [blame] | 456 | std::nullopt, nullptr); |
Steven Moreland | bf57bce | 2021-07-26 15:26:12 -0700 | [diff] [blame] | 457 | if (status != OK) { |
| 458 | ALOGE("Failed to send new session response: %s", statusToString(status).c_str()); |
| 459 | // still need to cleanup before we can return |
| 460 | } |
| 461 | } |
| 462 | } |
Steven Moreland | a63ff93 | 2021-05-12 00:03:15 +0000 | [diff] [blame] | 463 | |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 464 | RpcMaybeThread thisThread; |
Steven Moreland | a63ff93 | 2021-05-12 00:03:15 +0000 | [diff] [blame] | 465 | sp<RpcSession> session; |
| 466 | { |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 467 | RpcMutexUniqueLock _l(server->mLock); |
Steven Moreland | a63ff93 | 2021-05-12 00:03:15 +0000 | [diff] [blame] | 468 | |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 469 | auto threadId = server->mConnectingThreads.find(rpc_this_thread::get_id()); |
Yifan Hong | b300550 | 2021-05-19 15:37:00 -0700 | [diff] [blame] | 470 | LOG_ALWAYS_FATAL_IF(threadId == server->mConnectingThreads.end(), |
Steven Moreland | a63ff93 | 2021-05-12 00:03:15 +0000 | [diff] [blame] | 471 | "Must establish connection on owned thread"); |
| 472 | thisThread = std::move(threadId->second); |
Tomasz Wasilczyk | 1de48a2 | 2023-10-30 14:19:19 +0000 | [diff] [blame] | 473 | auto detachGuardLambda = [&]() { |
Steven Moreland | adc5dca | 2021-05-25 02:06:03 +0000 | [diff] [blame] | 474 | thisThread.detach(); |
Steven Moreland | 9d11b92 | 2021-05-20 01:22:58 +0000 | [diff] [blame] | 475 | _l.unlock(); |
| 476 | server->mShutdownCv.notify_all(); |
| 477 | }; |
Tomasz Wasilczyk | 1de48a2 | 2023-10-30 14:19:19 +0000 | [diff] [blame] | 478 | auto detachGuard = make_scope_guard(std::ref(detachGuardLambda)); |
Steven Moreland | adc5dca | 2021-05-25 02:06:03 +0000 | [diff] [blame] | 479 | server->mConnectingThreads.erase(threadId); |
Steven Moreland | 9d11b92 | 2021-05-20 01:22:58 +0000 | [diff] [blame] | 480 | |
Steven Moreland | bf57bce | 2021-07-26 15:26:12 -0700 | [diff] [blame] | 481 | if (status != OK || server->mShutdownTrigger->isTriggered()) { |
Steven Moreland | 5802c2b | 2021-05-12 20:13:04 +0000 | [diff] [blame] | 482 | return; |
| 483 | } |
| 484 | |
Steven Moreland | bf57bce | 2021-07-26 15:26:12 -0700 | [diff] [blame] | 485 | if (requestingNewSession) { |
Steven Moreland | 1b30429 | 2021-07-15 22:59:34 +0000 | [diff] [blame] | 486 | if (incoming) { |
| 487 | ALOGE("Cannot create a new session with an incoming connection, would leak"); |
Steven Moreland | 659416d | 2021-05-11 00:47:50 +0000 | [diff] [blame] | 488 | return; |
| 489 | } |
| 490 | |
Steven Moreland | 826367f | 2021-09-10 14:05:31 -0700 | [diff] [blame] | 491 | // Uniquely identify session at the application layer. Even if a |
| 492 | // client/server use the same certificates, if they create multiple |
| 493 | // sessions, we still want to distinguish between them. |
Steven Moreland | c503204 | 2021-09-30 15:40:27 -0700 | [diff] [blame] | 494 | sessionId.resize(kSessionIdBytes); |
Steven Moreland | 01a6bad | 2021-06-11 00:59:20 +0000 | [diff] [blame] | 495 | size_t tries = 0; |
| 496 | do { |
| 497 | // don't block if there is some entropy issue |
| 498 | if (tries++ > 5) { |
Steven Moreland | 826367f | 2021-09-10 14:05:31 -0700 | [diff] [blame] | 499 | ALOGE("Cannot find new address: %s", |
Tomasz Wasilczyk | 891f6b0 | 2023-10-11 18:35:42 +0000 | [diff] [blame] | 500 | HexString(sessionId.data(), sessionId.size()).c_str()); |
Steven Moreland | 01a6bad | 2021-06-11 00:59:20 +0000 | [diff] [blame] | 501 | return; |
| 502 | } |
| 503 | |
Tomasz Wasilczyk | 0d9dec2 | 2023-10-06 20:28:49 +0000 | [diff] [blame] | 504 | auto status = binder::os::getRandomBytes(sessionId.data(), sessionId.size()); |
Andrei Homescu | c24c879 | 2022-04-19 00:24:51 +0000 | [diff] [blame] | 505 | if (status != OK) { |
| 506 | ALOGE("Failed to read random session ID: %s", strerror(-status)); |
Steven Moreland | 826367f | 2021-09-10 14:05:31 -0700 | [diff] [blame] | 507 | return; |
| 508 | } |
Steven Moreland | 01a6bad | 2021-06-11 00:59:20 +0000 | [diff] [blame] | 509 | } while (server->mSessions.end() != server->mSessions.find(sessionId)); |
Steven Moreland | a63ff93 | 2021-05-12 00:03:15 +0000 | [diff] [blame] | 510 | |
Andrei Homescu | 5e30146 | 2022-05-12 00:52:34 +0000 | [diff] [blame] | 511 | session = sp<RpcSession>::make(nullptr); |
Yifan Hong | 1042306 | 2021-10-08 16:26:32 -0700 | [diff] [blame] | 512 | session->setMaxIncomingThreads(server->mMaxThreads); |
Steven Moreland | bf57bce | 2021-07-26 15:26:12 -0700 | [diff] [blame] | 513 | if (!session->setProtocolVersion(protocolVersion)) return; |
Steven Moreland | 51c44a9 | 2021-10-14 16:50:35 -0700 | [diff] [blame] | 514 | |
Frederick Mayle | 26b494e | 2022-07-08 22:09:58 +0000 | [diff] [blame] | 515 | if (header.fileDescriptorTransportMode < |
| 516 | server->mSupportedFileDescriptorTransportModes.size() && |
| 517 | server->mSupportedFileDescriptorTransportModes.test( |
Frederick Mayle | 69a0c99 | 2022-05-26 20:38:39 +0000 | [diff] [blame] | 518 | header.fileDescriptorTransportMode)) { |
| 519 | session->setFileDescriptorTransportMode( |
| 520 | static_cast<RpcSession::FileDescriptorTransportMode>( |
| 521 | header.fileDescriptorTransportMode)); |
| 522 | } else { |
| 523 | ALOGE("Rejecting connection: FileDescriptorTransportMode is not supported: %hhu", |
| 524 | header.fileDescriptorTransportMode); |
| 525 | return; |
| 526 | } |
| 527 | |
Steven Moreland | 51c44a9 | 2021-10-14 16:50:35 -0700 | [diff] [blame] | 528 | // if null, falls back to server root |
| 529 | sp<IBinder> sessionSpecificRoot; |
| 530 | if (server->mRootObjectFactory != nullptr) { |
Steven Moreland | dfb9218 | 2023-05-24 17:48:59 +0000 | [diff] [blame] | 531 | sessionSpecificRoot = |
| 532 | server->mRootObjectFactory(wp<RpcSession>(session), addr.data(), addrLen); |
Steven Moreland | 51c44a9 | 2021-10-14 16:50:35 -0700 | [diff] [blame] | 533 | if (sessionSpecificRoot == nullptr) { |
| 534 | ALOGE("Warning: server returned null from root object factory"); |
| 535 | } |
| 536 | } |
| 537 | |
Steven Moreland | a8b4429 | 2021-06-08 01:27:53 +0000 | [diff] [blame] | 538 | if (!session->setForServer(server, |
| 539 | sp<RpcServer::EventListener>::fromExisting( |
| 540 | static_cast<RpcServer::EventListener*>( |
| 541 | server.get())), |
Steven Moreland | 51c44a9 | 2021-10-14 16:50:35 -0700 | [diff] [blame] | 542 | sessionId, sessionSpecificRoot)) { |
Steven Moreland | a8b4429 | 2021-06-08 01:27:53 +0000 | [diff] [blame] | 543 | ALOGE("Failed to attach server to session"); |
| 544 | return; |
| 545 | } |
Steven Moreland | a63ff93 | 2021-05-12 00:03:15 +0000 | [diff] [blame] | 546 | |
Steven Moreland | 01a6bad | 2021-06-11 00:59:20 +0000 | [diff] [blame] | 547 | server->mSessions[sessionId] = session; |
Steven Moreland | a63ff93 | 2021-05-12 00:03:15 +0000 | [diff] [blame] | 548 | } else { |
Steven Moreland | 01a6bad | 2021-06-11 00:59:20 +0000 | [diff] [blame] | 549 | auto it = server->mSessions.find(sessionId); |
Yifan Hong | b300550 | 2021-05-19 15:37:00 -0700 | [diff] [blame] | 550 | if (it == server->mSessions.end()) { |
Steven Moreland | 01a6bad | 2021-06-11 00:59:20 +0000 | [diff] [blame] | 551 | ALOGE("Cannot add thread, no record of session with ID %s", |
Tomasz Wasilczyk | 891f6b0 | 2023-10-11 18:35:42 +0000 | [diff] [blame] | 552 | HexString(sessionId.data(), sessionId.size()).c_str()); |
Steven Moreland | a63ff93 | 2021-05-12 00:03:15 +0000 | [diff] [blame] | 553 | return; |
| 554 | } |
| 555 | session = it->second; |
| 556 | } |
Steven Moreland | 5802c2b | 2021-05-12 20:13:04 +0000 | [diff] [blame] | 557 | |
Steven Moreland | 1b30429 | 2021-07-15 22:59:34 +0000 | [diff] [blame] | 558 | if (incoming) { |
Steven Moreland | 2372f9d | 2021-08-05 15:42:01 -0700 | [diff] [blame] | 559 | LOG_ALWAYS_FATAL_IF(OK != session->addOutgoingConnection(std::move(client), true), |
Steven Moreland | 659416d | 2021-05-11 00:47:50 +0000 | [diff] [blame] | 560 | "server state must already be initialized"); |
| 561 | return; |
| 562 | } |
| 563 | |
Tomasz Wasilczyk | 1de48a2 | 2023-10-30 14:19:19 +0000 | [diff] [blame] | 564 | detachGuard.release(); |
Steven Moreland | c88b7fc | 2021-06-10 00:40:39 +0000 | [diff] [blame] | 565 | session->preJoinThreadOwnership(std::move(thisThread)); |
Steven Moreland | a63ff93 | 2021-05-12 00:03:15 +0000 | [diff] [blame] | 566 | } |
| 567 | |
Yifan Hong | 702115c | 2021-06-24 15:39:18 -0700 | [diff] [blame] | 568 | auto setupResult = session->preJoinSetup(std::move(client)); |
Steven Moreland | c88b7fc | 2021-06-10 00:40:39 +0000 | [diff] [blame] | 569 | |
Steven Moreland | a63ff93 | 2021-05-12 00:03:15 +0000 | [diff] [blame] | 570 | // avoid strong cycle |
| 571 | server = nullptr; |
Steven Moreland | a63ff93 | 2021-05-12 00:03:15 +0000 | [diff] [blame] | 572 | |
Andrei Homescu | 74a5445 | 2021-12-10 05:30:21 +0000 | [diff] [blame] | 573 | joinFn(std::move(session), std::move(setupResult)); |
Steven Moreland | a63ff93 | 2021-05-12 00:03:15 +0000 | [diff] [blame] | 574 | } |
| 575 | |
Steven Moreland | 2372f9d | 2021-08-05 15:42:01 -0700 | [diff] [blame] | 576 | status_t RpcServer::setupSocketServer(const RpcSocketAddress& addr) { |
Steven Moreland | 704fc1a | 2021-05-04 23:13:14 +0000 | [diff] [blame] | 577 | LOG_RPC_DETAIL("Setting up socket server %s", addr.toString().c_str()); |
Yifan Hong | 0eb5a67 | 2021-05-12 18:00:25 -0700 | [diff] [blame] | 578 | LOG_ALWAYS_FATAL_IF(hasServer(), "Each RpcServer can only have one server."); |
Steven Moreland | 611d15f | 2021-05-01 01:28:27 +0000 | [diff] [blame] | 579 | |
Alice Wang | 0b138ed | 2022-11-15 16:22:44 +0000 | [diff] [blame] | 580 | unique_fd socket_fd(TEMP_FAILURE_RETRY( |
| 581 | socket(addr.addr()->sa_family, SOCK_STREAM | SOCK_CLOEXEC | SOCK_NONBLOCK, 0))); |
| 582 | if (!socket_fd.ok()) { |
Steven Moreland | 2372f9d | 2021-08-05 15:42:01 -0700 | [diff] [blame] | 583 | int savedErrno = errno; |
Steven Moreland | 8925ebb | 2023-04-10 21:52:17 +0000 | [diff] [blame] | 584 | ALOGE("Could not create socket at %s: %s", addr.toString().c_str(), strerror(savedErrno)); |
Steven Moreland | 2372f9d | 2021-08-05 15:42:01 -0700 | [diff] [blame] | 585 | return -savedErrno; |
Steven Moreland | 611d15f | 2021-05-01 01:28:27 +0000 | [diff] [blame] | 586 | } |
Tomasz Wasilczyk | 7c8dd48 | 2023-03-23 15:30:03 -0700 | [diff] [blame] | 587 | |
Keith Mok | 442907b | 2023-10-11 20:36:18 +0000 | [diff] [blame] | 588 | if (addr.addr()->sa_family == AF_INET || addr.addr()->sa_family == AF_INET6) { |
| 589 | int noDelay = 1; |
| 590 | int result = |
| 591 | setsockopt(socket_fd.get(), IPPROTO_TCP, TCP_NODELAY, &noDelay, sizeof(noDelay)); |
| 592 | if (result < 0) { |
| 593 | int savedErrno = errno; |
| 594 | ALOGE("Could not set TCP_NODELAY on %s", strerror(savedErrno)); |
| 595 | return -savedErrno; |
| 596 | } |
| 597 | } |
| 598 | |
Tomasz Wasilczyk | 7c8dd48 | 2023-03-23 15:30:03 -0700 | [diff] [blame] | 599 | { |
| 600 | RpcMutexLockGuard _l(mLock); |
| 601 | if (mServerSocketModifier != nullptr) { |
| 602 | mServerSocketModifier(socket_fd); |
| 603 | } |
| 604 | } |
| 605 | |
Alice Wang | 0b138ed | 2022-11-15 16:22:44 +0000 | [diff] [blame] | 606 | if (0 != TEMP_FAILURE_RETRY(bind(socket_fd.get(), addr.addr(), addr.addrSize()))) { |
Steven Moreland | 611d15f | 2021-05-01 01:28:27 +0000 | [diff] [blame] | 607 | int savedErrno = errno; |
| 608 | ALOGE("Could not bind socket at %s: %s", addr.toString().c_str(), strerror(savedErrno)); |
Steven Moreland | 2372f9d | 2021-08-05 15:42:01 -0700 | [diff] [blame] | 609 | return -savedErrno; |
Steven Moreland | 611d15f | 2021-05-01 01:28:27 +0000 | [diff] [blame] | 610 | } |
| 611 | |
Alice Wang | 0b138ed | 2022-11-15 16:22:44 +0000 | [diff] [blame] | 612 | return setupRawSocketServer(std::move(socket_fd)); |
Steven Moreland | 611d15f | 2021-05-01 01:28:27 +0000 | [diff] [blame] | 613 | } |
| 614 | |
Alice Wang | 0b138ed | 2022-11-15 16:22:44 +0000 | [diff] [blame] | 615 | status_t RpcServer::setupRawSocketServer(unique_fd socket_fd) { |
Alice Wang | 30c204d | 2022-11-15 12:50:51 +0000 | [diff] [blame] | 616 | LOG_ALWAYS_FATAL_IF(!socket_fd.ok(), "Socket must be setup to listen."); |
Alice Wang | 30c204d | 2022-11-15 12:50:51 +0000 | [diff] [blame] | 617 | |
Alice Wang | 893a991 | 2022-10-24 10:44:09 +0000 | [diff] [blame] | 618 | // Right now, we create all threads at once, making accept4 slow. To avoid hanging the client, |
| 619 | // the backlog is increased to a large number. |
| 620 | // TODO(b/189955605): Once we create threads dynamically & lazily, the backlog can be reduced |
| 621 | // to 1. |
Alice Wang | df74178 | 2022-11-16 08:37:04 +0000 | [diff] [blame] | 622 | if (0 != TEMP_FAILURE_RETRY(listen(socket_fd.get(), 50 /*backlog*/))) { |
Alice Wang | 893a991 | 2022-10-24 10:44:09 +0000 | [diff] [blame] | 623 | int savedErrno = errno; |
| 624 | ALOGE("Could not listen initialized Unix socket: %s", strerror(savedErrno)); |
| 625 | return -savedErrno; |
| 626 | } |
Alice Wang | df74178 | 2022-11-16 08:37:04 +0000 | [diff] [blame] | 627 | if (status_t status = setupExternalServer(std::move(socket_fd)); status != OK) { |
Alice Wang | 893a991 | 2022-10-24 10:44:09 +0000 | [diff] [blame] | 628 | ALOGE("Another thread has set up server while calling setupSocketServer. Race?"); |
| 629 | return status; |
| 630 | } |
| 631 | return OK; |
| 632 | } |
| 633 | |
Steven Moreland | dd67b94 | 2021-07-23 17:15:41 -0700 | [diff] [blame] | 634 | void RpcServer::onSessionAllIncomingThreadsEnded(const sp<RpcSession>& session) { |
Steven Moreland | 826367f | 2021-09-10 14:05:31 -0700 | [diff] [blame] | 635 | const std::vector<uint8_t>& id = session->mId; |
| 636 | LOG_ALWAYS_FATAL_IF(id.empty(), "Server sessions must be initialized with ID"); |
Tomasz Wasilczyk | 891f6b0 | 2023-10-11 18:35:42 +0000 | [diff] [blame] | 637 | LOG_RPC_DETAIL("Dropping session with address %s", HexString(id.data(), id.size()).c_str()); |
Steven Moreland | ee78e76 | 2021-05-05 21:12:51 +0000 | [diff] [blame] | 638 | |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 639 | RpcMutexLockGuard _l(mLock); |
Steven Moreland | 826367f | 2021-09-10 14:05:31 -0700 | [diff] [blame] | 640 | auto it = mSessions.find(id); |
Steven Moreland | 01a6bad | 2021-06-11 00:59:20 +0000 | [diff] [blame] | 641 | LOG_ALWAYS_FATAL_IF(it == mSessions.end(), "Bad state, unknown session id %s", |
Tomasz Wasilczyk | 891f6b0 | 2023-10-11 18:35:42 +0000 | [diff] [blame] | 642 | HexString(id.data(), id.size()).c_str()); |
Steven Moreland | 01a6bad | 2021-06-11 00:59:20 +0000 | [diff] [blame] | 643 | LOG_ALWAYS_FATAL_IF(it->second != session, "Bad state, session has id mismatch %s", |
Tomasz Wasilczyk | 891f6b0 | 2023-10-11 18:35:42 +0000 | [diff] [blame] | 644 | HexString(id.data(), id.size()).c_str()); |
Steven Moreland | ee78e76 | 2021-05-05 21:12:51 +0000 | [diff] [blame] | 645 | (void)mSessions.erase(it); |
| 646 | } |
| 647 | |
Steven Moreland | 19fc9f7 | 2021-06-10 03:57:30 +0000 | [diff] [blame] | 648 | void RpcServer::onSessionIncomingThreadEnded() { |
Steven Moreland | ee3f466 | 2021-05-22 01:07:33 +0000 | [diff] [blame] | 649 | mShutdownCv.notify_all(); |
| 650 | } |
| 651 | |
Yifan Hong | 0eb5a67 | 2021-05-12 18:00:25 -0700 | [diff] [blame] | 652 | bool RpcServer::hasServer() { |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 653 | RpcMutexLockGuard _l(mLock); |
Pawan | 49d74cb | 2022-08-03 21:19:11 +0000 | [diff] [blame] | 654 | return mServer.fd.ok(); |
Yifan Hong | 0eb5a67 | 2021-05-12 18:00:25 -0700 | [diff] [blame] | 655 | } |
| 656 | |
Yifan Hong | 00aeb76 | 2021-05-12 17:07:36 -0700 | [diff] [blame] | 657 | unique_fd RpcServer::releaseServer() { |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 658 | RpcMutexLockGuard _l(mLock); |
Pawan | 49d74cb | 2022-08-03 21:19:11 +0000 | [diff] [blame] | 659 | return std::move(mServer.fd); |
Yifan Hong | 00aeb76 | 2021-05-12 17:07:36 -0700 | [diff] [blame] | 660 | } |
| 661 | |
David Brazdil | 21c887c | 2022-09-23 12:25:18 +0100 | [diff] [blame] | 662 | status_t RpcServer::setupExternalServer( |
Tomasz Wasilczyk | 639490b | 2023-11-01 13:49:41 -0700 | [diff] [blame] | 663 | unique_fd serverFd, std::function<status_t(const RpcServer&, RpcTransportFd*)>&& acceptFn) { |
Andrei Homescu | ffa3aaa | 2022-04-07 05:06:33 +0000 | [diff] [blame] | 664 | RpcMutexLockGuard _l(mLock); |
Pawan | 49d74cb | 2022-08-03 21:19:11 +0000 | [diff] [blame] | 665 | if (mServer.fd.ok()) { |
Yifan Hong | 00aeb76 | 2021-05-12 17:07:36 -0700 | [diff] [blame] | 666 | ALOGE("Each RpcServer can only have one server."); |
Steven Moreland | 2372f9d | 2021-08-05 15:42:01 -0700 | [diff] [blame] | 667 | return INVALID_OPERATION; |
Yifan Hong | 00aeb76 | 2021-05-12 17:07:36 -0700 | [diff] [blame] | 668 | } |
| 669 | mServer = std::move(serverFd); |
David Brazdil | 21c887c | 2022-09-23 12:25:18 +0100 | [diff] [blame] | 670 | mAcceptFn = std::move(acceptFn); |
Steven Moreland | 2372f9d | 2021-08-05 15:42:01 -0700 | [diff] [blame] | 671 | return OK; |
Yifan Hong | 00aeb76 | 2021-05-12 17:07:36 -0700 | [diff] [blame] | 672 | } |
| 673 | |
Tomasz Wasilczyk | 639490b | 2023-11-01 13:49:41 -0700 | [diff] [blame] | 674 | status_t RpcServer::setupExternalServer(unique_fd serverFd) { |
David Brazdil | 21c887c | 2022-09-23 12:25:18 +0100 | [diff] [blame] | 675 | return setupExternalServer(std::move(serverFd), &RpcServer::acceptSocketConnection); |
| 676 | } |
| 677 | |
Pawan | 1c24f9c | 2022-08-26 23:23:15 +0000 | [diff] [blame] | 678 | bool RpcServer::hasActiveRequests() { |
| 679 | RpcMutexLockGuard _l(mLock); |
| 680 | for (const auto& [_, session] : mSessions) { |
| 681 | if (session->hasActiveRequests()) { |
| 682 | return true; |
| 683 | } |
| 684 | } |
| 685 | return !mServer.isInPollingState(); |
| 686 | } |
| 687 | |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 688 | } // namespace android |