blob: 1111b822c47f626b72863b1931074b682104a481 [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
Steven Morelandd7302072021-05-15 01:32:04 +000021#include <android-base/scopeguard.h>
Steven Moreland5553ac42020-11-11 02:14:45 +000022#include <binder/BpBinder.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"
28
29#include <inttypes.h>
30
31namespace android {
32
Steven Morelandd7302072021-05-15 01:32:04 +000033using base::ScopeGuard;
34
Steven Moreland5553ac42020-11-11 02:14:45 +000035RpcState::RpcState() {}
36RpcState::~RpcState() {}
37
Steven Morelandbdb53ab2021-05-05 17:57:41 +000038status_t RpcState::onBinderLeaving(const sp<RpcSession>& session, const sp<IBinder>& binder,
Steven Moreland5553ac42020-11-11 02:14:45 +000039 RpcAddress* outAddress) {
40 bool isRemote = binder->remoteBinder();
41 bool isRpc = isRemote && binder->remoteBinder()->isRpcBinder();
42
Steven Morelandbdb53ab2021-05-05 17:57:41 +000043 if (isRpc && binder->remoteBinder()->getPrivateAccessorForId().rpcSession() != session) {
Steven Moreland5553ac42020-11-11 02:14:45 +000044 // We need to be able to send instructions over the socket for how to
45 // connect to a different server, and we also need to let the host
46 // process know that this is happening.
Steven Morelandbdb53ab2021-05-05 17:57:41 +000047 ALOGE("Cannot send binder from unrelated binder RPC session.");
Steven Moreland5553ac42020-11-11 02:14:45 +000048 return INVALID_OPERATION;
49 }
50
51 if (isRemote && !isRpc) {
52 // Without additional work, this would have the effect of using this
53 // process to proxy calls from the socket over to the other process, and
54 // it would make those calls look like they come from us (not over the
55 // sockets). In order to make this work transparently like binder, we
56 // would instead need to send instructions over the socket for how to
57 // connect to the host process, and we also need to let the host process
58 // know this was happening.
59 ALOGE("Cannot send binder proxy %p over sockets", binder.get());
60 return INVALID_OPERATION;
61 }
62
63 std::lock_guard<std::mutex> _l(mNodeMutex);
64
65 // TODO(b/182939933): maybe move address out of BpBinder, and keep binder->address map
66 // in RpcState
67 for (auto& [addr, node] : mNodeForAddress) {
68 if (binder == node.binder) {
69 if (isRpc) {
70 const RpcAddress& actualAddr =
71 binder->remoteBinder()->getPrivateAccessorForId().rpcAddress();
72 // TODO(b/182939933): this is only checking integrity of data structure
73 // a different data structure doesn't need this
74 LOG_ALWAYS_FATAL_IF(addr < actualAddr, "Address mismatch");
75 LOG_ALWAYS_FATAL_IF(actualAddr < addr, "Address mismatch");
76 }
77 node.timesSent++;
78 node.sentRef = binder; // might already be set
79 *outAddress = addr;
80 return OK;
81 }
82 }
83 LOG_ALWAYS_FATAL_IF(isRpc, "RPC binder must have known address at this point");
84
85 auto&& [it, inserted] = mNodeForAddress.insert({RpcAddress::unique(),
86 BinderNode{
87 .binder = binder,
88 .timesSent = 1,
89 .sentRef = binder,
90 }});
91 // TODO(b/182939933): better organization could avoid needing this log
92 LOG_ALWAYS_FATAL_IF(!inserted);
93
94 *outAddress = it->first;
95 return OK;
96}
97
Steven Morelandbdb53ab2021-05-05 17:57:41 +000098sp<IBinder> RpcState::onBinderEntering(const sp<RpcSession>& session, const RpcAddress& address) {
Steven Moreland5553ac42020-11-11 02:14:45 +000099 std::unique_lock<std::mutex> _l(mNodeMutex);
100
101 if (auto it = mNodeForAddress.find(address); it != mNodeForAddress.end()) {
102 sp<IBinder> binder = it->second.binder.promote();
103
104 // implicitly have strong RPC refcount, since we received this binder
105 it->second.timesRecd++;
106
107 _l.unlock();
108
109 // We have timesRecd RPC refcounts, but we only need to hold on to one
110 // when we keep the object. All additional dec strongs are sent
111 // immediately, we wait to send the last one in BpBinder::onLastDecStrong.
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000112 (void)session->sendDecStrong(address);
Steven Moreland5553ac42020-11-11 02:14:45 +0000113
114 return binder;
115 }
116
117 auto&& [it, inserted] = mNodeForAddress.insert({address, BinderNode{}});
118 LOG_ALWAYS_FATAL_IF(!inserted, "Failed to insert binder when creating proxy");
119
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000120 // Currently, all binders are assumed to be part of the same session (no
Steven Moreland5553ac42020-11-11 02:14:45 +0000121 // device global binders in the RPC world).
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000122 sp<IBinder> binder = BpBinder::create(session, it->first);
Steven Moreland5553ac42020-11-11 02:14:45 +0000123 it->second.binder = binder;
124 it->second.timesRecd = 1;
125 return binder;
126}
127
128size_t RpcState::countBinders() {
129 std::lock_guard<std::mutex> _l(mNodeMutex);
130 return mNodeForAddress.size();
131}
132
133void RpcState::dump() {
134 std::lock_guard<std::mutex> _l(mNodeMutex);
135 ALOGE("DUMP OF RpcState %p", this);
136 ALOGE("DUMP OF RpcState (%zu nodes)", mNodeForAddress.size());
137 for (const auto& [address, node] : mNodeForAddress) {
138 sp<IBinder> binder = node.binder.promote();
139
140 const char* desc;
141 if (binder) {
142 if (binder->remoteBinder()) {
143 if (binder->remoteBinder()->isRpcBinder()) {
144 desc = "(rpc binder proxy)";
145 } else {
146 desc = "(binder proxy)";
147 }
148 } else {
149 desc = "(local binder)";
150 }
151 } else {
152 desc = "(null)";
153 }
154
155 ALOGE("- BINDER NODE: %p times sent:%zu times recd: %zu a:%s type:%s",
156 node.binder.unsafe_get(), node.timesSent, node.timesRecd, address.toString().c_str(),
157 desc);
158 }
159 ALOGE("END DUMP OF RpcState");
160}
161
162void RpcState::terminate() {
163 if (SHOULD_LOG_RPC_DETAIL) {
164 ALOGE("RpcState::terminate()");
165 dump();
166 }
167
168 // if the destructor of a binder object makes another RPC call, then calling
169 // decStrong could deadlock. So, we must hold onto these binders until
170 // mNodeMutex is no longer taken.
171 std::vector<sp<IBinder>> tempHoldBinder;
172
173 {
174 std::lock_guard<std::mutex> _l(mNodeMutex);
175 mTerminated = true;
176 for (auto& [address, node] : mNodeForAddress) {
177 sp<IBinder> binder = node.binder.promote();
178 LOG_ALWAYS_FATAL_IF(binder == nullptr, "Binder %p expected to be owned.", binder.get());
179
180 if (node.sentRef != nullptr) {
181 tempHoldBinder.push_back(node.sentRef);
182 }
183 }
184
185 mNodeForAddress.clear();
186 }
187}
188
Steven Morelanddbe71832021-05-12 23:31:00 +0000189RpcState::CommandData::CommandData(size_t size) : mSize(size) {
190 // The maximum size for regular binder is 1MB for all concurrent
191 // transactions. A very small proportion of transactions are even
192 // larger than a page, but we need to avoid allocating too much
193 // data on behalf of an arbitrary client, or we could risk being in
194 // a position where a single additional allocation could run out of
195 // memory.
196 //
197 // Note, this limit may not reflect the total amount of data allocated for a
198 // transaction (in some cases, additional fixed size amounts are added),
199 // though for rough consistency, we should avoid cases where this data type
200 // is used for multiple dynamic allocations for a single transaction.
201 constexpr size_t kMaxTransactionAllocation = 100 * 1000;
202 if (size == 0) return;
203 if (size > kMaxTransactionAllocation) {
204 ALOGW("Transaction requested too much data allocation %zu", size);
205 return;
206 }
207 mData.reset(new (std::nothrow) uint8_t[size]);
208}
209
Steven Moreland5553ac42020-11-11 02:14:45 +0000210bool RpcState::rpcSend(const base::unique_fd& fd, const char* what, const void* data, size_t size) {
211 LOG_RPC_DETAIL("Sending %s on fd %d: %s", what, fd.get(), hexString(data, size).c_str());
212
213 if (size > std::numeric_limits<ssize_t>::max()) {
214 ALOGE("Cannot send %s at size %zu (too big)", what, size);
215 terminate();
216 return false;
217 }
218
Steven Morelandc6ddf362021-04-02 01:13:36 +0000219 ssize_t sent = TEMP_FAILURE_RETRY(send(fd.get(), data, size, MSG_NOSIGNAL));
Steven Moreland5553ac42020-11-11 02:14:45 +0000220
221 if (sent < 0 || sent != static_cast<ssize_t>(size)) {
222 ALOGE("Failed to send %s (sent %zd of %zu bytes) on fd %d, error: %s", what, sent, size,
223 fd.get(), strerror(errno));
224
225 terminate();
226 return false;
227 }
228
229 return true;
230}
231
Steven Morelandee3f4662021-05-22 01:07:33 +0000232bool RpcState::rpcRec(const base::unique_fd& fd, const sp<RpcSession>& session, const char* what,
233 void* data, size_t size) {
Steven Moreland5553ac42020-11-11 02:14:45 +0000234 if (size > std::numeric_limits<ssize_t>::max()) {
235 ALOGE("Cannot rec %s at size %zu (too big)", what, size);
236 terminate();
237 return false;
238 }
239
Steven Morelandee3f4662021-05-22 01:07:33 +0000240 if (status_t status = session->mShutdownTrigger->interruptableReadFully(fd.get(), data, size);
241 status != OK) {
Steven Morelandaf4ca712021-05-24 23:22:08 +0000242 if (status != -ECANCELED) {
243 ALOGE("Failed to read %s (%zu bytes) on fd %d, error: %s", what, size, fd.get(),
244 statusToString(status).c_str());
245 }
246
Steven Moreland5553ac42020-11-11 02:14:45 +0000247 return false;
Steven Moreland5553ac42020-11-11 02:14:45 +0000248 }
249
Steven Morelandee3f4662021-05-22 01:07:33 +0000250 LOG_RPC_DETAIL("Received %s on fd %d: %s", what, fd.get(), hexString(data, size).c_str());
Steven Moreland5553ac42020-11-11 02:14:45 +0000251 return true;
252}
253
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000254sp<IBinder> RpcState::getRootObject(const base::unique_fd& fd, const sp<RpcSession>& session) {
Steven Moreland5553ac42020-11-11 02:14:45 +0000255 Parcel data;
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000256 data.markForRpc(session);
Steven Moreland5553ac42020-11-11 02:14:45 +0000257 Parcel reply;
258
Steven Morelandf5174272021-05-25 00:39:28 +0000259 status_t status = transactAddress(fd, RpcAddress::zero(), RPC_SPECIAL_TRANSACT_GET_ROOT, data,
260 session, &reply, 0);
Steven Moreland5553ac42020-11-11 02:14:45 +0000261 if (status != OK) {
262 ALOGE("Error getting root object: %s", statusToString(status).c_str());
263 return nullptr;
264 }
265
266 return reply.readStrongBinder();
267}
268
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000269status_t RpcState::getMaxThreads(const base::unique_fd& fd, const sp<RpcSession>& session,
Steven Moreland7c5e6c22021-05-01 02:55:20 +0000270 size_t* maxThreadsOut) {
Steven Morelandf137de92021-04-24 01:54:26 +0000271 Parcel data;
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000272 data.markForRpc(session);
Steven Morelandf137de92021-04-24 01:54:26 +0000273 Parcel reply;
274
Steven Morelandf5174272021-05-25 00:39:28 +0000275 status_t status = transactAddress(fd, RpcAddress::zero(), RPC_SPECIAL_TRANSACT_GET_MAX_THREADS,
276 data, session, &reply, 0);
Steven Morelandf137de92021-04-24 01:54:26 +0000277 if (status != OK) {
278 ALOGE("Error getting max threads: %s", statusToString(status).c_str());
279 return status;
280 }
281
Steven Moreland7c5e6c22021-05-01 02:55:20 +0000282 int32_t maxThreads;
283 status = reply.readInt32(&maxThreads);
Steven Morelandf137de92021-04-24 01:54:26 +0000284 if (status != OK) return status;
Steven Moreland7c5e6c22021-05-01 02:55:20 +0000285 if (maxThreads <= 0) {
286 ALOGE("Error invalid max maxThreads: %d", maxThreads);
Steven Morelandf137de92021-04-24 01:54:26 +0000287 return BAD_VALUE;
288 }
289
Steven Moreland7c5e6c22021-05-01 02:55:20 +0000290 *maxThreadsOut = maxThreads;
291 return OK;
292}
293
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000294status_t RpcState::getSessionId(const base::unique_fd& fd, const sp<RpcSession>& session,
295 int32_t* sessionIdOut) {
Steven Moreland7c5e6c22021-05-01 02:55:20 +0000296 Parcel data;
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000297 data.markForRpc(session);
Steven Moreland7c5e6c22021-05-01 02:55:20 +0000298 Parcel reply;
299
Steven Morelandf5174272021-05-25 00:39:28 +0000300 status_t status = transactAddress(fd, RpcAddress::zero(), RPC_SPECIAL_TRANSACT_GET_SESSION_ID,
301 data, session, &reply, 0);
Steven Moreland7c5e6c22021-05-01 02:55:20 +0000302 if (status != OK) {
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000303 ALOGE("Error getting session ID: %s", statusToString(status).c_str());
Steven Moreland7c5e6c22021-05-01 02:55:20 +0000304 return status;
305 }
306
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000307 int32_t sessionId;
308 status = reply.readInt32(&sessionId);
Steven Moreland7c5e6c22021-05-01 02:55:20 +0000309 if (status != OK) return status;
310
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000311 *sessionIdOut = sessionId;
Steven Morelandf137de92021-04-24 01:54:26 +0000312 return OK;
313}
314
Steven Morelandf5174272021-05-25 00:39:28 +0000315status_t RpcState::transact(const base::unique_fd& fd, const sp<IBinder>& binder, uint32_t code,
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000316 const Parcel& data, const sp<RpcSession>& session, Parcel* reply,
Steven Moreland5553ac42020-11-11 02:14:45 +0000317 uint32_t flags) {
Steven Morelandf5174272021-05-25 00:39:28 +0000318 if (!data.isForRpc()) {
319 ALOGE("Refusing to send RPC with parcel not crafted for RPC");
320 return BAD_TYPE;
321 }
322
323 if (data.objectsCount() != 0) {
324 ALOGE("Parcel at %p has attached objects but is being used in an RPC call", &data);
325 return BAD_TYPE;
326 }
327
328 RpcAddress address = RpcAddress::zero();
329 if (status_t status = onBinderLeaving(session, binder, &address); status != OK) return status;
330
331 return transactAddress(fd, address, code, data, session, reply, flags);
332}
333
334status_t RpcState::transactAddress(const base::unique_fd& fd, const RpcAddress& address,
335 uint32_t code, const Parcel& data, const sp<RpcSession>& session,
336 Parcel* reply, uint32_t flags) {
337 LOG_ALWAYS_FATAL_IF(!data.isForRpc());
338 LOG_ALWAYS_FATAL_IF(data.objectsCount() != 0);
339
Steven Moreland5553ac42020-11-11 02:14:45 +0000340 uint64_t asyncNumber = 0;
341
342 if (!address.isZero()) {
343 std::lock_guard<std::mutex> _l(mNodeMutex);
344 if (mTerminated) return DEAD_OBJECT; // avoid fatal only, otherwise races
345 auto it = mNodeForAddress.find(address);
346 LOG_ALWAYS_FATAL_IF(it == mNodeForAddress.end(), "Sending transact on unknown address %s",
347 address.toString().c_str());
348
349 if (flags & IBinder::FLAG_ONEWAY) {
350 asyncNumber = it->second.asyncNumber++;
351 }
352 }
353
Steven Moreland5553ac42020-11-11 02:14:45 +0000354 RpcWireTransaction transaction{
355 .address = address.viewRawEmbedded(),
356 .code = code,
357 .flags = flags,
358 .asyncNumber = asyncNumber,
359 };
360
Steven Morelanddbe71832021-05-12 23:31:00 +0000361 CommandData transactionData(sizeof(RpcWireTransaction) + data.dataSize());
Steven Morelande8393342021-05-05 23:27:53 +0000362 if (!transactionData.valid()) {
363 return NO_MEMORY;
364 }
365
Steven Moreland5553ac42020-11-11 02:14:45 +0000366 memcpy(transactionData.data() + 0, &transaction, sizeof(RpcWireTransaction));
367 memcpy(transactionData.data() + sizeof(RpcWireTransaction), data.data(), data.dataSize());
368
369 if (transactionData.size() > std::numeric_limits<uint32_t>::max()) {
370 ALOGE("Transaction size too big %zu", transactionData.size());
371 return BAD_VALUE;
372 }
373
374 RpcWireHeader command{
375 .command = RPC_COMMAND_TRANSACT,
376 .bodySize = static_cast<uint32_t>(transactionData.size()),
377 };
378
379 if (!rpcSend(fd, "transact header", &command, sizeof(command))) {
380 return DEAD_OBJECT;
381 }
382 if (!rpcSend(fd, "command body", transactionData.data(), transactionData.size())) {
383 return DEAD_OBJECT;
384 }
385
386 if (flags & IBinder::FLAG_ONEWAY) {
387 return OK; // do not wait for result
388 }
389
390 LOG_ALWAYS_FATAL_IF(reply == nullptr, "Reply parcel must be used for synchronous transaction.");
391
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000392 return waitForReply(fd, session, reply);
Steven Moreland5553ac42020-11-11 02:14:45 +0000393}
394
Steven Moreland438cce82021-04-02 18:04:08 +0000395static void cleanup_reply_data(Parcel* p, const uint8_t* data, size_t dataSize,
396 const binder_size_t* objects, size_t objectsCount) {
Steven Moreland5553ac42020-11-11 02:14:45 +0000397 (void)p;
398 delete[] const_cast<uint8_t*>(data - offsetof(RpcWireReply, data));
399 (void)dataSize;
400 LOG_ALWAYS_FATAL_IF(objects != nullptr);
401 LOG_ALWAYS_FATAL_IF(objectsCount, 0);
402}
403
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000404status_t RpcState::waitForReply(const base::unique_fd& fd, const sp<RpcSession>& session,
Steven Moreland5553ac42020-11-11 02:14:45 +0000405 Parcel* reply) {
406 RpcWireHeader command;
407 while (true) {
Steven Morelandee3f4662021-05-22 01:07:33 +0000408 if (!rpcRec(fd, session, "command header", &command, sizeof(command))) {
Steven Moreland5553ac42020-11-11 02:14:45 +0000409 return DEAD_OBJECT;
410 }
411
412 if (command.command == RPC_COMMAND_REPLY) break;
413
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000414 status_t status = processServerCommand(fd, session, command);
Steven Moreland5553ac42020-11-11 02:14:45 +0000415 if (status != OK) return status;
416 }
417
Steven Morelanddbe71832021-05-12 23:31:00 +0000418 CommandData data(command.bodySize);
Steven Morelande8393342021-05-05 23:27:53 +0000419 if (!data.valid()) {
420 return NO_MEMORY;
421 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000422
Steven Morelandee3f4662021-05-22 01:07:33 +0000423 if (!rpcRec(fd, session, "reply body", data.data(), command.bodySize)) {
Steven Moreland5553ac42020-11-11 02:14:45 +0000424 return DEAD_OBJECT;
425 }
426
427 if (command.bodySize < sizeof(RpcWireReply)) {
428 ALOGE("Expecting %zu but got %" PRId32 " bytes for RpcWireReply. Terminating!",
429 sizeof(RpcWireReply), command.bodySize);
430 terminate();
431 return BAD_VALUE;
432 }
Steven Morelande8393342021-05-05 23:27:53 +0000433 RpcWireReply* rpcReply = reinterpret_cast<RpcWireReply*>(data.data());
Steven Moreland5553ac42020-11-11 02:14:45 +0000434 if (rpcReply->status != OK) return rpcReply->status;
435
Steven Morelande8393342021-05-05 23:27:53 +0000436 data.release();
Steven Moreland5553ac42020-11-11 02:14:45 +0000437 reply->ipcSetDataReference(rpcReply->data, command.bodySize - offsetof(RpcWireReply, data),
Steven Moreland438cce82021-04-02 18:04:08 +0000438 nullptr, 0, cleanup_reply_data);
Steven Moreland5553ac42020-11-11 02:14:45 +0000439
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000440 reply->markForRpc(session);
Steven Moreland5553ac42020-11-11 02:14:45 +0000441
442 return OK;
443}
444
445status_t RpcState::sendDecStrong(const base::unique_fd& fd, const RpcAddress& addr) {
446 {
447 std::lock_guard<std::mutex> _l(mNodeMutex);
448 if (mTerminated) return DEAD_OBJECT; // avoid fatal only, otherwise races
449 auto it = mNodeForAddress.find(addr);
450 LOG_ALWAYS_FATAL_IF(it == mNodeForAddress.end(), "Sending dec strong on unknown address %s",
451 addr.toString().c_str());
452 LOG_ALWAYS_FATAL_IF(it->second.timesRecd <= 0, "Bad dec strong %s",
453 addr.toString().c_str());
454
455 it->second.timesRecd--;
456 if (it->second.timesRecd == 0 && it->second.timesSent == 0) {
457 mNodeForAddress.erase(it);
458 }
459 }
460
461 RpcWireHeader cmd = {
462 .command = RPC_COMMAND_DEC_STRONG,
463 .bodySize = sizeof(RpcWireAddress),
464 };
465 if (!rpcSend(fd, "dec ref header", &cmd, sizeof(cmd))) return DEAD_OBJECT;
466 if (!rpcSend(fd, "dec ref body", &addr.viewRawEmbedded(), sizeof(RpcWireAddress)))
467 return DEAD_OBJECT;
468 return OK;
469}
470
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000471status_t RpcState::getAndExecuteCommand(const base::unique_fd& fd, const sp<RpcSession>& session) {
Steven Moreland5553ac42020-11-11 02:14:45 +0000472 LOG_RPC_DETAIL("getAndExecuteCommand on fd %d", fd.get());
473
474 RpcWireHeader command;
Steven Morelandee3f4662021-05-22 01:07:33 +0000475 if (!rpcRec(fd, session, "command header", &command, sizeof(command))) {
Steven Moreland5553ac42020-11-11 02:14:45 +0000476 return DEAD_OBJECT;
477 }
478
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000479 return processServerCommand(fd, session, command);
Steven Moreland5553ac42020-11-11 02:14:45 +0000480}
481
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000482status_t RpcState::processServerCommand(const base::unique_fd& fd, const sp<RpcSession>& session,
Steven Moreland5553ac42020-11-11 02:14:45 +0000483 const RpcWireHeader& command) {
Steven Morelandd7302072021-05-15 01:32:04 +0000484 IPCThreadState* kernelBinderState = IPCThreadState::selfOrNull();
485 IPCThreadState::SpGuard spGuard{
486 .address = __builtin_frame_address(0),
487 .context = "processing binder RPC command",
488 };
489 const IPCThreadState::SpGuard* origGuard;
490 if (kernelBinderState != nullptr) {
491 origGuard = kernelBinderState->pushGetCallingSpGuard(&spGuard);
492 }
493 ScopeGuard guardUnguard = [&]() {
494 if (kernelBinderState != nullptr) {
495 kernelBinderState->restoreGetCallingSpGuard(origGuard);
496 }
497 };
498
Steven Moreland5553ac42020-11-11 02:14:45 +0000499 switch (command.command) {
500 case RPC_COMMAND_TRANSACT:
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000501 return processTransact(fd, session, command);
Steven Moreland5553ac42020-11-11 02:14:45 +0000502 case RPC_COMMAND_DEC_STRONG:
Steven Morelandee3f4662021-05-22 01:07:33 +0000503 return processDecStrong(fd, session, command);
Steven Moreland5553ac42020-11-11 02:14:45 +0000504 }
505
506 // We should always know the version of the opposing side, and since the
507 // RPC-binder-level wire protocol is not self synchronizing, we have no way
508 // to understand where the current command ends and the next one begins. We
509 // also can't consider it a fatal error because this would allow any client
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000510 // to kill us, so ending the session for misbehaving client.
511 ALOGE("Unknown RPC command %d - terminating session", command.command);
Steven Moreland5553ac42020-11-11 02:14:45 +0000512 terminate();
513 return DEAD_OBJECT;
514}
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000515status_t RpcState::processTransact(const base::unique_fd& fd, const sp<RpcSession>& session,
Steven Moreland5553ac42020-11-11 02:14:45 +0000516 const RpcWireHeader& command) {
517 LOG_ALWAYS_FATAL_IF(command.command != RPC_COMMAND_TRANSACT, "command: %d", command.command);
518
Steven Morelanddbe71832021-05-12 23:31:00 +0000519 CommandData transactionData(command.bodySize);
Steven Morelande8393342021-05-05 23:27:53 +0000520 if (!transactionData.valid()) {
521 return NO_MEMORY;
522 }
Steven Morelandee3f4662021-05-22 01:07:33 +0000523 if (!rpcRec(fd, session, "transaction body", transactionData.data(), transactionData.size())) {
Steven Moreland5553ac42020-11-11 02:14:45 +0000524 return DEAD_OBJECT;
525 }
526
Steven Morelandf5174272021-05-25 00:39:28 +0000527 return processTransactInternal(fd, session, std::move(transactionData), nullptr /*targetRef*/);
Steven Moreland5553ac42020-11-11 02:14:45 +0000528}
529
Steven Moreland438cce82021-04-02 18:04:08 +0000530static void do_nothing_to_transact_data(Parcel* p, const uint8_t* data, size_t dataSize,
531 const binder_size_t* objects, size_t objectsCount) {
532 (void)p;
533 (void)data;
534 (void)dataSize;
535 (void)objects;
536 (void)objectsCount;
537}
538
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000539status_t RpcState::processTransactInternal(const base::unique_fd& fd, const sp<RpcSession>& session,
Steven Morelandf5174272021-05-25 00:39:28 +0000540 CommandData transactionData, sp<IBinder>&& targetRef) {
Steven Moreland5553ac42020-11-11 02:14:45 +0000541 if (transactionData.size() < sizeof(RpcWireTransaction)) {
542 ALOGE("Expecting %zu but got %zu bytes for RpcWireTransaction. Terminating!",
543 sizeof(RpcWireTransaction), transactionData.size());
544 terminate();
545 return BAD_VALUE;
546 }
547 RpcWireTransaction* transaction = reinterpret_cast<RpcWireTransaction*>(transactionData.data());
548
549 // TODO(b/182939933): heap allocation just for lookup in mNodeForAddress,
550 // maybe add an RpcAddress 'view' if the type remains 'heavy'
551 auto addr = RpcAddress::fromRawEmbedded(&transaction->address);
552
553 status_t replyStatus = OK;
554 sp<IBinder> target;
555 if (!addr.isZero()) {
Steven Morelandf5174272021-05-25 00:39:28 +0000556 if (!targetRef) {
557 target = onBinderEntering(session, addr);
Steven Moreland5553ac42020-11-11 02:14:45 +0000558 } else {
Steven Morelandf5174272021-05-25 00:39:28 +0000559 target = targetRef;
560 }
561
562 if (target == nullptr) {
563 // This can happen if the binder is remote in this process, and
564 // another thread has called the last decStrong on this binder.
565 // However, for local binders, it indicates a misbehaving client
566 // (any binder which is being transacted on should be holding a
567 // strong ref count), so in either case, terminating the
568 // session.
569 ALOGE("While transacting, binder has been deleted at address %s. Terminating!",
570 addr.toString().c_str());
571 terminate();
572 replyStatus = BAD_VALUE;
573 } else if (target->localBinder() == nullptr) {
574 ALOGE("Unknown binder address or non-local binder, not address %s. Terminating!",
575 addr.toString().c_str());
576 terminate();
577 replyStatus = BAD_VALUE;
578 } else if (transaction->flags & IBinder::FLAG_ONEWAY) {
579 std::lock_guard<std::mutex> _l(mNodeMutex);
580 auto it = mNodeForAddress.find(addr);
581 if (it->second.binder.promote() != target) {
582 ALOGE("Binder became invalid during transaction. Bad client? %s",
Steven Moreland5553ac42020-11-11 02:14:45 +0000583 addr.toString().c_str());
Steven Moreland5553ac42020-11-11 02:14:45 +0000584 replyStatus = BAD_VALUE;
Steven Morelandf5174272021-05-25 00:39:28 +0000585 } else if (transaction->asyncNumber != it->second.asyncNumber) {
586 // we need to process some other asynchronous transaction
587 // first
588 // TODO(b/183140903): limit enqueues/detect overfill for bad client
589 // TODO(b/183140903): detect when an object is deleted when it still has
590 // pending async transactions
591 it->second.asyncTodo.push(BinderNode::AsyncTodo{
592 .ref = target,
593 .data = std::move(transactionData),
594 .asyncNumber = transaction->asyncNumber,
595 });
596 LOG_RPC_DETAIL("Enqueuing %" PRId64 " on %s", transaction->asyncNumber,
597 addr.toString().c_str());
598 return OK;
Steven Moreland5553ac42020-11-11 02:14:45 +0000599 }
600 }
601 }
602
Steven Moreland5553ac42020-11-11 02:14:45 +0000603 Parcel reply;
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000604 reply.markForRpc(session);
Steven Moreland5553ac42020-11-11 02:14:45 +0000605
606 if (replyStatus == OK) {
Steven Morelandeff77c12021-04-15 00:37:19 +0000607 Parcel data;
608 // transaction->data is owned by this function. Parcel borrows this data and
609 // only holds onto it for the duration of this function call. Parcel will be
610 // deleted before the 'transactionData' object.
611 data.ipcSetDataReference(transaction->data,
612 transactionData.size() - offsetof(RpcWireTransaction, data),
613 nullptr /*object*/, 0 /*objectCount*/,
614 do_nothing_to_transact_data);
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000615 data.markForRpc(session);
Steven Morelandeff77c12021-04-15 00:37:19 +0000616
Steven Moreland5553ac42020-11-11 02:14:45 +0000617 if (target) {
618 replyStatus = target->transact(transaction->code, data, &reply, transaction->flags);
619 } else {
620 LOG_RPC_DETAIL("Got special transaction %u", transaction->code);
Steven Moreland5553ac42020-11-11 02:14:45 +0000621
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000622 sp<RpcServer> server = session->server().promote();
Steven Morelandf137de92021-04-24 01:54:26 +0000623 if (server) {
624 // special case for 'zero' address (special server commands)
625 switch (transaction->code) {
626 case RPC_SPECIAL_TRANSACT_GET_ROOT: {
627 replyStatus = reply.writeStrongBinder(server->getRootObject());
628 break;
629 }
630 case RPC_SPECIAL_TRANSACT_GET_MAX_THREADS: {
631 replyStatus = reply.writeInt32(server->getMaxThreads());
632 break;
633 }
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000634 case RPC_SPECIAL_TRANSACT_GET_SESSION_ID: {
635 // only sessions w/ services can be the source of a
636 // session ID (so still guarded by non-null server)
Steven Moreland7c5e6c22021-05-01 02:55:20 +0000637 //
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000638 // sessions associated with servers must have an ID
Steven Moreland7c5e6c22021-05-01 02:55:20 +0000639 // (hence abort)
Steven Morelandee3f4662021-05-22 01:07:33 +0000640 int32_t id = session->mId.value();
Steven Moreland7c5e6c22021-05-01 02:55:20 +0000641 replyStatus = reply.writeInt32(id);
642 break;
643 }
Steven Morelandf137de92021-04-24 01:54:26 +0000644 default: {
645 replyStatus = UNKNOWN_TRANSACTION;
646 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000647 }
Steven Morelandf137de92021-04-24 01:54:26 +0000648 } else {
649 ALOGE("Special command sent, but no server object attached.");
Steven Moreland5553ac42020-11-11 02:14:45 +0000650 }
651 }
652 }
653
654 if (transaction->flags & IBinder::FLAG_ONEWAY) {
655 if (replyStatus != OK) {
656 ALOGW("Oneway call failed with error: %d", replyStatus);
657 }
658
659 LOG_RPC_DETAIL("Processed async transaction %" PRId64 " on %s", transaction->asyncNumber,
660 addr.toString().c_str());
661
662 // Check to see if there is another asynchronous transaction to process.
663 // This behavior differs from binder behavior, since in the binder
664 // driver, asynchronous transactions will be processed after existing
665 // pending binder transactions on the queue. The downside of this is
666 // that asynchronous transactions can be drowned out by synchronous
667 // transactions. However, we have no easy way to queue these
668 // transactions after the synchronous transactions we may want to read
669 // from the wire. So, in socket binder here, we have the opposite
670 // downside: asynchronous transactions may drown out synchronous
671 // transactions.
672 {
673 std::unique_lock<std::mutex> _l(mNodeMutex);
674 auto it = mNodeForAddress.find(addr);
675 // last refcount dropped after this transaction happened
676 if (it == mNodeForAddress.end()) return OK;
677
678 // note - only updated now, instead of later, so that other threads
679 // will queue any later transactions
680
681 // TODO(b/183140903): support > 2**64 async transactions
682 // (we can do this by allowing asyncNumber to wrap, since we
683 // don't expect more than 2**64 simultaneous transactions)
684 it->second.asyncNumber++;
685
686 if (it->second.asyncTodo.size() == 0) return OK;
687 if (it->second.asyncTodo.top().asyncNumber == it->second.asyncNumber) {
688 LOG_RPC_DETAIL("Found next async transaction %" PRId64 " on %s",
689 it->second.asyncNumber, addr.toString().c_str());
690
691 // justification for const_cast (consider avoiding priority_queue):
Steven Morelandf5174272021-05-25 00:39:28 +0000692 // - AsyncTodo operator< doesn't depend on 'data' or 'ref' objects
Steven Moreland5553ac42020-11-11 02:14:45 +0000693 // - gotta go fast
Steven Morelandf5174272021-05-25 00:39:28 +0000694 auto& todo = const_cast<BinderNode::AsyncTodo&>(it->second.asyncTodo.top());
695
696 CommandData nextData = std::move(todo.data);
697 sp<IBinder> nextRef = std::move(todo.ref);
698
Steven Moreland5553ac42020-11-11 02:14:45 +0000699 it->second.asyncTodo.pop();
700 _l.unlock();
Steven Morelandf5174272021-05-25 00:39:28 +0000701 return processTransactInternal(fd, session, std::move(nextData),
702 std::move(nextRef));
Steven Moreland5553ac42020-11-11 02:14:45 +0000703 }
704 }
705 return OK;
706 }
707
708 RpcWireReply rpcReply{
709 .status = replyStatus,
710 };
711
Steven Morelanddbe71832021-05-12 23:31:00 +0000712 CommandData replyData(sizeof(RpcWireReply) + reply.dataSize());
Steven Morelande8393342021-05-05 23:27:53 +0000713 if (!replyData.valid()) {
714 return NO_MEMORY;
715 }
Steven Moreland5553ac42020-11-11 02:14:45 +0000716 memcpy(replyData.data() + 0, &rpcReply, sizeof(RpcWireReply));
717 memcpy(replyData.data() + sizeof(RpcWireReply), reply.data(), reply.dataSize());
718
719 if (replyData.size() > std::numeric_limits<uint32_t>::max()) {
720 ALOGE("Reply size too big %zu", transactionData.size());
721 terminate();
722 return BAD_VALUE;
723 }
724
725 RpcWireHeader cmdReply{
726 .command = RPC_COMMAND_REPLY,
727 .bodySize = static_cast<uint32_t>(replyData.size()),
728 };
729
730 if (!rpcSend(fd, "reply header", &cmdReply, sizeof(RpcWireHeader))) {
731 return DEAD_OBJECT;
732 }
733 if (!rpcSend(fd, "reply body", replyData.data(), replyData.size())) {
734 return DEAD_OBJECT;
735 }
736 return OK;
737}
738
Steven Morelandee3f4662021-05-22 01:07:33 +0000739status_t RpcState::processDecStrong(const base::unique_fd& fd, const sp<RpcSession>& session,
740 const RpcWireHeader& command) {
Steven Moreland5553ac42020-11-11 02:14:45 +0000741 LOG_ALWAYS_FATAL_IF(command.command != RPC_COMMAND_DEC_STRONG, "command: %d", command.command);
742
Steven Morelanddbe71832021-05-12 23:31:00 +0000743 CommandData commandData(command.bodySize);
Steven Morelande8393342021-05-05 23:27:53 +0000744 if (!commandData.valid()) {
745 return NO_MEMORY;
746 }
Steven Morelandee3f4662021-05-22 01:07:33 +0000747 if (!rpcRec(fd, session, "dec ref body", commandData.data(), commandData.size())) {
Steven Moreland5553ac42020-11-11 02:14:45 +0000748 return DEAD_OBJECT;
749 }
750
751 if (command.bodySize < sizeof(RpcWireAddress)) {
752 ALOGE("Expecting %zu but got %" PRId32 " bytes for RpcWireAddress. Terminating!",
753 sizeof(RpcWireAddress), command.bodySize);
754 terminate();
755 return BAD_VALUE;
756 }
757 RpcWireAddress* address = reinterpret_cast<RpcWireAddress*>(commandData.data());
758
759 // TODO(b/182939933): heap allocation just for lookup
760 auto addr = RpcAddress::fromRawEmbedded(address);
761 std::unique_lock<std::mutex> _l(mNodeMutex);
762 auto it = mNodeForAddress.find(addr);
763 if (it == mNodeForAddress.end()) {
764 ALOGE("Unknown binder address %s for dec strong.", addr.toString().c_str());
Steven Moreland5553ac42020-11-11 02:14:45 +0000765 return OK;
766 }
767
768 sp<IBinder> target = it->second.binder.promote();
769 if (target == nullptr) {
770 ALOGE("While requesting dec strong, binder has been deleted at address %s. Terminating!",
771 addr.toString().c_str());
772 terminate();
773 return BAD_VALUE;
774 }
775
776 if (it->second.timesSent == 0) {
777 ALOGE("No record of sending binder, but requested decStrong: %s", addr.toString().c_str());
778 return OK;
779 }
780
781 LOG_ALWAYS_FATAL_IF(it->second.sentRef == nullptr, "Inconsistent state, lost ref for %s",
782 addr.toString().c_str());
783
784 sp<IBinder> tempHold;
785
786 it->second.timesSent--;
787 if (it->second.timesSent == 0) {
788 tempHold = it->second.sentRef;
789 it->second.sentRef = nullptr;
790
791 if (it->second.timesRecd == 0) {
792 mNodeForAddress.erase(it);
793 }
794 }
795
796 _l.unlock();
Steven Morelandbdb53ab2021-05-05 17:57:41 +0000797 tempHold = nullptr; // destructor may make binder calls on this session
Steven Moreland5553ac42020-11-11 02:14:45 +0000798
799 return OK;
800}
801
802} // namespace android