blob: fe6e1a33183368b79aa946a237eb55d0508e9210 [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 "RpcState"
18
19#include "RpcState.h"
20
21#include <binder/BpBinder.h>
Tomasz Wasilczyk1de48a22023-10-30 14:19:19 +000022#include <binder/Functional.h>
Steven Morelandd7302072021-05-15 01:32:04 +000023#include <binder/IPCThreadState.h>
Steven Moreland5553ac42020-11-11 02:14:45 +000024#include <binder/RpcServer.h>
25
26#include "Debug.h"
27#include "RpcWireFormat.h"
Frederick Mayledc07cf82022-05-26 20:30:12 +000028#include "Utils.h"
Steven Moreland5553ac42020-11-11 02:14:45 +000029
Steven Morelandb8176792021-06-22 20:29:21 +000030#include <random>
Tomasz Wasilczyk3caae302023-10-12 20:57:02 +000031#include <sstream>
Steven Morelandb8176792021-06-22 20:29:21 +000032
Steven Moreland5553ac42020-11-11 02:14:45 +000033#include <inttypes.h>
34
Steven Moreland09034a92023-05-31 20:49:11 +000035#ifdef __ANDROID__
36#include <cutils/properties.h>
37#endif
38
Steven Moreland5553ac42020-11-11 02:14:45 +000039namespace android {
40
Tomasz Wasilczyk1de48a22023-10-30 14:19:19 +000041using namespace android::binder::impl;
Tomasz Wasilczyk639490b2023-11-01 13:49:41 -070042using android::binder::borrowed_fd;
43using android::binder::unique_fd;
Tomasz Wasilczyk1de48a22023-10-30 14:19:19 +000044
Devin Moore08256432021-07-02 13:03:49 -070045#if RPC_FLAKE_PRONE
Steven Morelandb8176792021-06-22 20:29:21 +000046void rpcMaybeWaitToFlake() {
Devin Moore08256432021-07-02 13:03:49 -070047 [[clang::no_destroy]] static std::random_device r;
Steven Moreland7e2675c2022-09-28 23:34:52 +000048 [[clang::no_destroy]] static RpcMutex m;
Steven Morelandb8176792021-06-22 20:29:21 +000049 unsigned num;
50 {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +000051 RpcMutexLockGuard lock(m);
Steven Morelandb8176792021-06-22 20:29:21 +000052 num = r();
53 }
54 if (num % 10 == 0) usleep(num % 1000);
55}
56#endif
57
Frederick Mayle69a0c992022-05-26 20:38:39 +000058static bool enableAncillaryFds(RpcSession::FileDescriptorTransportMode mode) {
59 switch (mode) {
60 case RpcSession::FileDescriptorTransportMode::NONE:
61 return false;
62 case RpcSession::FileDescriptorTransportMode::UNIX:
Andrei Homescu1c18a802022-08-17 04:59:01 +000063 case RpcSession::FileDescriptorTransportMode::TRUSTY:
Frederick Mayle69a0c992022-05-26 20:38:39 +000064 return true;
65 }
Tomasz Wasilczyk7b5430b2023-06-28 14:04:51 -070066 LOG_ALWAYS_FATAL("Invalid FileDescriptorTransportMode: %d", static_cast<int>(mode));
Frederick Mayle69a0c992022-05-26 20:38:39 +000067}
68
Steven Moreland5553ac42020-11-11 02:14:45 +000069RpcState::RpcState() {}
70RpcState::~RpcState() {}
71
Steven Morelandbdb53ab2021-05-05 17:57:41 +000072status_t RpcState::onBinderLeaving(const sp<RpcSession>& session, const sp<IBinder>& binder,
Steven Moreland5623d1a2021-09-10 15:45:34 -070073 uint64_t* outAddress) {
Steven Moreland5553ac42020-11-11 02:14:45 +000074 bool isRemote = binder->remoteBinder();
75 bool isRpc = isRemote && binder->remoteBinder()->isRpcBinder();
76
Steven Moreland99157622021-09-13 16:27:34 -070077 if (isRpc && binder->remoteBinder()->getPrivateAccessor().rpcSession() != session) {
Steven Moreland5553ac42020-11-11 02:14:45 +000078 // We need to be able to send instructions over the socket for how to
79 // connect to a different server, and we also need to let the host
80 // process know that this is happening.
Steven Morelandbdb53ab2021-05-05 17:57:41 +000081 ALOGE("Cannot send binder from unrelated binder RPC session.");
Steven Moreland5553ac42020-11-11 02:14:45 +000082 return INVALID_OPERATION;
83 }
84
85 if (isRemote && !isRpc) {
86 // Without additional work, this would have the effect of using this
87 // process to proxy calls from the socket over to the other process, and
88 // it would make those calls look like they come from us (not over the
89 // sockets). In order to make this work transparently like binder, we
90 // would instead need to send instructions over the socket for how to
91 // connect to the host process, and we also need to let the host process
92 // know this was happening.
93 ALOGE("Cannot send binder proxy %p over sockets", binder.get());
94 return INVALID_OPERATION;
95 }
96
Andrei Homescuffa3aaa2022-04-07 05:06:33 +000097 RpcMutexLockGuard _l(mNodeMutex);
Steven Moreland7227c8a2021-06-02 00:24:32 +000098 if (mTerminated) return DEAD_OBJECT;
Steven Moreland5553ac42020-11-11 02:14:45 +000099
100 // TODO(b/182939933): maybe move address out of BpBinder, and keep binder->address map
101 // in RpcState
102 for (auto& [addr, node] : mNodeForAddress) {
103 if (binder == node.binder) {
104 if (isRpc) {
Steven Moreland5623d1a2021-09-10 15:45:34 -0700105 // check integrity of data structure
Steven Moreland99157622021-09-13 16:27:34 -0700106 uint64_t actualAddr = binder->remoteBinder()->getPrivateAccessor().rpcAddress();
Steven Moreland5623d1a2021-09-10 15:45:34 -0700107 LOG_ALWAYS_FATAL_IF(addr != actualAddr, "Address mismatch %" PRIu64 " vs %" PRIu64,
108 addr, actualAddr);
Steven Moreland5553ac42020-11-11 02:14:45 +0000109 }
110 node.timesSent++;
111 node.sentRef = binder; // might already be set
112 *outAddress = addr;
113 return OK;
114 }
115 }
116 LOG_ALWAYS_FATAL_IF(isRpc, "RPC binder must have known address at this point");
117
Steven Moreland91538242021-06-10 23:35:35 +0000118 bool forServer = session->server() != nullptr;
Steven Moreland5553ac42020-11-11 02:14:45 +0000119
Steven Moreland5623d1a2021-09-10 15:45:34 -0700120 // arbitrary limit for maximum number of nodes in a process (otherwise we
121 // might run out of addresses)
122 if (mNodeForAddress.size() > 100000) {
123 return NO_MEMORY;
124 }
125
126 while (true) {
127 RpcWireAddress address{
128 .options = RPC_WIRE_ADDRESS_OPTION_CREATED,
129 .address = mNextId,
130 };
131 if (forServer) {
132 address.options |= RPC_WIRE_ADDRESS_OPTION_FOR_SERVER;
133 }
134
135 // avoid ubsan abort
136 if (mNextId >= std::numeric_limits<uint32_t>::max()) {
137 mNextId = 0;
138 } else {
139 mNextId++;
140 }
141
142 auto&& [it, inserted] = mNodeForAddress.insert({RpcWireAddress::toRaw(address),
Steven Moreland91538242021-06-10 23:35:35 +0000143 BinderNode{
144 .binder = binder,
Steven Moreland91538242021-06-10 23:35:35 +0000145 .sentRef = binder,
Andrei Homescu5a036f32022-03-08 22:54:40 +0000146 .timesSent = 1,
Steven Moreland91538242021-06-10 23:35:35 +0000147 }});
148 if (inserted) {
149 *outAddress = it->first;
150 return OK;
151 }
Steven Moreland91538242021-06-10 23:35:35 +0000152 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000153}
154
Steven Moreland5623d1a2021-09-10 15:45:34 -0700155status_t RpcState::onBinderEntering(const sp<RpcSession>& session, uint64_t address,
Steven Moreland7227c8a2021-06-02 00:24:32 +0000156 sp<IBinder>* out) {
Steven Moreland91538242021-06-10 23:35:35 +0000157 // ensure that: if we want to use addresses for something else in the future (for
158 // instance, allowing transitive binder sends), that we don't accidentally
159 // send those addresses to old server. Accidentally ignoring this in that
160 // case and considering the binder to be recognized could cause this
161 // process to accidentally proxy transactions for that binder. Of course,
162 // if we communicate with a binder, it could always be proxying
163 // information. However, we want to make sure that isn't done on accident
164 // by a client.
Steven Moreland5623d1a2021-09-10 15:45:34 -0700165 RpcWireAddress addr = RpcWireAddress::fromRaw(address);
166 constexpr uint32_t kKnownOptions =
167 RPC_WIRE_ADDRESS_OPTION_CREATED | RPC_WIRE_ADDRESS_OPTION_FOR_SERVER;
168 if (addr.options & ~kKnownOptions) {
169 ALOGE("Address is of an unknown type, rejecting: %" PRIu64, address);
Steven Moreland91538242021-06-10 23:35:35 +0000170 return BAD_VALUE;
171 }
172
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000173 RpcMutexLockGuard _l(mNodeMutex);
Steven Moreland7227c8a2021-06-02 00:24:32 +0000174 if (mTerminated) return DEAD_OBJECT;
Steven Moreland5553ac42020-11-11 02:14:45 +0000175
176 if (auto it = mNodeForAddress.find(address); it != mNodeForAddress.end()) {
Steven Moreland7227c8a2021-06-02 00:24:32 +0000177 *out = it->second.binder.promote();
Steven Moreland5553ac42020-11-11 02:14:45 +0000178
179 // implicitly have strong RPC refcount, since we received this binder
180 it->second.timesRecd++;
Steven Morelandd8083312021-09-22 13:37:10 -0700181 return OK;
Steven Moreland5553ac42020-11-11 02:14:45 +0000182 }
183
Steven Moreland91538242021-06-10 23:35:35 +0000184 // we don't know about this binder, so the other side of the connection
185 // should have created it.
Steven Moreland5623d1a2021-09-10 15:45:34 -0700186 if ((addr.options & RPC_WIRE_ADDRESS_OPTION_FOR_SERVER) == !!session->server()) {
187 ALOGE("Server received unrecognized address which we should own the creation of %" PRIu64,
188 address);
Steven Moreland91538242021-06-10 23:35:35 +0000189 return BAD_VALUE;
190 }
191
Steven Moreland5553ac42020-11-11 02:14:45 +0000192 auto&& [it, inserted] = mNodeForAddress.insert({address, BinderNode{}});
193 LOG_ALWAYS_FATAL_IF(!inserted, "Failed to insert binder when creating proxy");
194
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000195 // Currently, all binders are assumed to be part of the same session (no
Steven Moreland5553ac42020-11-11 02:14:45 +0000196 // device global binders in the RPC world).
Steven Moreland99157622021-09-13 16:27:34 -0700197 it->second.binder = *out = BpBinder::PrivateAccessor::create(session, it->first);
Steven Moreland5553ac42020-11-11 02:14:45 +0000198 it->second.timesRecd = 1;
Steven Moreland7227c8a2021-06-02 00:24:32 +0000199 return OK;
Steven Moreland5553ac42020-11-11 02:14:45 +0000200}
201
Steven Morelandd8083312021-09-22 13:37:10 -0700202status_t RpcState::flushExcessBinderRefs(const sp<RpcSession>& session, uint64_t address,
203 const sp<IBinder>& binder) {
Steven Morelande96ed0e2021-09-27 17:43:53 -0700204 // We can flush all references when the binder is destroyed. No need to send
205 // extra reference counting packets now.
206 if (binder->remoteBinder()) return OK;
207
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000208 RpcMutexUniqueLock _l(mNodeMutex);
Steven Morelandd8083312021-09-22 13:37:10 -0700209 if (mTerminated) return DEAD_OBJECT;
210
211 auto it = mNodeForAddress.find(address);
212
213 LOG_ALWAYS_FATAL_IF(it == mNodeForAddress.end(), "Can't be deleted while we hold sp<>");
214 LOG_ALWAYS_FATAL_IF(it->second.binder != binder,
215 "Caller of flushExcessBinderRefs using inconsistent arguments");
216
Steven Morelande96ed0e2021-09-27 17:43:53 -0700217 LOG_ALWAYS_FATAL_IF(it->second.timesSent <= 0, "Local binder must have been sent %p",
218 binder.get());
Steven Morelandd8083312021-09-22 13:37:10 -0700219
Steven Morelande96ed0e2021-09-27 17:43:53 -0700220 // For a local binder, we only need to know that we sent it. Now that we
221 // have an sp<> for this call, we don't need anything more. If the other
222 // process is done with this binder, it needs to know we received the
223 // refcount associated with this call, so we can acknowledge that we
224 // received it. Once (or if) it has no other refcounts, it would reply with
225 // its own decStrong so that it could be removed from this session.
226 if (it->second.timesRecd != 0) {
Steven Morelandd8083312021-09-22 13:37:10 -0700227 _l.unlock();
228
Steven Morelande96ed0e2021-09-27 17:43:53 -0700229 return session->sendDecStrongToTarget(address, 0);
Steven Morelandd8083312021-09-22 13:37:10 -0700230 }
231
232 return OK;
233}
234
Devin Moore66d5b7a2022-07-07 21:42:10 +0000235status_t RpcState::sendObituaries(const sp<RpcSession>& session) {
236 RpcMutexUniqueLock _l(mNodeMutex);
237
238 // Gather strong pointers to all of the remote binders for this session so
239 // we hold the strong references. remoteBinder() returns a raw pointer.
240 // Send the obituaries and drop the strong pointers outside of the lock so
241 // the destructors and the onBinderDied calls are not done while locked.
242 std::vector<sp<IBinder>> remoteBinders;
243 for (const auto& [_, binderNode] : mNodeForAddress) {
244 if (auto binder = binderNode.binder.promote()) {
245 remoteBinders.push_back(std::move(binder));
246 }
247 }
248 _l.unlock();
249
250 for (const auto& binder : remoteBinders) {
251 if (binder->remoteBinder() &&
252 binder->remoteBinder()->getPrivateAccessor().rpcSession() == session) {
253 binder->remoteBinder()->sendObituary();
254 }
255 }
256 return OK;
257}
258
Steven Moreland5553ac42020-11-11 02:14:45 +0000259size_t RpcState::countBinders() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000260 RpcMutexLockGuard _l(mNodeMutex);
Steven Moreland5553ac42020-11-11 02:14:45 +0000261 return mNodeForAddress.size();
262}
263
264void RpcState::dump() {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000265 RpcMutexLockGuard _l(mNodeMutex);
Steven Moreland583a14a2021-06-04 02:04:58 +0000266 dumpLocked();
267}
268
Steven Morelandc9d7b532021-06-04 20:57:41 +0000269void RpcState::clear() {
Steven Moreland67f85902023-03-15 01:13:49 +0000270 return clear(RpcMutexUniqueLock(mNodeMutex));
271}
Steven Morelandc9d7b532021-06-04 20:57:41 +0000272
Steven Moreland67f85902023-03-15 01:13:49 +0000273void RpcState::clear(RpcMutexUniqueLock nodeLock) {
Steven Morelandc9d7b532021-06-04 20:57:41 +0000274 if (mTerminated) {
275 LOG_ALWAYS_FATAL_IF(!mNodeForAddress.empty(),
276 "New state should be impossible after terminating!");
277 return;
278 }
Steven Moreland0092fe32022-07-15 00:15:34 +0000279 mTerminated = true;
Steven Morelandc9d7b532021-06-04 20:57:41 +0000280
281 if (SHOULD_LOG_RPC_DETAIL) {
282 ALOGE("RpcState::clear()");
283 dumpLocked();
284 }
285
Steven Moreland0092fe32022-07-15 00:15:34 +0000286 // invariants
Steven Morelandc9d7b532021-06-04 20:57:41 +0000287 for (auto& [address, node] : mNodeForAddress) {
Steven Moreland0092fe32022-07-15 00:15:34 +0000288 bool guaranteedHaveBinder = node.timesSent > 0;
289 if (guaranteedHaveBinder) {
290 LOG_ALWAYS_FATAL_IF(node.sentRef == nullptr,
291 "Binder expected to be owned with address: %" PRIu64 " %s", address,
292 node.toString().c_str());
Steven Morelandc9d7b532021-06-04 20:57:41 +0000293 }
294 }
295
Steven Moreland0092fe32022-07-15 00:15:34 +0000296 // if the destructor of a binder object makes another RPC call, then calling
297 // decStrong could deadlock. So, we must hold onto these binders until
298 // mNodeMutex is no longer taken.
299 auto temp = std::move(mNodeForAddress);
300 mNodeForAddress.clear(); // RpcState isn't reusable, but for future/explicit
Steven Morelandc9d7b532021-06-04 20:57:41 +0000301
Steven Moreland67f85902023-03-15 01:13:49 +0000302 nodeLock.unlock();
Steven Moreland0092fe32022-07-15 00:15:34 +0000303 temp.clear(); // explicit
Steven Moreland583a14a2021-06-04 02:04:58 +0000304}
305
306void RpcState::dumpLocked() {
Steven Moreland5553ac42020-11-11 02:14:45 +0000307 ALOGE("DUMP OF RpcState %p", this);
308 ALOGE("DUMP OF RpcState (%zu nodes)", mNodeForAddress.size());
309 for (const auto& [address, node] : mNodeForAddress) {
Steven Moreland3fa32922022-07-14 18:45:51 +0000310 ALOGE("- address: %" PRIu64 " %s", address, node.toString().c_str());
Steven Moreland5553ac42020-11-11 02:14:45 +0000311 }
312 ALOGE("END DUMP OF RpcState");
313}
314
Steven Moreland3fa32922022-07-14 18:45:51 +0000315std::string RpcState::BinderNode::toString() const {
316 sp<IBinder> strongBinder = this->binder.promote();
317
318 const char* desc;
319 if (strongBinder) {
320 if (strongBinder->remoteBinder()) {
321 if (strongBinder->remoteBinder()->isRpcBinder()) {
322 desc = "(rpc binder proxy)";
323 } else {
324 desc = "(binder proxy)";
325 }
326 } else {
327 desc = "(local binder)";
328 }
329 } else {
330 desc = "(not promotable)";
331 }
332
Tomasz Wasilczyk3caae302023-10-12 20:57:02 +0000333 std::stringstream ss;
334 ss << "node{" << intptr_t(this->binder.unsafe_get()) << " times sent: " << this->timesSent
335 << " times recd: " << this->timesRecd << " type: " << desc << "}";
336 return ss.str();
Steven Moreland3fa32922022-07-14 18:45:51 +0000337}
Steven Moreland5553ac42020-11-11 02:14:45 +0000338
Steven Morelanddbe71832021-05-12 23:31:00 +0000339RpcState::CommandData::CommandData(size_t size) : mSize(size) {
340 // The maximum size for regular binder is 1MB for all concurrent
341 // transactions. A very small proportion of transactions are even
342 // larger than a page, but we need to avoid allocating too much
343 // data on behalf of an arbitrary client, or we could risk being in
344 // a position where a single additional allocation could run out of
345 // memory.
346 //
347 // Note, this limit may not reflect the total amount of data allocated for a
348 // transaction (in some cases, additional fixed size amounts are added),
349 // though for rough consistency, we should avoid cases where this data type
350 // is used for multiple dynamic allocations for a single transaction.
351 constexpr size_t kMaxTransactionAllocation = 100 * 1000;
352 if (size == 0) return;
353 if (size > kMaxTransactionAllocation) {
354 ALOGW("Transaction requested too much data allocation %zu", size);
355 return;
356 }
357 mData.reset(new (std::nothrow) uint8_t[size]);
358}
359
Tomasz Wasilczyk639490b2023-11-01 13:49:41 -0700360status_t RpcState::rpcSend(const sp<RpcSession::RpcConnection>& connection,
361 const sp<RpcSession>& session, const char* what, iovec* iovs, int niovs,
362 const std::optional<SmallFunction<status_t()>>& altPoll,
363 const std::vector<std::variant<unique_fd, borrowed_fd>>* ancillaryFds) {
Colin Cross9adfeaf2022-01-21 17:22:09 -0800364 for (int i = 0; i < niovs; i++) {
Andrei Homescu0a692352022-03-29 06:04:26 +0000365 LOG_RPC_DETAIL("Sending %s (part %d of %d) on RpcTransport %p: %s",
366 what, i + 1, niovs, connection->rpcTransport.get(),
Tomasz Wasilczyk891f6b02023-10-11 18:35:42 +0000367 HexString(iovs[i].iov_base, iovs[i].iov_len).c_str());
Steven Moreland5553ac42020-11-11 02:14:45 +0000368 }
369
Yifan Hong702115c2021-06-24 15:39:18 -0700370 if (status_t status =
Yifan Hong8c950422021-08-05 17:13:55 -0700371 connection->rpcTransport->interruptableWriteFully(session->mShutdownTrigger.get(),
Frederick Mayle69a0c992022-05-26 20:38:39 +0000372 iovs, niovs, altPoll,
373 ancillaryFds);
Steven Moreland798e0d12021-07-14 23:19:25 +0000374 status != OK) {
Colin Cross9adfeaf2022-01-21 17:22:09 -0800375 LOG_RPC_DETAIL("Failed to write %s (%d iovs) on RpcTransport %p, error: %s", what, niovs,
Yifan Hong702115c2021-06-24 15:39:18 -0700376 connection->rpcTransport.get(), statusToString(status).c_str());
Steven Morelandc9d7b532021-06-04 20:57:41 +0000377 (void)session->shutdownAndWait(false);
Steven Moreland798e0d12021-07-14 23:19:25 +0000378 return status;
Steven Moreland5553ac42020-11-11 02:14:45 +0000379 }
380
Steven Moreland1e4c2b82021-05-25 01:51:31 +0000381 return OK;
Steven Moreland5553ac42020-11-11 02:14:45 +0000382}
383
Tomasz Wasilczyk639490b2023-11-01 13:49:41 -0700384status_t RpcState::rpcRec(const sp<RpcSession::RpcConnection>& connection,
385 const sp<RpcSession>& session, const char* what, iovec* iovs, int niovs,
386 std::vector<std::variant<unique_fd, borrowed_fd>>* ancillaryFds) {
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000387 if (status_t status =
388 connection->rpcTransport->interruptableReadFully(session->mShutdownTrigger.get(),
389 iovs, niovs, std::nullopt,
390 ancillaryFds);
Steven Morelandee3f4662021-05-22 01:07:33 +0000391 status != OK) {
Colin Cross9adfeaf2022-01-21 17:22:09 -0800392 LOG_RPC_DETAIL("Failed to read %s (%d iovs) on RpcTransport %p, error: %s", what, niovs,
Yifan Hong702115c2021-06-24 15:39:18 -0700393 connection->rpcTransport.get(), statusToString(status).c_str());
Steven Morelandae58f432021-08-05 17:53:16 -0700394 (void)session->shutdownAndWait(false);
Steven Moreland1e4c2b82021-05-25 01:51:31 +0000395 return status;
Steven Moreland5553ac42020-11-11 02:14:45 +0000396 }
397
Colin Cross9adfeaf2022-01-21 17:22:09 -0800398 for (int i = 0; i < niovs; i++) {
Andrei Homescu0a692352022-03-29 06:04:26 +0000399 LOG_RPC_DETAIL("Received %s (part %d of %d) on RpcTransport %p: %s",
400 what, i + 1, niovs, connection->rpcTransport.get(),
Tomasz Wasilczyk891f6b02023-10-11 18:35:42 +0000401 HexString(iovs[i].iov_base, iovs[i].iov_len).c_str());
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000402 }
Steven Moreland1e4c2b82021-05-25 01:51:31 +0000403 return OK;
Steven Moreland5553ac42020-11-11 02:14:45 +0000404}
405
Steven Morelandca3f6382023-05-11 23:23:26 +0000406bool RpcState::validateProtocolVersion(uint32_t version) {
Steven Moreland09034a92023-05-31 20:49:11 +0000407 if (version == RPC_WIRE_PROTOCOL_VERSION_EXPERIMENTAL) {
408#if defined(__ANDROID__)
409 char codename[PROPERTY_VALUE_MAX];
410 property_get("ro.build.version.codename", codename, "");
411 if (!strcmp(codename, "REL")) {
Steven Moreland0884c552023-10-17 18:23:31 +0000412 ALOGE("Cannot use experimental RPC binder protocol in a release configuration.");
Steven Moreland09034a92023-05-31 20:49:11 +0000413 return false;
414 }
415#else
Steven Moreland687728e2023-10-28 01:07:40 +0000416 ALOGE("Cannot use experimental RPC binder protocol outside of Android.");
417 return false;
Steven Moreland09034a92023-05-31 20:49:11 +0000418#endif
419 } else if (version >= RPC_WIRE_PROTOCOL_VERSION_NEXT) {
Steven Morelandca3f6382023-05-11 23:23:26 +0000420 ALOGE("Cannot use RPC binder protocol version %u which is unknown (current protocol "
421 "version "
422 "is %u).",
423 version, RPC_WIRE_PROTOCOL_VERSION);
424 return false;
425 }
Steven Moreland09034a92023-05-31 20:49:11 +0000426
Steven Morelandca3f6382023-05-11 23:23:26 +0000427 return true;
428}
429
Steven Morelandbf57bce2021-07-26 15:26:12 -0700430status_t RpcState::readNewSessionResponse(const sp<RpcSession::RpcConnection>& connection,
431 const sp<RpcSession>& session, uint32_t* version) {
432 RpcNewSessionResponse response;
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000433 iovec iov{&response, sizeof(response)};
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000434 if (status_t status = rpcRec(connection, session, "new session response", &iov, 1, nullptr);
Steven Morelandbf57bce2021-07-26 15:26:12 -0700435 status != OK) {
436 return status;
437 }
438 *version = response.version;
439 return OK;
440}
441
Steven Moreland5ae62562021-06-10 03:21:42 +0000442status_t RpcState::sendConnectionInit(const sp<RpcSession::RpcConnection>& connection,
443 const sp<RpcSession>& session) {
Steven Moreland19fc9f72021-06-10 03:57:30 +0000444 RpcOutgoingConnectionInit init{
Steven Morelandc88b7fc2021-06-10 00:40:39 +0000445 .msg = RPC_CONNECTION_INIT_OKAY,
446 };
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000447 iovec iov{&init, sizeof(init)};
Devin Moore695368f2022-06-03 22:29:14 +0000448 return rpcSend(connection, session, "connection init", &iov, 1, std::nullopt);
Steven Morelandc88b7fc2021-06-10 00:40:39 +0000449}
450
Steven Moreland5ae62562021-06-10 03:21:42 +0000451status_t RpcState::readConnectionInit(const sp<RpcSession::RpcConnection>& connection,
452 const sp<RpcSession>& session) {
Steven Moreland19fc9f72021-06-10 03:57:30 +0000453 RpcOutgoingConnectionInit init;
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000454 iovec iov{&init, sizeof(init)};
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000455 if (status_t status = rpcRec(connection, session, "connection init", &iov, 1, nullptr);
456 status != OK)
Steven Morelandc88b7fc2021-06-10 00:40:39 +0000457 return status;
458
459 static_assert(sizeof(init.msg) == sizeof(RPC_CONNECTION_INIT_OKAY));
460 if (0 != strncmp(init.msg, RPC_CONNECTION_INIT_OKAY, sizeof(init.msg))) {
461 ALOGE("Connection init message unrecognized %.*s", static_cast<int>(sizeof(init.msg)),
462 init.msg);
463 return BAD_VALUE;
464 }
465 return OK;
466}
467
Steven Moreland5ae62562021-06-10 03:21:42 +0000468sp<IBinder> RpcState::getRootObject(const sp<RpcSession::RpcConnection>& connection,
469 const sp<RpcSession>& session) {
Steven Moreland5553ac42020-11-11 02:14:45 +0000470 Parcel data;
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000471 data.markForRpc(session);
Steven Moreland5553ac42020-11-11 02:14:45 +0000472 Parcel reply;
473
Steven Moreland5623d1a2021-09-10 15:45:34 -0700474 status_t status =
475 transactAddress(connection, 0, RPC_SPECIAL_TRANSACT_GET_ROOT, data, session, &reply, 0);
Steven Moreland5553ac42020-11-11 02:14:45 +0000476 if (status != OK) {
477 ALOGE("Error getting root object: %s", statusToString(status).c_str());
478 return nullptr;
479 }
480
481 return reply.readStrongBinder();
482}
483
Steven Moreland5ae62562021-06-10 03:21:42 +0000484status_t RpcState::getMaxThreads(const sp<RpcSession::RpcConnection>& connection,
485 const sp<RpcSession>& session, size_t* maxThreadsOut) {
Steven Morelandf137de92021-04-24 01:54:26 +0000486 Parcel data;
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000487 data.markForRpc(session);
Steven Morelandf137de92021-04-24 01:54:26 +0000488 Parcel reply;
489
Steven Moreland5623d1a2021-09-10 15:45:34 -0700490 status_t status = transactAddress(connection, 0, RPC_SPECIAL_TRANSACT_GET_MAX_THREADS, data,
491 session, &reply, 0);
Steven Morelandf137de92021-04-24 01:54:26 +0000492 if (status != OK) {
493 ALOGE("Error getting max threads: %s", statusToString(status).c_str());
494 return status;
495 }
496
Steven Moreland7c5e6c22021-05-01 02:55:20 +0000497 int32_t maxThreads;
498 status = reply.readInt32(&maxThreads);
Steven Morelandf137de92021-04-24 01:54:26 +0000499 if (status != OK) return status;
Steven Moreland7c5e6c22021-05-01 02:55:20 +0000500 if (maxThreads <= 0) {
501 ALOGE("Error invalid max maxThreads: %d", maxThreads);
Steven Morelandf137de92021-04-24 01:54:26 +0000502 return BAD_VALUE;
503 }
504
Steven Moreland7c5e6c22021-05-01 02:55:20 +0000505 *maxThreadsOut = maxThreads;
506 return OK;
507}
508
Steven Moreland5ae62562021-06-10 03:21:42 +0000509status_t RpcState::getSessionId(const sp<RpcSession::RpcConnection>& connection,
Steven Moreland826367f2021-09-10 14:05:31 -0700510 const sp<RpcSession>& session, std::vector<uint8_t>* sessionIdOut) {
Steven Moreland7c5e6c22021-05-01 02:55:20 +0000511 Parcel data;
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000512 data.markForRpc(session);
Steven Moreland7c5e6c22021-05-01 02:55:20 +0000513 Parcel reply;
514
Steven Moreland5623d1a2021-09-10 15:45:34 -0700515 status_t status = transactAddress(connection, 0, RPC_SPECIAL_TRANSACT_GET_SESSION_ID, data,
516 session, &reply, 0);
Steven Moreland7c5e6c22021-05-01 02:55:20 +0000517 if (status != OK) {
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000518 ALOGE("Error getting session ID: %s", statusToString(status).c_str());
Steven Moreland7c5e6c22021-05-01 02:55:20 +0000519 return status;
520 }
521
Steven Moreland826367f2021-09-10 14:05:31 -0700522 return reply.readByteVector(sessionIdOut);
Steven Morelandf137de92021-04-24 01:54:26 +0000523}
524
Steven Moreland5ae62562021-06-10 03:21:42 +0000525status_t RpcState::transact(const sp<RpcSession::RpcConnection>& connection,
526 const sp<IBinder>& binder, uint32_t code, const Parcel& data,
527 const sp<RpcSession>& session, Parcel* reply, uint32_t flags) {
Frederick Mayle69a0c992022-05-26 20:38:39 +0000528 std::string errorMsg;
529 if (status_t status = validateParcel(session, data, &errorMsg); status != OK) {
530 ALOGE("Refusing to send RPC on binder %p code %" PRIu32 ": Parcel %p failed validation: %s",
531 binder.get(), code, &data, errorMsg.c_str());
532 return status;
Steven Morelandf5174272021-05-25 00:39:28 +0000533 }
Steven Moreland5623d1a2021-09-10 15:45:34 -0700534 uint64_t address;
Steven Morelandf5174272021-05-25 00:39:28 +0000535 if (status_t status = onBinderLeaving(session, binder, &address); status != OK) return status;
536
Steven Moreland5ae62562021-06-10 03:21:42 +0000537 return transactAddress(connection, address, code, data, session, reply, flags);
Steven Morelandf5174272021-05-25 00:39:28 +0000538}
539
Steven Moreland5ae62562021-06-10 03:21:42 +0000540status_t RpcState::transactAddress(const sp<RpcSession::RpcConnection>& connection,
Steven Moreland5623d1a2021-09-10 15:45:34 -0700541 uint64_t address, uint32_t code, const Parcel& data,
Steven Moreland5ae62562021-06-10 03:21:42 +0000542 const sp<RpcSession>& session, Parcel* reply, uint32_t flags) {
Steven Morelandf5174272021-05-25 00:39:28 +0000543 LOG_ALWAYS_FATAL_IF(!data.isForRpc());
544 LOG_ALWAYS_FATAL_IF(data.objectsCount() != 0);
545
Steven Moreland5553ac42020-11-11 02:14:45 +0000546 uint64_t asyncNumber = 0;
547
Steven Moreland5623d1a2021-09-10 15:45:34 -0700548 if (address != 0) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000549 RpcMutexUniqueLock _l(mNodeMutex);
Steven Moreland5553ac42020-11-11 02:14:45 +0000550 if (mTerminated) return DEAD_OBJECT; // avoid fatal only, otherwise races
551 auto it = mNodeForAddress.find(address);
Steven Moreland5623d1a2021-09-10 15:45:34 -0700552 LOG_ALWAYS_FATAL_IF(it == mNodeForAddress.end(),
553 "Sending transact on unknown address %" PRIu64, address);
Steven Moreland5553ac42020-11-11 02:14:45 +0000554
555 if (flags & IBinder::FLAG_ONEWAY) {
Steven Moreland583a14a2021-06-04 02:04:58 +0000556 asyncNumber = it->second.asyncNumber;
Steven Morelandc9d7b532021-06-04 20:57:41 +0000557 if (!nodeProgressAsyncNumber(&it->second)) {
558 _l.unlock();
559 (void)session->shutdownAndWait(false);
560 return DEAD_OBJECT;
561 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000562 }
563 }
564
Frederick Mayle69a0c992022-05-26 20:38:39 +0000565 auto* rpcFields = data.maybeRpcFields();
566 LOG_ALWAYS_FATAL_IF(rpcFields == nullptr);
567
568 Span<const uint32_t> objectTableSpan = Span<const uint32_t>{rpcFields->mObjectPositions.data(),
569 rpcFields->mObjectPositions.size()};
Frederick Mayledc07cf82022-05-26 20:30:12 +0000570
Frederick Mayle778c0902022-05-27 01:14:57 +0000571 uint32_t bodySize;
572 LOG_ALWAYS_FATAL_IF(__builtin_add_overflow(sizeof(RpcWireTransaction), data.dataSize(),
Frederick Mayledc07cf82022-05-26 20:30:12 +0000573 &bodySize) ||
574 __builtin_add_overflow(objectTableSpan.byteSize(), bodySize,
575 &bodySize),
Steven Moreland77c30112021-06-02 20:45:46 +0000576 "Too much data %zu", data.dataSize());
Steven Moreland77c30112021-06-02 20:45:46 +0000577 RpcWireHeader command{
578 .command = RPC_COMMAND_TRANSACT,
Frederick Mayle778c0902022-05-27 01:14:57 +0000579 .bodySize = bodySize,
Steven Moreland77c30112021-06-02 20:45:46 +0000580 };
Steven Moreland5623d1a2021-09-10 15:45:34 -0700581
Steven Moreland5553ac42020-11-11 02:14:45 +0000582 RpcWireTransaction transaction{
Steven Moreland5623d1a2021-09-10 15:45:34 -0700583 .address = RpcWireAddress::fromRaw(address),
Steven Moreland5553ac42020-11-11 02:14:45 +0000584 .code = code,
585 .flags = flags,
586 .asyncNumber = asyncNumber,
Frederick Mayledc07cf82022-05-26 20:30:12 +0000587 // bodySize didn't overflow => this cast is safe
588 .parcelDataSize = static_cast<uint32_t>(data.dataSize()),
Steven Moreland5553ac42020-11-11 02:14:45 +0000589 };
Steven Moreland5553ac42020-11-11 02:14:45 +0000590
Steven Moreland43921d52021-09-27 17:15:56 -0700591 // Oneway calls have no sync point, so if many are sent before, whether this
592 // is a twoway or oneway transaction, they may have filled up the socket.
Devin Moore695368f2022-06-03 22:29:14 +0000593 // So, make sure we drain them before polling
Steven Morelandda31af62023-02-25 01:55:58 +0000594 constexpr size_t kWaitMaxUs = 1000000;
595 constexpr size_t kWaitLogUs = 10000;
596 size_t waitUs = 0;
Steven Moreland43921d52021-09-27 17:15:56 -0700597
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000598 iovec iovs[]{
599 {&command, sizeof(RpcWireHeader)},
600 {&transaction, sizeof(RpcWireTransaction)},
601 {const_cast<uint8_t*>(data.data()), data.dataSize()},
Frederick Mayledc07cf82022-05-26 20:30:12 +0000602 objectTableSpan.toIovec(),
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000603 };
Tomasz Wasilczyk35804862023-10-30 14:19:19 +0000604 auto altPoll = [&] {
605 if (waitUs > kWaitLogUs) {
606 ALOGE("Cannot send command, trying to process pending refcounts. Waiting "
607 "%zuus. Too many oneway calls?",
608 waitUs);
609 }
Devin Moore695368f2022-06-03 22:29:14 +0000610
Tomasz Wasilczyk35804862023-10-30 14:19:19 +0000611 if (waitUs > 0) {
612 usleep(waitUs);
613 waitUs = std::min(kWaitMaxUs, waitUs * 2);
614 } else {
615 waitUs = 1;
616 }
Devin Moore695368f2022-06-03 22:29:14 +0000617
Tomasz Wasilczyk35804862023-10-30 14:19:19 +0000618 return drainCommands(connection, session, CommandType::CONTROL_ONLY);
619 };
620 if (status_t status = rpcSend(connection, session, "transaction", iovs, countof(iovs),
621 std::ref(altPoll), rpcFields->mFds.get());
Steven Moreland43921d52021-09-27 17:15:56 -0700622 status != OK) {
Steven Morelandda31af62023-02-25 01:55:58 +0000623 // rpcSend calls shutdownAndWait, so all refcounts should be reset. If we ever tolerate
624 // errors here, then we may need to undo the binder-sent counts for the transaction as
625 // well as for the binder objects in the Parcel
Steven Moreland1e4c2b82021-05-25 01:51:31 +0000626 return status;
Steven Moreland43921d52021-09-27 17:15:56 -0700627 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000628
629 if (flags & IBinder::FLAG_ONEWAY) {
Yifan Hong702115c2021-06-24 15:39:18 -0700630 LOG_RPC_DETAIL("Oneway command, so no longer waiting on RpcTransport %p",
631 connection->rpcTransport.get());
Steven Moreland52eee942021-06-03 00:59:28 +0000632
633 // Do not wait on result.
Steven Moreland43921d52021-09-27 17:15:56 -0700634 return OK;
Steven Moreland5553ac42020-11-11 02:14:45 +0000635 }
636
637 LOG_ALWAYS_FATAL_IF(reply == nullptr, "Reply parcel must be used for synchronous transaction.");
638
Steven Moreland5ae62562021-06-10 03:21:42 +0000639 return waitForReply(connection, session, reply);
Steven Moreland5553ac42020-11-11 02:14:45 +0000640}
641
Frederick Mayle53b6ffe2022-07-15 20:14:01 +0000642static void cleanup_reply_data(const uint8_t* data, size_t dataSize, const binder_size_t* objects,
643 size_t objectsCount) {
Frederick Mayle68aa3bc2022-06-07 15:51:31 +0000644 delete[] const_cast<uint8_t*>(data);
Steven Moreland5553ac42020-11-11 02:14:45 +0000645 (void)dataSize;
646 LOG_ALWAYS_FATAL_IF(objects != nullptr);
Frederick Mayle53b6ffe2022-07-15 20:14:01 +0000647 (void)objectsCount;
Steven Moreland5553ac42020-11-11 02:14:45 +0000648}
649
Steven Moreland5ae62562021-06-10 03:21:42 +0000650status_t RpcState::waitForReply(const sp<RpcSession::RpcConnection>& connection,
651 const sp<RpcSession>& session, Parcel* reply) {
Tomasz Wasilczyk639490b2023-11-01 13:49:41 -0700652 std::vector<std::variant<unique_fd, borrowed_fd>> ancillaryFds;
Steven Moreland5553ac42020-11-11 02:14:45 +0000653 RpcWireHeader command;
654 while (true) {
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000655 iovec iov{&command, sizeof(command)};
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000656 if (status_t status = rpcRec(connection, session, "command header (for reply)", &iov, 1,
657 enableAncillaryFds(session->getFileDescriptorTransportMode())
658 ? &ancillaryFds
659 : nullptr);
Steven Moreland1e4c2b82021-05-25 01:51:31 +0000660 status != OK)
661 return status;
Steven Moreland5553ac42020-11-11 02:14:45 +0000662
663 if (command.command == RPC_COMMAND_REPLY) break;
664
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000665 if (status_t status = processCommand(connection, session, command, CommandType::ANY,
666 std::move(ancillaryFds));
Steven Moreland52eee942021-06-03 00:59:28 +0000667 status != OK)
Steven Moreland1e4c2b82021-05-25 01:51:31 +0000668 return status;
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000669
670 // Reset to avoid spurious use-after-move warning from clang-tidy.
671 ancillaryFds = decltype(ancillaryFds)();
Steven Moreland5553ac42020-11-11 02:14:45 +0000672 }
673
Frederick Mayledc07cf82022-05-26 20:30:12 +0000674 const size_t rpcReplyWireSize = RpcWireReply::wireSize(session->getProtocolVersion().value());
675
676 if (command.bodySize < rpcReplyWireSize) {
Steven Moreland5553ac42020-11-11 02:14:45 +0000677 ALOGE("Expecting %zu but got %" PRId32 " bytes for RpcWireReply. Terminating!",
678 sizeof(RpcWireReply), command.bodySize);
Steven Morelandc9d7b532021-06-04 20:57:41 +0000679 (void)session->shutdownAndWait(false);
Steven Moreland5553ac42020-11-11 02:14:45 +0000680 return BAD_VALUE;
681 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000682
Frederick Mayle68aa3bc2022-06-07 15:51:31 +0000683 RpcWireReply rpcReply;
Frederick Mayledc07cf82022-05-26 20:30:12 +0000684 memset(&rpcReply, 0, sizeof(RpcWireReply)); // zero because of potential short read
685
686 CommandData data(command.bodySize - rpcReplyWireSize);
Frederick Mayle68aa3bc2022-06-07 15:51:31 +0000687 if (!data.valid()) return NO_MEMORY;
688
689 iovec iovs[]{
Frederick Mayledc07cf82022-05-26 20:30:12 +0000690 {&rpcReply, rpcReplyWireSize},
Frederick Mayle68aa3bc2022-06-07 15:51:31 +0000691 {data.data(), data.size()},
692 };
Tomasz Wasilczykdf07f942023-11-02 15:07:45 -0700693 if (status_t status = rpcRec(connection, session, "reply body", iovs, countof(iovs), nullptr);
Frederick Mayle68aa3bc2022-06-07 15:51:31 +0000694 status != OK)
695 return status;
Frederick Mayle69a0c992022-05-26 20:38:39 +0000696
Frederick Mayle68aa3bc2022-06-07 15:51:31 +0000697 if (rpcReply.status != OK) return rpcReply.status;
698
Frederick Mayledc07cf82022-05-26 20:30:12 +0000699 Span<const uint8_t> parcelSpan = {data.data(), data.size()};
Frederick Mayle69a0c992022-05-26 20:38:39 +0000700 Span<const uint32_t> objectTableSpan;
Frederick Mayledc07cf82022-05-26 20:30:12 +0000701 if (session->getProtocolVersion().value() >=
702 RPC_WIRE_PROTOCOL_VERSION_RPC_HEADER_FEATURE_EXPLICIT_PARCEL_SIZE) {
Frederick Mayle16a12ae2022-07-15 00:04:33 +0000703 std::optional<Span<const uint8_t>> objectTableBytes =
704 parcelSpan.splitOff(rpcReply.parcelDataSize);
705 if (!objectTableBytes.has_value()) {
706 ALOGE("Parcel size larger than available bytes: %" PRId32 " vs %zu. Terminating!",
707 rpcReply.parcelDataSize, parcelSpan.byteSize());
708 (void)session->shutdownAndWait(false);
709 return BAD_VALUE;
710 }
Frederick Mayle69a0c992022-05-26 20:38:39 +0000711 std::optional<Span<const uint32_t>> maybeSpan =
Frederick Mayle16a12ae2022-07-15 00:04:33 +0000712 objectTableBytes->reinterpret<const uint32_t>();
Frederick Mayle69a0c992022-05-26 20:38:39 +0000713 if (!maybeSpan.has_value()) {
714 ALOGE("Bad object table size inferred from RpcWireReply. Saw bodySize=%" PRId32
715 " sizeofHeader=%zu parcelSize=%" PRId32 " objectTableBytesSize=%zu. Terminating!",
716 command.bodySize, rpcReplyWireSize, rpcReply.parcelDataSize,
Frederick Mayle16a12ae2022-07-15 00:04:33 +0000717 objectTableBytes->size);
Frederick Mayle69a0c992022-05-26 20:38:39 +0000718 return BAD_VALUE;
719 }
720 objectTableSpan = *maybeSpan;
Frederick Mayledc07cf82022-05-26 20:30:12 +0000721 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000722
Frederick Mayledc07cf82022-05-26 20:30:12 +0000723 data.release();
Frederick Mayle69a0c992022-05-26 20:38:39 +0000724 return reply->rpcSetDataReference(session, parcelSpan.data, parcelSpan.size,
725 objectTableSpan.data, objectTableSpan.size,
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000726 std::move(ancillaryFds), cleanup_reply_data);
Steven Moreland5553ac42020-11-11 02:14:45 +0000727}
728
Steven Morelandfd1e8a02021-07-21 23:30:29 +0000729status_t RpcState::sendDecStrongToTarget(const sp<RpcSession::RpcConnection>& connection,
730 const sp<RpcSession>& session, uint64_t addr,
731 size_t target) {
732 RpcDecStrong body = {
733 .address = RpcWireAddress::fromRaw(addr),
734 };
735
Steven Moreland5553ac42020-11-11 02:14:45 +0000736 {
Steven Moreland67f85902023-03-15 01:13:49 +0000737 RpcMutexUniqueLock _l(mNodeMutex);
Steven Moreland5553ac42020-11-11 02:14:45 +0000738 if (mTerminated) return DEAD_OBJECT; // avoid fatal only, otherwise races
739 auto it = mNodeForAddress.find(addr);
Steven Moreland5623d1a2021-09-10 15:45:34 -0700740 LOG_ALWAYS_FATAL_IF(it == mNodeForAddress.end(),
741 "Sending dec strong on unknown address %" PRIu64, addr);
Steven Moreland5553ac42020-11-11 02:14:45 +0000742
Steven Morelandfd1e8a02021-07-21 23:30:29 +0000743 LOG_ALWAYS_FATAL_IF(it->second.timesRecd < target, "Can't dec count of %zu to %zu.",
744 it->second.timesRecd, target);
745
746 // typically this happens when multiple threads send dec refs at the
747 // same time - the transactions will get combined automatically
748 if (it->second.timesRecd == target) return OK;
749
750 body.amount = it->second.timesRecd - target;
751 it->second.timesRecd = target;
752
Steven Moreland67f85902023-03-15 01:13:49 +0000753 LOG_ALWAYS_FATAL_IF(nullptr != tryEraseNode(session, std::move(_l), it),
Steven Moreland31bde7a2021-06-04 00:57:36 +0000754 "Bad state. RpcState shouldn't own received binder");
Steven Moreland67f85902023-03-15 01:13:49 +0000755 // LOCK ALREADY RELEASED
Steven Moreland5553ac42020-11-11 02:14:45 +0000756 }
757
758 RpcWireHeader cmd = {
759 .command = RPC_COMMAND_DEC_STRONG,
Steven Morelandfd1e8a02021-07-21 23:30:29 +0000760 .bodySize = sizeof(RpcDecStrong),
Steven Moreland5553ac42020-11-11 02:14:45 +0000761 };
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000762 iovec iovs[]{{&cmd, sizeof(cmd)}, {&body, sizeof(body)}};
Tomasz Wasilczykdf07f942023-11-02 15:07:45 -0700763 return rpcSend(connection, session, "dec ref", iovs, countof(iovs), std::nullopt);
Steven Moreland5553ac42020-11-11 02:14:45 +0000764}
765
Steven Moreland5ae62562021-06-10 03:21:42 +0000766status_t RpcState::getAndExecuteCommand(const sp<RpcSession::RpcConnection>& connection,
767 const sp<RpcSession>& session, CommandType type) {
Yifan Hong702115c2021-06-24 15:39:18 -0700768 LOG_RPC_DETAIL("getAndExecuteCommand on RpcTransport %p", connection->rpcTransport.get());
Steven Moreland5553ac42020-11-11 02:14:45 +0000769
Tomasz Wasilczyk639490b2023-11-01 13:49:41 -0700770 std::vector<std::variant<unique_fd, borrowed_fd>> ancillaryFds;
Steven Moreland5553ac42020-11-11 02:14:45 +0000771 RpcWireHeader command;
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000772 iovec iov{&command, sizeof(command)};
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000773 if (status_t status =
774 rpcRec(connection, session, "command header (for server)", &iov, 1,
775 enableAncillaryFds(session->getFileDescriptorTransportMode()) ? &ancillaryFds
776 : nullptr);
Steven Moreland1e4c2b82021-05-25 01:51:31 +0000777 status != OK)
778 return status;
Steven Moreland5553ac42020-11-11 02:14:45 +0000779
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000780 return processCommand(connection, session, command, type, std::move(ancillaryFds));
Steven Moreland52eee942021-06-03 00:59:28 +0000781}
782
Steven Moreland5ae62562021-06-10 03:21:42 +0000783status_t RpcState::drainCommands(const sp<RpcSession::RpcConnection>& connection,
784 const sp<RpcSession>& session, CommandType type) {
Andrei Homescu5ad71b52022-03-11 03:49:12 +0000785 while (true) {
Andrei Homescu1975aaa2022-03-19 02:34:57 +0000786 status_t status = connection->rpcTransport->pollRead();
Andrei Homescu5ad71b52022-03-11 03:49:12 +0000787 if (status == WOULD_BLOCK) break;
788 if (status != OK) return status;
Andrei Homescu5ad71b52022-03-11 03:49:12 +0000789
790 status = getAndExecuteCommand(connection, session, type);
Steven Moreland52eee942021-06-03 00:59:28 +0000791 if (status != OK) return status;
792 }
793 return OK;
Steven Moreland5553ac42020-11-11 02:14:45 +0000794}
795
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000796status_t RpcState::processCommand(
797 const sp<RpcSession::RpcConnection>& connection, const sp<RpcSession>& session,
798 const RpcWireHeader& command, CommandType type,
Tomasz Wasilczyk639490b2023-11-01 13:49:41 -0700799 std::vector<std::variant<unique_fd, borrowed_fd>>&& ancillaryFds) {
Steven Moreland32150282021-11-12 22:54:53 +0000800#ifdef BINDER_WITH_KERNEL_IPC
Steven Morelandd7302072021-05-15 01:32:04 +0000801 IPCThreadState* kernelBinderState = IPCThreadState::selfOrNull();
802 IPCThreadState::SpGuard spGuard{
803 .address = __builtin_frame_address(0),
Steven Morelande42ffd02022-07-06 21:46:23 +0000804 .context = "processing binder RPC command (where RpcServer::setPerSessionRootObject is "
805 "used to distinguish callers)",
Steven Morelandd7302072021-05-15 01:32:04 +0000806 };
807 const IPCThreadState::SpGuard* origGuard;
808 if (kernelBinderState != nullptr) {
809 origGuard = kernelBinderState->pushGetCallingSpGuard(&spGuard);
810 }
Steven Moreland32150282021-11-12 22:54:53 +0000811
Tomasz Wasilczyk1de48a22023-10-30 14:19:19 +0000812 auto guardUnguard = make_scope_guard([&]() {
Steven Morelandd7302072021-05-15 01:32:04 +0000813 if (kernelBinderState != nullptr) {
814 kernelBinderState->restoreGetCallingSpGuard(origGuard);
815 }
Tomasz Wasilczyk1de48a22023-10-30 14:19:19 +0000816 });
Steven Moreland32150282021-11-12 22:54:53 +0000817#endif // BINDER_WITH_KERNEL_IPC
Steven Morelandd7302072021-05-15 01:32:04 +0000818
Steven Moreland5553ac42020-11-11 02:14:45 +0000819 switch (command.command) {
820 case RPC_COMMAND_TRANSACT:
Steven Moreland52eee942021-06-03 00:59:28 +0000821 if (type != CommandType::ANY) return BAD_TYPE;
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000822 return processTransact(connection, session, command, std::move(ancillaryFds));
Steven Moreland5553ac42020-11-11 02:14:45 +0000823 case RPC_COMMAND_DEC_STRONG:
Steven Moreland5ae62562021-06-10 03:21:42 +0000824 return processDecStrong(connection, session, command);
Steven Moreland5553ac42020-11-11 02:14:45 +0000825 }
826
827 // We should always know the version of the opposing side, and since the
828 // RPC-binder-level wire protocol is not self synchronizing, we have no way
829 // to understand where the current command ends and the next one begins. We
830 // also can't consider it a fatal error because this would allow any client
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000831 // to kill us, so ending the session for misbehaving client.
832 ALOGE("Unknown RPC command %d - terminating session", command.command);
Steven Morelandc9d7b532021-06-04 20:57:41 +0000833 (void)session->shutdownAndWait(false);
Steven Moreland5553ac42020-11-11 02:14:45 +0000834 return DEAD_OBJECT;
835}
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000836status_t RpcState::processTransact(
837 const sp<RpcSession::RpcConnection>& connection, const sp<RpcSession>& session,
838 const RpcWireHeader& command,
Tomasz Wasilczyk639490b2023-11-01 13:49:41 -0700839 std::vector<std::variant<unique_fd, borrowed_fd>>&& ancillaryFds) {
Steven Moreland5553ac42020-11-11 02:14:45 +0000840 LOG_ALWAYS_FATAL_IF(command.command != RPC_COMMAND_TRANSACT, "command: %d", command.command);
841
Steven Morelanddbe71832021-05-12 23:31:00 +0000842 CommandData transactionData(command.bodySize);
Steven Morelande8393342021-05-05 23:27:53 +0000843 if (!transactionData.valid()) {
844 return NO_MEMORY;
845 }
Andrei Homescua39e4ed2021-12-10 08:41:54 +0000846 iovec iov{transactionData.data(), transactionData.size()};
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000847 if (status_t status = rpcRec(connection, session, "transaction body", &iov, 1, nullptr);
848 status != OK)
Steven Moreland1e4c2b82021-05-25 01:51:31 +0000849 return status;
Steven Moreland5553ac42020-11-11 02:14:45 +0000850
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000851 return processTransactInternal(connection, session, std::move(transactionData),
852 std::move(ancillaryFds));
Steven Moreland5553ac42020-11-11 02:14:45 +0000853}
854
Frederick Mayle53b6ffe2022-07-15 20:14:01 +0000855static void do_nothing_to_transact_data(const uint8_t* data, size_t dataSize,
Steven Moreland438cce82021-04-02 18:04:08 +0000856 const binder_size_t* objects, size_t objectsCount) {
Steven Moreland438cce82021-04-02 18:04:08 +0000857 (void)data;
858 (void)dataSize;
859 (void)objects;
860 (void)objectsCount;
861}
862
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000863status_t RpcState::processTransactInternal(
864 const sp<RpcSession::RpcConnection>& connection, const sp<RpcSession>& session,
865 CommandData transactionData,
Tomasz Wasilczyk639490b2023-11-01 13:49:41 -0700866 std::vector<std::variant<unique_fd, borrowed_fd>>&& ancillaryFds) {
Steven Morelandada72bd2021-06-09 23:29:13 +0000867 // for 'recursive' calls to this, we have already read and processed the
868 // binder from the transaction data and taken reference counts into account,
869 // so it is cached here.
Steven Moreland3903bf02021-09-27 16:05:24 -0700870 sp<IBinder> target;
Steven Morelandada72bd2021-06-09 23:29:13 +0000871processTransactInternalTailCall:
872
Steven Moreland5553ac42020-11-11 02:14:45 +0000873 if (transactionData.size() < sizeof(RpcWireTransaction)) {
874 ALOGE("Expecting %zu but got %zu bytes for RpcWireTransaction. Terminating!",
875 sizeof(RpcWireTransaction), transactionData.size());
Steven Morelandc9d7b532021-06-04 20:57:41 +0000876 (void)session->shutdownAndWait(false);
Steven Moreland5553ac42020-11-11 02:14:45 +0000877 return BAD_VALUE;
878 }
879 RpcWireTransaction* transaction = reinterpret_cast<RpcWireTransaction*>(transactionData.data());
880
Steven Moreland5623d1a2021-09-10 15:45:34 -0700881 uint64_t addr = RpcWireAddress::toRaw(transaction->address);
Steven Morelandc7d40132021-06-10 03:42:11 +0000882 bool oneway = transaction->flags & IBinder::FLAG_ONEWAY;
Steven Moreland5553ac42020-11-11 02:14:45 +0000883
884 status_t replyStatus = OK;
Steven Moreland5623d1a2021-09-10 15:45:34 -0700885 if (addr != 0) {
Steven Moreland3903bf02021-09-27 16:05:24 -0700886 if (!target) {
Steven Moreland7227c8a2021-06-02 00:24:32 +0000887 replyStatus = onBinderEntering(session, addr, &target);
Steven Morelandf5174272021-05-25 00:39:28 +0000888 }
889
Steven Moreland7227c8a2021-06-02 00:24:32 +0000890 if (replyStatus != OK) {
891 // do nothing
892 } else if (target == nullptr) {
Steven Morelandf5174272021-05-25 00:39:28 +0000893 // This can happen if the binder is remote in this process, and
894 // another thread has called the last decStrong on this binder.
895 // However, for local binders, it indicates a misbehaving client
896 // (any binder which is being transacted on should be holding a
897 // strong ref count), so in either case, terminating the
898 // session.
Steven Moreland5623d1a2021-09-10 15:45:34 -0700899 ALOGE("While transacting, binder has been deleted at address %" PRIu64 ". Terminating!",
900 addr);
Steven Morelandc9d7b532021-06-04 20:57:41 +0000901 (void)session->shutdownAndWait(false);
Steven Morelandf5174272021-05-25 00:39:28 +0000902 replyStatus = BAD_VALUE;
903 } else if (target->localBinder() == nullptr) {
Steven Moreland5623d1a2021-09-10 15:45:34 -0700904 ALOGE("Unknown binder address or non-local binder, not address %" PRIu64
905 ". Terminating!",
906 addr);
Steven Morelandc9d7b532021-06-04 20:57:41 +0000907 (void)session->shutdownAndWait(false);
Steven Morelandf5174272021-05-25 00:39:28 +0000908 replyStatus = BAD_VALUE;
Steven Morelandc7d40132021-06-10 03:42:11 +0000909 } else if (oneway) {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +0000910 RpcMutexUniqueLock _l(mNodeMutex);
Steven Morelandf5174272021-05-25 00:39:28 +0000911 auto it = mNodeForAddress.find(addr);
912 if (it->second.binder.promote() != target) {
Steven Moreland5623d1a2021-09-10 15:45:34 -0700913 ALOGE("Binder became invalid during transaction. Bad client? %" PRIu64, addr);
Steven Moreland5553ac42020-11-11 02:14:45 +0000914 replyStatus = BAD_VALUE;
Steven Morelandf5174272021-05-25 00:39:28 +0000915 } else if (transaction->asyncNumber != it->second.asyncNumber) {
916 // we need to process some other asynchronous transaction
917 // first
Steven Morelandf5174272021-05-25 00:39:28 +0000918 it->second.asyncTodo.push(BinderNode::AsyncTodo{
919 .ref = target,
920 .data = std::move(transactionData),
Frederick Mayleb0221d12022-10-03 23:10:53 +0000921 .ancillaryFds = std::move(ancillaryFds),
Steven Morelandf5174272021-05-25 00:39:28 +0000922 .asyncNumber = transaction->asyncNumber,
923 });
Steven Morelandd45be622021-06-04 02:19:37 +0000924
925 size_t numPending = it->second.asyncTodo.size();
Steven Moreland5623d1a2021-09-10 15:45:34 -0700926 LOG_RPC_DETAIL("Enqueuing %" PRIu64 " on %" PRIu64 " (%zu pending)",
927 transaction->asyncNumber, addr, numPending);
Steven Morelandd45be622021-06-04 02:19:37 +0000928
929 constexpr size_t kArbitraryOnewayCallTerminateLevel = 10000;
930 constexpr size_t kArbitraryOnewayCallWarnLevel = 1000;
931 constexpr size_t kArbitraryOnewayCallWarnPer = 1000;
932
933 if (numPending >= kArbitraryOnewayCallWarnLevel) {
934 if (numPending >= kArbitraryOnewayCallTerminateLevel) {
935 ALOGE("WARNING: %zu pending oneway transactions. Terminating!", numPending);
936 _l.unlock();
937 (void)session->shutdownAndWait(false);
938 return FAILED_TRANSACTION;
939 }
940
941 if (numPending % kArbitraryOnewayCallWarnPer == 0) {
942 ALOGW("Warning: many oneway transactions built up on %p (%zu)",
943 target.get(), numPending);
944 }
945 }
Steven Morelandf5174272021-05-25 00:39:28 +0000946 return OK;
Steven Moreland5553ac42020-11-11 02:14:45 +0000947 }
948 }
949 }
950
Steven Moreland5553ac42020-11-11 02:14:45 +0000951 Parcel reply;
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000952 reply.markForRpc(session);
Steven Moreland5553ac42020-11-11 02:14:45 +0000953
954 if (replyStatus == OK) {
Frederick Mayledc07cf82022-05-26 20:30:12 +0000955 Span<const uint8_t> parcelSpan = {transaction->data,
956 transactionData.size() -
957 offsetof(RpcWireTransaction, data)};
Frederick Mayle69a0c992022-05-26 20:38:39 +0000958 Span<const uint32_t> objectTableSpan;
Steven Moreland28c87282023-04-14 21:03:01 +0000959 if (session->getProtocolVersion().value() >=
Frederick Mayledc07cf82022-05-26 20:30:12 +0000960 RPC_WIRE_PROTOCOL_VERSION_RPC_HEADER_FEATURE_EXPLICIT_PARCEL_SIZE) {
Frederick Mayle16a12ae2022-07-15 00:04:33 +0000961 std::optional<Span<const uint8_t>> objectTableBytes =
962 parcelSpan.splitOff(transaction->parcelDataSize);
963 if (!objectTableBytes.has_value()) {
964 ALOGE("Parcel size (%" PRId32 ") greater than available bytes (%zu). Terminating!",
965 transaction->parcelDataSize, parcelSpan.byteSize());
966 (void)session->shutdownAndWait(false);
967 return BAD_VALUE;
968 }
Frederick Mayle69a0c992022-05-26 20:38:39 +0000969 std::optional<Span<const uint32_t>> maybeSpan =
Frederick Mayle16a12ae2022-07-15 00:04:33 +0000970 objectTableBytes->reinterpret<const uint32_t>();
Frederick Mayle69a0c992022-05-26 20:38:39 +0000971 if (!maybeSpan.has_value()) {
972 ALOGE("Bad object table size inferred from RpcWireTransaction. Saw bodySize=%zu "
973 "sizeofHeader=%zu parcelSize=%" PRId32
974 " objectTableBytesSize=%zu. Terminating!",
975 transactionData.size(), sizeof(RpcWireTransaction),
Frederick Mayle16a12ae2022-07-15 00:04:33 +0000976 transaction->parcelDataSize, objectTableBytes->size);
Frederick Mayle69a0c992022-05-26 20:38:39 +0000977 return BAD_VALUE;
978 }
979 objectTableSpan = *maybeSpan;
Frederick Mayledc07cf82022-05-26 20:30:12 +0000980 }
981
Steven Morelandeff77c12021-04-15 00:37:19 +0000982 Parcel data;
983 // transaction->data is owned by this function. Parcel borrows this data and
984 // only holds onto it for the duration of this function call. Parcel will be
985 // deleted before the 'transactionData' object.
Frederick Mayledc07cf82022-05-26 20:30:12 +0000986
Frederick Mayleffe9ac22022-06-30 02:07:36 +0000987 replyStatus =
988 data.rpcSetDataReference(session, parcelSpan.data, parcelSpan.size,
989 objectTableSpan.data, objectTableSpan.size,
990 std::move(ancillaryFds), do_nothing_to_transact_data);
991 // Reset to avoid spurious use-after-move warning from clang-tidy.
992 ancillaryFds = std::remove_reference<decltype(ancillaryFds)>::type();
Steven Morelandeff77c12021-04-15 00:37:19 +0000993
Frederick Mayle69a0c992022-05-26 20:38:39 +0000994 if (replyStatus == OK) {
995 if (target) {
996 bool origAllowNested = connection->allowNested;
997 connection->allowNested = !oneway;
Steven Morelandc7d40132021-06-10 03:42:11 +0000998
Frederick Mayle69a0c992022-05-26 20:38:39 +0000999 replyStatus = target->transact(transaction->code, data, &reply, transaction->flags);
Steven Morelandc7d40132021-06-10 03:42:11 +00001000
Frederick Mayle69a0c992022-05-26 20:38:39 +00001001 connection->allowNested = origAllowNested;
1002 } else {
1003 LOG_RPC_DETAIL("Got special transaction %u", transaction->code);
Steven Moreland5553ac42020-11-11 02:14:45 +00001004
Frederick Mayle69a0c992022-05-26 20:38:39 +00001005 switch (transaction->code) {
1006 case RPC_SPECIAL_TRANSACT_GET_MAX_THREADS: {
1007 replyStatus = reply.writeInt32(session->getMaxIncomingThreads());
1008 break;
1009 }
1010 case RPC_SPECIAL_TRANSACT_GET_SESSION_ID: {
1011 // for client connections, this should always report the value
1012 // originally returned from the server, so this is asserting
1013 // that it exists
1014 replyStatus = reply.writeByteVector(session->mId);
1015 break;
1016 }
1017 default: {
1018 sp<RpcServer> server = session->server();
1019 if (server) {
1020 switch (transaction->code) {
1021 case RPC_SPECIAL_TRANSACT_GET_ROOT: {
1022 sp<IBinder> root = session->mSessionSpecificRootObject
1023 ?: server->getRootObject();
1024 replyStatus = reply.writeStrongBinder(root);
1025 break;
1026 }
1027 default: {
1028 replyStatus = UNKNOWN_TRANSACTION;
1029 }
Steven Moreland103424e2021-06-02 18:16:19 +00001030 }
Frederick Mayle69a0c992022-05-26 20:38:39 +00001031 } else {
1032 ALOGE("Special command sent, but no server object attached.");
Steven Moreland103424e2021-06-02 18:16:19 +00001033 }
Steven Morelandf137de92021-04-24 01:54:26 +00001034 }
Steven Moreland5553ac42020-11-11 02:14:45 +00001035 }
Steven Moreland5553ac42020-11-11 02:14:45 +00001036 }
1037 }
1038 }
1039
Steven Morelandc7d40132021-06-10 03:42:11 +00001040 if (oneway) {
Steven Moreland5553ac42020-11-11 02:14:45 +00001041 if (replyStatus != OK) {
1042 ALOGW("Oneway call failed with error: %d", replyStatus);
1043 }
1044
Steven Moreland5623d1a2021-09-10 15:45:34 -07001045 LOG_RPC_DETAIL("Processed async transaction %" PRIu64 " on %" PRIu64,
1046 transaction->asyncNumber, addr);
Steven Moreland5553ac42020-11-11 02:14:45 +00001047
1048 // Check to see if there is another asynchronous transaction to process.
1049 // This behavior differs from binder behavior, since in the binder
1050 // driver, asynchronous transactions will be processed after existing
1051 // pending binder transactions on the queue. The downside of this is
1052 // that asynchronous transactions can be drowned out by synchronous
1053 // transactions. However, we have no easy way to queue these
1054 // transactions after the synchronous transactions we may want to read
1055 // from the wire. So, in socket binder here, we have the opposite
1056 // downside: asynchronous transactions may drown out synchronous
1057 // transactions.
1058 {
Andrei Homescuffa3aaa2022-04-07 05:06:33 +00001059 RpcMutexUniqueLock _l(mNodeMutex);
Steven Moreland5553ac42020-11-11 02:14:45 +00001060 auto it = mNodeForAddress.find(addr);
1061 // last refcount dropped after this transaction happened
1062 if (it == mNodeForAddress.end()) return OK;
1063
Steven Morelandc9d7b532021-06-04 20:57:41 +00001064 if (!nodeProgressAsyncNumber(&it->second)) {
1065 _l.unlock();
1066 (void)session->shutdownAndWait(false);
1067 return DEAD_OBJECT;
1068 }
Steven Moreland5553ac42020-11-11 02:14:45 +00001069
Andrei Homescuae5f0d12023-02-25 05:03:31 +00001070 if (it->second.asyncTodo.size() != 0 &&
1071 it->second.asyncTodo.top().asyncNumber == it->second.asyncNumber) {
Steven Moreland5623d1a2021-09-10 15:45:34 -07001072 LOG_RPC_DETAIL("Found next async transaction %" PRIu64 " on %" PRIu64,
1073 it->second.asyncNumber, addr);
Steven Moreland5553ac42020-11-11 02:14:45 +00001074
1075 // justification for const_cast (consider avoiding priority_queue):
Steven Morelandf5174272021-05-25 00:39:28 +00001076 // - AsyncTodo operator< doesn't depend on 'data' or 'ref' objects
Steven Moreland5553ac42020-11-11 02:14:45 +00001077 // - gotta go fast
Steven Morelandf5174272021-05-25 00:39:28 +00001078 auto& todo = const_cast<BinderNode::AsyncTodo&>(it->second.asyncTodo.top());
1079
Steven Morelandada72bd2021-06-09 23:29:13 +00001080 // reset up arguments
1081 transactionData = std::move(todo.data);
Frederick Mayleb0221d12022-10-03 23:10:53 +00001082 ancillaryFds = std::move(todo.ancillaryFds);
Steven Moreland3903bf02021-09-27 16:05:24 -07001083 LOG_ALWAYS_FATAL_IF(target != todo.ref,
1084 "async list should be associated with a binder");
Steven Morelandf5174272021-05-25 00:39:28 +00001085
Steven Moreland5553ac42020-11-11 02:14:45 +00001086 it->second.asyncTodo.pop();
Steven Morelandada72bd2021-06-09 23:29:13 +00001087 goto processTransactInternalTailCall;
Steven Moreland5553ac42020-11-11 02:14:45 +00001088 }
1089 }
Steven Morelandd8083312021-09-22 13:37:10 -07001090
1091 // done processing all the async commands on this binder that we can, so
1092 // write decstrongs on the binder
1093 if (addr != 0 && replyStatus == OK) {
1094 return flushExcessBinderRefs(session, addr, target);
1095 }
1096
Steven Moreland5553ac42020-11-11 02:14:45 +00001097 return OK;
1098 }
1099
Steven Moreland6709cf42021-09-30 15:21:54 -07001100 // Binder refs are flushed for oneway calls only after all calls which are
1101 // built up are executed. Otherwise, they fill up the binder buffer.
1102 if (addr != 0 && replyStatus == OK) {
1103 replyStatus = flushExcessBinderRefs(session, addr, target);
1104 }
1105
Frederick Mayle69a0c992022-05-26 20:38:39 +00001106 std::string errorMsg;
1107 if (status_t status = validateParcel(session, reply, &errorMsg); status != OK) {
1108 ALOGE("Reply Parcel failed validation: %s", errorMsg.c_str());
1109 // Forward the error to the client of the transaction.
1110 reply.freeData();
1111 reply.markForRpc(session);
1112 replyStatus = status;
1113 }
1114
1115 auto* rpcFields = reply.maybeRpcFields();
1116 LOG_ALWAYS_FATAL_IF(rpcFields == nullptr);
1117
Frederick Mayledc07cf82022-05-26 20:30:12 +00001118 const size_t rpcReplyWireSize = RpcWireReply::wireSize(session->getProtocolVersion().value());
1119
Frederick Mayle69a0c992022-05-26 20:38:39 +00001120 Span<const uint32_t> objectTableSpan = Span<const uint32_t>{rpcFields->mObjectPositions.data(),
1121 rpcFields->mObjectPositions.size()};
Frederick Mayledc07cf82022-05-26 20:30:12 +00001122
Frederick Mayle778c0902022-05-27 01:14:57 +00001123 uint32_t bodySize;
Frederick Mayledc07cf82022-05-26 20:30:12 +00001124 LOG_ALWAYS_FATAL_IF(__builtin_add_overflow(rpcReplyWireSize, reply.dataSize(), &bodySize) ||
1125 __builtin_add_overflow(objectTableSpan.byteSize(), bodySize,
1126 &bodySize),
Steven Moreland77c30112021-06-02 20:45:46 +00001127 "Too much data for reply %zu", reply.dataSize());
Steven Moreland77c30112021-06-02 20:45:46 +00001128 RpcWireHeader cmdReply{
1129 .command = RPC_COMMAND_REPLY,
Frederick Mayle778c0902022-05-27 01:14:57 +00001130 .bodySize = bodySize,
Steven Moreland77c30112021-06-02 20:45:46 +00001131 };
Steven Moreland5553ac42020-11-11 02:14:45 +00001132 RpcWireReply rpcReply{
1133 .status = replyStatus,
Frederick Mayledc07cf82022-05-26 20:30:12 +00001134 // NOTE: Not necessarily written to socket depending on session
1135 // version.
1136 // NOTE: bodySize didn't overflow => this cast is safe
1137 .parcelDataSize = static_cast<uint32_t>(reply.dataSize()),
1138 .reserved = {0, 0, 0},
Steven Moreland5553ac42020-11-11 02:14:45 +00001139 };
Andrei Homescua39e4ed2021-12-10 08:41:54 +00001140 iovec iovs[]{
1141 {&cmdReply, sizeof(RpcWireHeader)},
Frederick Mayledc07cf82022-05-26 20:30:12 +00001142 {&rpcReply, rpcReplyWireSize},
Andrei Homescua39e4ed2021-12-10 08:41:54 +00001143 {const_cast<uint8_t*>(reply.data()), reply.dataSize()},
Frederick Mayledc07cf82022-05-26 20:30:12 +00001144 objectTableSpan.toIovec(),
Andrei Homescua39e4ed2021-12-10 08:41:54 +00001145 };
Tomasz Wasilczykdf07f942023-11-02 15:07:45 -07001146 return rpcSend(connection, session, "reply", iovs, countof(iovs), std::nullopt,
Frederick Mayle69a0c992022-05-26 20:38:39 +00001147 rpcFields->mFds.get());
Steven Moreland5553ac42020-11-11 02:14:45 +00001148}
1149
Steven Moreland5ae62562021-06-10 03:21:42 +00001150status_t RpcState::processDecStrong(const sp<RpcSession::RpcConnection>& connection,
1151 const sp<RpcSession>& session, const RpcWireHeader& command) {
Steven Moreland5553ac42020-11-11 02:14:45 +00001152 LOG_ALWAYS_FATAL_IF(command.command != RPC_COMMAND_DEC_STRONG, "command: %d", command.command);
1153
Steven Morelandfd1e8a02021-07-21 23:30:29 +00001154 if (command.bodySize != sizeof(RpcDecStrong)) {
1155 ALOGE("Expecting %zu but got %" PRId32 " bytes for RpcDecStrong. Terminating!",
1156 sizeof(RpcDecStrong), command.bodySize);
Steven Morelandc9d7b532021-06-04 20:57:41 +00001157 (void)session->shutdownAndWait(false);
Steven Moreland5553ac42020-11-11 02:14:45 +00001158 return BAD_VALUE;
1159 }
Steven Moreland5553ac42020-11-11 02:14:45 +00001160
Frederick Mayleb86cda42022-06-09 23:17:45 +00001161 RpcDecStrong body;
1162 iovec iov{&body, sizeof(RpcDecStrong)};
Frederick Mayleffe9ac22022-06-30 02:07:36 +00001163 if (status_t status = rpcRec(connection, session, "dec ref body", &iov, 1, nullptr);
1164 status != OK)
Frederick Mayleb86cda42022-06-09 23:17:45 +00001165 return status;
1166
1167 uint64_t addr = RpcWireAddress::toRaw(body.address);
Andrei Homescuffa3aaa2022-04-07 05:06:33 +00001168 RpcMutexUniqueLock _l(mNodeMutex);
Steven Moreland5553ac42020-11-11 02:14:45 +00001169 auto it = mNodeForAddress.find(addr);
1170 if (it == mNodeForAddress.end()) {
Steven Moreland5623d1a2021-09-10 15:45:34 -07001171 ALOGE("Unknown binder address %" PRIu64 " for dec strong.", addr);
Steven Moreland5553ac42020-11-11 02:14:45 +00001172 return OK;
1173 }
1174
1175 sp<IBinder> target = it->second.binder.promote();
1176 if (target == nullptr) {
Steven Moreland5623d1a2021-09-10 15:45:34 -07001177 ALOGE("While requesting dec strong, binder has been deleted at address %" PRIu64
1178 ". Terminating!",
1179 addr);
Steven Morelandc9d7b532021-06-04 20:57:41 +00001180 _l.unlock();
1181 (void)session->shutdownAndWait(false);
Steven Moreland5553ac42020-11-11 02:14:45 +00001182 return BAD_VALUE;
1183 }
1184
Frederick Mayleb86cda42022-06-09 23:17:45 +00001185 if (it->second.timesSent < body.amount) {
Steven Morelandfd1e8a02021-07-21 23:30:29 +00001186 ALOGE("Record of sending binder %zu times, but requested decStrong for %" PRIu64 " of %u",
Frederick Mayleb86cda42022-06-09 23:17:45 +00001187 it->second.timesSent, addr, body.amount);
Steven Moreland5553ac42020-11-11 02:14:45 +00001188 return OK;
1189 }
1190
Steven Moreland5623d1a2021-09-10 15:45:34 -07001191 LOG_ALWAYS_FATAL_IF(it->second.sentRef == nullptr, "Inconsistent state, lost ref for %" PRIu64,
1192 addr);
Steven Moreland5553ac42020-11-11 02:14:45 +00001193
Frederick Mayleb86cda42022-06-09 23:17:45 +00001194 LOG_RPC_DETAIL("Processing dec strong of %" PRIu64 " by %u from %zu", addr, body.amount,
Steven Morelandfd1e8a02021-07-21 23:30:29 +00001195 it->second.timesSent);
1196
Frederick Mayleb86cda42022-06-09 23:17:45 +00001197 it->second.timesSent -= body.amount;
Steven Moreland67f85902023-03-15 01:13:49 +00001198 sp<IBinder> tempHold = tryEraseNode(session, std::move(_l), it);
1199 // LOCK ALREADY RELEASED
Steven Moreland31bde7a2021-06-04 00:57:36 +00001200 tempHold = nullptr; // destructor may make binder calls on this session
1201
1202 return OK;
1203}
1204
Frederick Mayle69a0c992022-05-26 20:38:39 +00001205status_t RpcState::validateParcel(const sp<RpcSession>& session, const Parcel& parcel,
1206 std::string* errorMsg) {
1207 auto* rpcFields = parcel.maybeRpcFields();
1208 if (rpcFields == nullptr) {
1209 *errorMsg = "Parcel not crafted for RPC call";
1210 return BAD_TYPE;
1211 }
1212
1213 if (rpcFields->mSession != session) {
1214 *errorMsg = "Parcel's session doesn't match";
1215 return BAD_TYPE;
1216 }
1217
1218 uint32_t protocolVersion = session->getProtocolVersion().value();
1219 if (protocolVersion < RPC_WIRE_PROTOCOL_VERSION_RPC_HEADER_FEATURE_EXPLICIT_PARCEL_SIZE &&
1220 !rpcFields->mObjectPositions.empty()) {
Tomasz Wasilczyk3caae302023-10-12 20:57:02 +00001221 std::stringstream ss;
1222 ss << "Parcel has attached objects but the session's protocol version (" << protocolVersion
1223 << ") is too old, must be at least "
1224 << RPC_WIRE_PROTOCOL_VERSION_RPC_HEADER_FEATURE_EXPLICIT_PARCEL_SIZE;
1225 *errorMsg = ss.str();
Frederick Mayle69a0c992022-05-26 20:38:39 +00001226 return BAD_VALUE;
1227 }
1228
1229 if (rpcFields->mFds && !rpcFields->mFds->empty()) {
1230 switch (session->getFileDescriptorTransportMode()) {
1231 case RpcSession::FileDescriptorTransportMode::NONE:
1232 *errorMsg =
1233 "Parcel has file descriptors, but no file descriptor transport is enabled";
1234 return FDS_NOT_ALLOWED;
1235 case RpcSession::FileDescriptorTransportMode::UNIX: {
1236 constexpr size_t kMaxFdsPerMsg = 253;
1237 if (rpcFields->mFds->size() > kMaxFdsPerMsg) {
Tomasz Wasilczyk3caae302023-10-12 20:57:02 +00001238 std::stringstream ss;
1239 ss << "Too many file descriptors in Parcel for unix domain socket: "
1240 << rpcFields->mFds->size() << " (max is " << kMaxFdsPerMsg << ")";
1241 *errorMsg = ss.str();
Frederick Mayle69a0c992022-05-26 20:38:39 +00001242 return BAD_VALUE;
1243 }
Andrei Homescu1c18a802022-08-17 04:59:01 +00001244 break;
1245 }
1246 case RpcSession::FileDescriptorTransportMode::TRUSTY: {
1247 // Keep this in sync with trusty_ipc.h!!!
1248 // We could import that file here on Trusty, but it's not
1249 // available on Android
1250 constexpr size_t kMaxFdsPerMsg = 8;
1251 if (rpcFields->mFds->size() > kMaxFdsPerMsg) {
Tomasz Wasilczyk3caae302023-10-12 20:57:02 +00001252 std::stringstream ss;
1253 ss << "Too many file descriptors in Parcel for Trusty IPC connection: "
1254 << rpcFields->mFds->size() << " (max is " << kMaxFdsPerMsg << ")";
1255 *errorMsg = ss.str();
Andrei Homescu1c18a802022-08-17 04:59:01 +00001256 return BAD_VALUE;
1257 }
1258 break;
Frederick Mayle69a0c992022-05-26 20:38:39 +00001259 }
1260 }
1261 }
1262
1263 return OK;
1264}
1265
Steven Moreland67f85902023-03-15 01:13:49 +00001266sp<IBinder> RpcState::tryEraseNode(const sp<RpcSession>& session, RpcMutexUniqueLock nodeLock,
1267 std::map<uint64_t, BinderNode>::iterator& it) {
1268 bool shouldShutdown = false;
1269
Steven Moreland31bde7a2021-06-04 00:57:36 +00001270 sp<IBinder> ref;
1271
Steven Moreland5553ac42020-11-11 02:14:45 +00001272 if (it->second.timesSent == 0) {
Steven Moreland31bde7a2021-06-04 00:57:36 +00001273 ref = std::move(it->second.sentRef);
Steven Moreland5553ac42020-11-11 02:14:45 +00001274
1275 if (it->second.timesRecd == 0) {
Steven Morelanda6e11cf2021-06-04 00:58:31 +00001276 LOG_ALWAYS_FATAL_IF(!it->second.asyncTodo.empty(),
1277 "Can't delete binder w/ pending async transactions");
Steven Moreland5553ac42020-11-11 02:14:45 +00001278 mNodeForAddress.erase(it);
Steven Moreland67f85902023-03-15 01:13:49 +00001279
1280 if (mNodeForAddress.size() == 0) {
1281 shouldShutdown = true;
1282 }
Steven Moreland5553ac42020-11-11 02:14:45 +00001283 }
1284 }
1285
Steven Moreland67f85902023-03-15 01:13:49 +00001286 // If we shutdown, prevent RpcState from being re-used. This prevents another
1287 // thread from getting the root object again.
1288 if (shouldShutdown) {
1289 clear(std::move(nodeLock));
1290 } else {
1291 nodeLock.unlock(); // explicit
1292 }
1293 // LOCK IS RELEASED
1294
1295 if (shouldShutdown) {
1296 ALOGI("RpcState has no binders left, so triggering shutdown...");
1297 (void)session->shutdownAndWait(false);
1298 }
1299
Steven Moreland31bde7a2021-06-04 00:57:36 +00001300 return ref;
Steven Moreland5553ac42020-11-11 02:14:45 +00001301}
1302
Steven Morelandc9d7b532021-06-04 20:57:41 +00001303bool RpcState::nodeProgressAsyncNumber(BinderNode* node) {
Steven Moreland583a14a2021-06-04 02:04:58 +00001304 // 2**64 =~ 10**19 =~ 1000 transactions per second for 585 million years to
1305 // a single binder
1306 if (node->asyncNumber >= std::numeric_limits<decltype(node->asyncNumber)>::max()) {
1307 ALOGE("Out of async transaction IDs. Terminating");
Steven Moreland583a14a2021-06-04 02:04:58 +00001308 return false;
1309 }
1310 node->asyncNumber++;
1311 return true;
1312}
1313
Steven Moreland5553ac42020-11-11 02:14:45 +00001314} // namespace android