blob: f7dd9c9715ff381f29f52930e2007dc0f3b362fe [file] [log] [blame]
Steven Moreland2e87adc2018-08-20 19:47:00 -07001/*
2 * Copyright (C) 2018 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
Steven Moreland39fdec92022-08-27 00:27:37 +000017#include <android-base/logging.h>
Steven Moreland2e87adc2018-08-20 19:47:00 -070018#include <android/binder_ibinder.h>
Steven Moreland2f405f52020-07-08 22:24:29 +000019#include <android/binder_ibinder_platform.h>
Steven Moreland46b5fea2019-10-15 11:22:18 -070020#include <android/binder_stability.h>
Steven Moreland2e87adc2018-08-20 19:47:00 -070021#include <android/binder_status.h>
Steven Morelandf3034b02018-11-12 17:37:46 -080022#include <binder/IPCThreadState.h>
Ruchir Rastogicc7a7462020-01-31 14:29:15 -080023#include <binder/IResultReceiver.h>
24#include <private/android_filesystem_config.h>
Steven Moreland2e87adc2018-08-20 19:47:00 -070025
Steven Moreland39fdec92022-08-27 00:27:37 +000026#include "ibinder_internal.h"
27#include "parcel_internal.h"
28#include "status_internal.h"
29
Steven Moreland901c7452018-09-04 16:17:28 -070030using DeathRecipient = ::android::IBinder::DeathRecipient;
31
Steven Moreland2e87adc2018-08-20 19:47:00 -070032using ::android::IBinder;
Ruchir Rastogicc7a7462020-01-31 14:29:15 -080033using ::android::IResultReceiver;
Steven Moreland2e87adc2018-08-20 19:47:00 -070034using ::android::Parcel;
35using ::android::sp;
Steven Moreland5d62e442018-09-13 15:01:02 -070036using ::android::status_t;
Steven Moreland009fc1a2022-06-10 17:24:25 +000037using ::android::statusToString;
Steven Moreland2e87adc2018-08-20 19:47:00 -070038using ::android::String16;
Steven Morelanda194c452019-03-04 16:47:07 -080039using ::android::String8;
Steven Moreland2e87adc2018-08-20 19:47:00 -070040using ::android::wp;
41
Steven Moreland71cddc32018-08-30 23:39:22 -070042namespace ABBinderTag {
43
44static const void* kId = "ABBinder";
45static void* kValue = static_cast<void*>(new bool{true});
Steven Moreland94968952018-09-05 14:42:59 -070046void clean(const void* /*id*/, void* /*obj*/, void* /*cookie*/){/* do nothing */};
Steven Moreland71cddc32018-08-30 23:39:22 -070047
48static void attach(const sp<IBinder>& binder) {
Steven Moreland9234c432021-06-29 23:01:10 +000049 // can only attach once
50 CHECK_EQ(nullptr, binder->attachObject(kId, kValue, nullptr /*cookie*/, clean));
Steven Moreland71cddc32018-08-30 23:39:22 -070051}
52static bool has(const sp<IBinder>& binder) {
53 return binder != nullptr && binder->findObject(kId) == kValue;
54}
55
Steven Moreland6cf66ac2018-11-02 18:14:54 -070056} // namespace ABBinderTag
Steven Moreland71cddc32018-08-30 23:39:22 -070057
Steven Moreland94968952018-09-05 14:42:59 -070058namespace ABpBinderTag {
59
Steven Moreland94968952018-09-05 14:42:59 -070060static const void* kId = "ABpBinder";
61struct Value {
62 wp<ABpBinder> binder;
63};
64void clean(const void* id, void* obj, void* cookie) {
Steven Moreland3acd4902022-07-26 18:29:58 +000065 // be weary of leaks!
66 // LOG(INFO) << "Deleting an ABpBinder";
67
Steven Moreland94968952018-09-05 14:42:59 -070068 CHECK(id == kId) << id << " " << obj << " " << cookie;
69
70 delete static_cast<Value*>(obj);
71};
72
Steven Moreland6cf66ac2018-11-02 18:14:54 -070073} // namespace ABpBinderTag
Steven Moreland94968952018-09-05 14:42:59 -070074
Steven Moreland2e87adc2018-08-20 19:47:00 -070075AIBinder::AIBinder(const AIBinder_Class* clazz) : mClazz(clazz) {}
76AIBinder::~AIBinder() {}
77
Steven Moreland94a76792022-12-21 01:20:06 +000078// b/175635923 libcxx causes "implicit-conversion" with a string with invalid char
79static std::string SanitizeString(const String16& str) {
80 std::string sanitized{String8(str)};
81 for (auto& c : sanitized) {
82 if (!isprint(c)) {
83 c = '?';
84 }
85 }
86 return sanitized;
87}
88
89bool AIBinder::associateClass(const AIBinder_Class* clazz) {
90 if (clazz == nullptr) return false;
91
92 // If mClazz is non-null, this must have been called and cached
93 // already. So, we can safely call this first. Due to the implementation
94 // of getInterfaceDescriptor (at time of writing), two simultaneous calls
95 // may lead to extra binder transactions, but this is expected to be
96 // exceedingly rare. Once we have a binder, when we get it again later,
97 // we won't make another binder transaction here.
98 const String16& descriptor = getBinder()->getInterfaceDescriptor();
99 const String16& newDescriptor = clazz->getInterfaceDescriptor();
100
Andrei Homescu9556bb12020-09-21 16:59:45 -0700101 std::lock_guard<std::mutex> lock(mClazzMutex);
Steven Moreland71cddc32018-08-30 23:39:22 -0700102 if (mClazz == clazz) return true;
Steven Moreland2e87adc2018-08-20 19:47:00 -0700103
Steven Morelandfaf25a42022-12-21 02:21:36 +0000104 // If this is an ABpBinder, the first class object becomes the canonical one. The implication
105 // of this is that no API can require a proxy information to get information on how to behave.
106 // from the class itself - which should only store the interface descriptor. The functionality
107 // should be implemented by adding AIBinder_* APIs to set values on binders themselves, by
108 // setting things on AIBinder_Class which get transferred along with the binder, so that they
109 // can be read along with the BpBinder, or by modifying APIs directly (e.g. an option in
110 // onTransact).
111 //
112 // While this check is required to support linkernamespaces, one downside of it is that
113 // you may parcel code to communicate between things in the same process. However, comms
114 // between linkernamespaces like this already happen for cross-language calls like Java<->C++
115 // or Rust<->Java, and there are good stability guarantees here. This interacts with
116 // binder Stability checks exactly like any other in-process call. The stability is known
117 // to the IBinder object, so that it doesn't matter if a class object comes from
118 // a different stability level.
119 if (mClazz != nullptr && !asABpBinder()) {
Steven Moreland63872b52020-10-02 19:28:23 +0000120 const String16& currentDescriptor = mClazz->getInterfaceDescriptor();
Steven Moreland2e87adc2018-08-20 19:47:00 -0700121 if (newDescriptor == currentDescriptor) {
122 LOG(ERROR) << __func__ << ": Class descriptors '" << currentDescriptor
Steven Moreland4d196972021-08-12 15:49:44 -0700123 << "' match during associateClass, but they are different class objects ("
124 << clazz << " vs " << mClazz << "). Class descriptor collision?";
Steven Moreland71cddc32018-08-30 23:39:22 -0700125 } else {
126 LOG(ERROR) << __func__
127 << ": Class cannot be associated on object which already has a class. "
128 "Trying to associate to '"
Steven Moreland63872b52020-10-02 19:28:23 +0000129 << newDescriptor << "' but already set to '" << currentDescriptor << "'.";
Steven Moreland2e87adc2018-08-20 19:47:00 -0700130 }
131
Steven Moreland71cddc32018-08-30 23:39:22 -0700132 // always a failure because we know mClazz != clazz
133 return false;
Steven Moreland2e87adc2018-08-20 19:47:00 -0700134 }
135
Steven Moreland94a76792022-12-21 01:20:06 +0000136 // This will always be an O(n) comparison, but it's expected to be extremely rare.
137 // since it's an error condition. Do the comparison after we take the lock and
138 // check the pointer equality fast path. By always taking the lock, it's also
139 // more flake-proof. However, the check is not dependent on the lock.
Steven Moreland418914a2023-06-28 21:47:14 +0000140 if (descriptor != newDescriptor && !(asABpBinder() && asABpBinder()->isServiceFuzzing())) {
Steven Moreland640c4092020-07-08 00:19:58 +0000141 if (getBinder()->isBinderAlive()) {
Steven Moreland63872b52020-10-02 19:28:23 +0000142 LOG(ERROR) << __func__ << ": Expecting binder to have class '" << newDescriptor
Jooyung Han1f9dcd32021-11-03 13:34:29 +0900143 << "' but descriptor is actually '" << SanitizeString(descriptor) << "'.";
Steven Moreland640c4092020-07-08 00:19:58 +0000144 } else {
145 // b/155793159
Steven Moreland63872b52020-10-02 19:28:23 +0000146 LOG(ERROR) << __func__ << ": Cannot associate class '" << newDescriptor
Steven Moreland009fc1a2022-06-10 17:24:25 +0000147 << "' to dead binder with cached descriptor '" << SanitizeString(descriptor)
148 << "'.";
Steven Moreland640c4092020-07-08 00:19:58 +0000149 }
Steven Moreland71cddc32018-08-30 23:39:22 -0700150 return false;
Steven Moreland2e87adc2018-08-20 19:47:00 -0700151 }
152
Steven Morelandfaf25a42022-12-21 02:21:36 +0000153 // A local binder being set for the first time OR
154 // ignoring a proxy binder which is set multiple time, by considering the first
155 // associated class as the canonical one.
156 if (mClazz == nullptr) {
157 mClazz = clazz;
158 }
159
Steven Moreland94a76792022-12-21 01:20:06 +0000160 return true;
Steven Moreland2e87adc2018-08-20 19:47:00 -0700161}
162
163ABBinder::ABBinder(const AIBinder_Class* clazz, void* userData)
Steven Moreland6cf66ac2018-11-02 18:14:54 -0700164 : AIBinder(clazz), BBinder(), mUserData(userData) {
Steven Moreland2e87adc2018-08-20 19:47:00 -0700165 CHECK(clazz != nullptr);
166}
167ABBinder::~ABBinder() {
168 getClass()->onDestroy(mUserData);
169}
170
171const String16& ABBinder::getInterfaceDescriptor() const {
172 return getClass()->getInterfaceDescriptor();
173}
174
Steven Morelanda194c452019-03-04 16:47:07 -0800175status_t ABBinder::dump(int fd, const ::android::Vector<String16>& args) {
176 AIBinder_onDump onDump = getClass()->onDump;
177
178 if (onDump == nullptr) {
179 return STATUS_OK;
180 }
181
182 // technically UINT32_MAX would be okay here, but INT32_MAX is expected since this may be
183 // null in Java
184 if (args.size() > INT32_MAX) {
185 LOG(ERROR) << "ABBinder::dump received too many arguments: " << args.size();
186 return STATUS_BAD_VALUE;
187 }
188
189 std::vector<String8> utf8Args; // owns memory of utf8s
190 utf8Args.reserve(args.size());
191 std::vector<const char*> utf8Pointers; // what can be passed over NDK API
192 utf8Pointers.reserve(args.size());
193
194 for (size_t i = 0; i < args.size(); i++) {
195 utf8Args.push_back(String8(args[i]));
196 utf8Pointers.push_back(utf8Args[i].c_str());
197 }
198
199 return onDump(this, fd, utf8Pointers.data(), utf8Pointers.size());
200}
201
Steven Moreland5d62e442018-09-13 15:01:02 -0700202status_t ABBinder::onTransact(transaction_code_t code, const Parcel& data, Parcel* reply,
203 binder_flags_t flags) {
Steven Moreland2e87adc2018-08-20 19:47:00 -0700204 if (isUserCommand(code)) {
Steven Morelandf3ed8062021-08-27 14:31:14 -0700205 if (getClass()->writeHeader && !data.checkInterface(this)) {
Steven Moreland9d089af2018-09-18 08:58:09 -0700206 return STATUS_BAD_TYPE;
Steven Moreland2e87adc2018-08-20 19:47:00 -0700207 }
208
209 const AParcel in = AParcel::readOnly(this, &data);
210 AParcel out = AParcel(this, reply, false /*owns*/);
211
Steven Moreland5d62e442018-09-13 15:01:02 -0700212 binder_status_t status = getClass()->onTransact(this, code, &in, &out);
213 return PruneStatusT(status);
Steven Moreland88234072020-08-06 19:32:45 +0000214 } else if (code == SHELL_COMMAND_TRANSACTION && getClass()->handleShellCommand != nullptr) {
Ruchir Rastogicc7a7462020-01-31 14:29:15 -0800215 int in = data.readFileDescriptor();
216 int out = data.readFileDescriptor();
217 int err = data.readFileDescriptor();
218
219 int argc = data.readInt32();
220 std::vector<String8> utf8Args; // owns memory of utf8s
221 std::vector<const char*> utf8Pointers; // what can be passed over NDK API
222 for (int i = 0; i < argc && data.dataAvail() > 0; i++) {
223 utf8Args.push_back(String8(data.readString16()));
224 utf8Pointers.push_back(utf8Args[i].c_str());
225 }
226
227 data.readStrongBinder(); // skip over the IShellCallback
228 sp<IResultReceiver> resultReceiver = IResultReceiver::asInterface(data.readStrongBinder());
229
230 // Shell commands should only be callable by ADB.
231 uid_t uid = AIBinder_getCallingUid();
232 if (uid != AID_ROOT && uid != AID_SHELL) {
233 if (resultReceiver != nullptr) {
234 resultReceiver->send(-1);
235 }
236 return STATUS_PERMISSION_DENIED;
237 }
238
239 // Check that the file descriptors are valid.
240 if (in == STATUS_BAD_TYPE || out == STATUS_BAD_TYPE || err == STATUS_BAD_TYPE) {
241 if (resultReceiver != nullptr) {
242 resultReceiver->send(-1);
243 }
244 return STATUS_BAD_VALUE;
245 }
246
247 binder_status_t status = getClass()->handleShellCommand(
248 this, in, out, err, utf8Pointers.data(), utf8Pointers.size());
249 if (resultReceiver != nullptr) {
250 resultReceiver->send(status);
251 }
252 return status;
Steven Moreland2e87adc2018-08-20 19:47:00 -0700253 } else {
254 return BBinder::onTransact(code, data, reply, flags);
255 }
256}
257
Steven Moreland71cddc32018-08-30 23:39:22 -0700258ABpBinder::ABpBinder(const ::android::sp<::android::IBinder>& binder)
Steven Moreland3acd4902022-07-26 18:29:58 +0000259 : AIBinder(nullptr /*clazz*/), mRemote(binder) {
Steven Moreland2e87adc2018-08-20 19:47:00 -0700260 CHECK(binder != nullptr);
261}
262ABpBinder::~ABpBinder() {}
263
Steven Moreland94968952018-09-05 14:42:59 -0700264sp<AIBinder> ABpBinder::lookupOrCreateFromBinder(const ::android::sp<::android::IBinder>& binder) {
Steven Moreland71cddc32018-08-30 23:39:22 -0700265 if (binder == nullptr) {
266 return nullptr;
267 }
268 if (ABBinderTag::has(binder)) {
269 return static_cast<ABBinder*>(binder.get());
270 }
Steven Moreland94968952018-09-05 14:42:59 -0700271
Steven Moreland91a96b62021-06-30 23:07:13 +0000272 // The following code ensures that for a given binder object (remote or local), if it is not an
273 // ABBinder then at most one ABpBinder object exists in a given process representing it.
274
Steven Moreland1f1bed62021-06-25 21:50:50 +0000275 auto* value = static_cast<ABpBinderTag::Value*>(binder->findObject(ABpBinderTag::kId));
Steven Moreland94968952018-09-05 14:42:59 -0700276 if (value == nullptr) {
277 value = new ABpBinderTag::Value;
Steven Moreland1f1bed62021-06-25 21:50:50 +0000278 auto oldValue = static_cast<ABpBinderTag::Value*>(
279 binder->attachObject(ABpBinderTag::kId, static_cast<void*>(value),
280 nullptr /*cookie*/, ABpBinderTag::clean));
281
282 // allocated by another thread
283 if (oldValue) {
284 delete value;
285 value = oldValue;
286 }
Steven Moreland94968952018-09-05 14:42:59 -0700287 }
288
Steven Moreland1f1bed62021-06-25 21:50:50 +0000289 sp<ABpBinder> ret;
290 binder->withLock([&]() {
291 ret = value->binder.promote();
292 if (ret == nullptr) {
293 ret = sp<ABpBinder>::make(binder);
294 value->binder = ret;
295 }
296 });
Steven Moreland94968952018-09-05 14:42:59 -0700297
298 return ret;
Steven Moreland71cddc32018-08-30 23:39:22 -0700299}
300
Steven Moreland2e87adc2018-08-20 19:47:00 -0700301struct AIBinder_Weak {
302 wp<AIBinder> binder;
303};
304AIBinder_Weak* AIBinder_Weak_new(AIBinder* binder) {
Steven Moreland5ccb70f2018-09-04 16:30:21 -0700305 if (binder == nullptr) {
306 return nullptr;
307 }
308
Steven Moreland2e87adc2018-08-20 19:47:00 -0700309 return new AIBinder_Weak{wp<AIBinder>(binder)};
310}
Steven Moreland9b80e282018-09-19 13:57:23 -0700311void AIBinder_Weak_delete(AIBinder_Weak* weakBinder) {
312 delete weakBinder;
Steven Moreland2e87adc2018-08-20 19:47:00 -0700313}
314AIBinder* AIBinder_Weak_promote(AIBinder_Weak* weakBinder) {
Steven Moreland5ccb70f2018-09-04 16:30:21 -0700315 if (weakBinder == nullptr) {
316 return nullptr;
317 }
318
Steven Moreland2e87adc2018-08-20 19:47:00 -0700319 sp<AIBinder> binder = weakBinder->binder.promote();
320 AIBinder_incStrong(binder.get());
321 return binder.get();
322}
323
Steven Morelandc70e0122021-01-08 02:44:53 +0000324AIBinder_Weak* AIBinder_Weak_clone(const AIBinder_Weak* weak) {
325 if (weak == nullptr) {
326 return nullptr;
327 }
328
329 return new AIBinder_Weak{weak->binder};
330}
331
332bool AIBinder_lt(const AIBinder* lhs, const AIBinder* rhs) {
333 if (lhs == nullptr || rhs == nullptr) return lhs < rhs;
334
335 return const_cast<AIBinder*>(lhs)->getBinder() < const_cast<AIBinder*>(rhs)->getBinder();
336}
337
338bool AIBinder_Weak_lt(const AIBinder_Weak* lhs, const AIBinder_Weak* rhs) {
339 if (lhs == nullptr || rhs == nullptr) return lhs < rhs;
340
341 return lhs->binder < rhs->binder;
342}
343
Steven Morelandfaf25a42022-12-21 02:21:36 +0000344// WARNING: When multiple classes exist with the same interface descriptor in different
345// linkernamespaces, the first one to be associated with mClazz becomes the canonical one
346// and the only requirement on this is that the interface descriptors match. If this
347// is an ABpBinder, no other state can be referenced from mClazz.
Steven Moreland2e87adc2018-08-20 19:47:00 -0700348AIBinder_Class::AIBinder_Class(const char* interfaceDescriptor, AIBinder_Class_onCreate onCreate,
349 AIBinder_Class_onDestroy onDestroy,
350 AIBinder_Class_onTransact onTransact)
Steven Moreland6cf66ac2018-11-02 18:14:54 -0700351 : onCreate(onCreate),
352 onDestroy(onDestroy),
353 onTransact(onTransact),
Stephen Crane8fde87f2020-11-17 15:06:11 -0800354 mInterfaceDescriptor(interfaceDescriptor),
355 mWideInterfaceDescriptor(interfaceDescriptor) {}
Steven Moreland2e87adc2018-08-20 19:47:00 -0700356
357AIBinder_Class* AIBinder_Class_define(const char* interfaceDescriptor,
358 AIBinder_Class_onCreate onCreate,
359 AIBinder_Class_onDestroy onDestroy,
360 AIBinder_Class_onTransact onTransact) {
361 if (interfaceDescriptor == nullptr || onCreate == nullptr || onDestroy == nullptr ||
362 onTransact == nullptr) {
363 return nullptr;
364 }
365
366 return new AIBinder_Class(interfaceDescriptor, onCreate, onDestroy, onTransact);
367}
368
Steven Morelanda194c452019-03-04 16:47:07 -0800369void AIBinder_Class_setOnDump(AIBinder_Class* clazz, AIBinder_onDump onDump) {
370 CHECK(clazz != nullptr) << "setOnDump requires non-null clazz";
371
372 // this is required to be called before instances are instantiated
373 clazz->onDump = onDump;
374}
375
Steven Morelandf3ed8062021-08-27 14:31:14 -0700376void AIBinder_Class_disableInterfaceTokenHeader(AIBinder_Class* clazz) {
377 CHECK(clazz != nullptr) << "disableInterfaceTokenHeader requires non-null clazz";
378
379 clazz->writeHeader = false;
380}
381
Ruchir Rastogicc7a7462020-01-31 14:29:15 -0800382void AIBinder_Class_setHandleShellCommand(AIBinder_Class* clazz,
383 AIBinder_handleShellCommand handleShellCommand) {
384 CHECK(clazz != nullptr) << "setHandleShellCommand requires non-null clazz";
385
386 clazz->handleShellCommand = handleShellCommand;
387}
388
Stephen Crane8fde87f2020-11-17 15:06:11 -0800389const char* AIBinder_Class_getDescriptor(const AIBinder_Class* clazz) {
390 CHECK(clazz != nullptr) << "getDescriptor requires non-null clazz";
391
392 return clazz->getInterfaceDescriptorUtf8();
393}
394
Alice Ryhlea9d9d22021-08-27 07:51:30 +0000395AIBinder_DeathRecipient::TransferDeathRecipient::~TransferDeathRecipient() {
396 if (mOnUnlinked != nullptr) {
397 mOnUnlinked(mCookie);
398 }
399}
400
Steven Moreland901c7452018-09-04 16:17:28 -0700401void AIBinder_DeathRecipient::TransferDeathRecipient::binderDied(const wp<IBinder>& who) {
Steven Moreland8bcb5032021-04-07 23:06:43 +0000402 CHECK(who == mWho) << who.unsafe_get() << "(" << who.get_refs() << ") vs " << mWho.unsafe_get()
403 << " (" << mWho.get_refs() << ")";
Steven Moreland901c7452018-09-04 16:17:28 -0700404
405 mOnDied(mCookie);
Steven Moreland64127ca2019-03-13 09:25:44 -0700406
407 sp<AIBinder_DeathRecipient> recipient = mParentRecipient.promote();
408 sp<IBinder> strongWho = who.promote();
409
410 // otherwise this will be cleaned up later with pruneDeadTransferEntriesLocked
411 if (recipient != nullptr && strongWho != nullptr) {
412 status_t result = recipient->unlinkToDeath(strongWho, mCookie);
413 if (result != ::android::DEAD_OBJECT) {
414 LOG(WARNING) << "Unlinking to dead binder resulted in: " << result;
415 }
416 }
417
Steven Moreland901c7452018-09-04 16:17:28 -0700418 mWho = nullptr;
419}
420
421AIBinder_DeathRecipient::AIBinder_DeathRecipient(AIBinder_DeathRecipient_onBinderDied onDied)
Alice Ryhlea9d9d22021-08-27 07:51:30 +0000422 : mOnDied(onDied), mOnUnlinked(nullptr) {
Steven Moreland901c7452018-09-04 16:17:28 -0700423 CHECK(onDied != nullptr);
424}
425
Steven Moreland64127ca2019-03-13 09:25:44 -0700426void AIBinder_DeathRecipient::pruneDeadTransferEntriesLocked() {
427 mDeathRecipients.erase(std::remove_if(mDeathRecipients.begin(), mDeathRecipients.end(),
428 [](const sp<TransferDeathRecipient>& tdr) {
429 return tdr->getWho() == nullptr;
430 }),
431 mDeathRecipients.end());
432}
433
Jiyong Park4f97a8c2020-11-16 18:11:14 +0900434binder_status_t AIBinder_DeathRecipient::linkToDeath(const sp<IBinder>& binder, void* cookie) {
Steven Moreland901c7452018-09-04 16:17:28 -0700435 CHECK(binder != nullptr);
436
437 std::lock_guard<std::mutex> l(mDeathRecipientsMutex);
438
439 sp<TransferDeathRecipient> recipient =
Alice Ryhlea9d9d22021-08-27 07:51:30 +0000440 new TransferDeathRecipient(binder, cookie, this, mOnDied, mOnUnlinked);
Steven Moreland901c7452018-09-04 16:17:28 -0700441
Steven Moreland64127ca2019-03-13 09:25:44 -0700442 status_t status = binder->linkToDeath(recipient, cookie, 0 /*flags*/);
Steven Moreland5d62e442018-09-13 15:01:02 -0700443 if (status != STATUS_OK) {
Alice Ryhlea9d9d22021-08-27 07:51:30 +0000444 // When we failed to link, the destructor of TransferDeathRecipient runs here, which
445 // ensures that mOnUnlinked is called before we return with an error from this method.
Steven Moreland5d62e442018-09-13 15:01:02 -0700446 return PruneStatusT(status);
Steven Moreland901c7452018-09-04 16:17:28 -0700447 }
448
449 mDeathRecipients.push_back(recipient);
Steven Moreland64127ca2019-03-13 09:25:44 -0700450
451 pruneDeadTransferEntriesLocked();
Steven Moreland5d62e442018-09-13 15:01:02 -0700452 return STATUS_OK;
Steven Moreland901c7452018-09-04 16:17:28 -0700453}
454
Jiyong Park4f97a8c2020-11-16 18:11:14 +0900455binder_status_t AIBinder_DeathRecipient::unlinkToDeath(const sp<IBinder>& binder, void* cookie) {
Steven Moreland901c7452018-09-04 16:17:28 -0700456 CHECK(binder != nullptr);
457
458 std::lock_guard<std::mutex> l(mDeathRecipientsMutex);
459
460 for (auto it = mDeathRecipients.rbegin(); it != mDeathRecipients.rend(); ++it) {
461 sp<TransferDeathRecipient> recipient = *it;
462
Steven Moreland64127ca2019-03-13 09:25:44 -0700463 if (recipient->getCookie() == cookie && recipient->getWho() == binder) {
Steven Moreland901c7452018-09-04 16:17:28 -0700464 mDeathRecipients.erase(it.base() - 1);
465
Steven Moreland64127ca2019-03-13 09:25:44 -0700466 status_t status = binder->unlinkToDeath(recipient, cookie, 0 /*flags*/);
Steven Moreland5d62e442018-09-13 15:01:02 -0700467 if (status != ::android::OK) {
Steven Moreland901c7452018-09-04 16:17:28 -0700468 LOG(ERROR) << __func__
Steven Moreland009fc1a2022-06-10 17:24:25 +0000469 << ": removed reference to death recipient but unlink failed: "
470 << statusToString(status);
Steven Moreland901c7452018-09-04 16:17:28 -0700471 }
Steven Moreland5d62e442018-09-13 15:01:02 -0700472 return PruneStatusT(status);
Steven Moreland901c7452018-09-04 16:17:28 -0700473 }
474 }
475
Steven Moreland5d62e442018-09-13 15:01:02 -0700476 return STATUS_NAME_NOT_FOUND;
Steven Moreland901c7452018-09-04 16:17:28 -0700477}
478
Alice Ryhlea9d9d22021-08-27 07:51:30 +0000479void AIBinder_DeathRecipient::setOnUnlinked(AIBinder_DeathRecipient_onBinderUnlinked onUnlinked) {
480 mOnUnlinked = onUnlinked;
481}
482
Steven Moreland901c7452018-09-04 16:17:28 -0700483// start of C-API methods
484
Steven Moreland2e87adc2018-08-20 19:47:00 -0700485AIBinder* AIBinder_new(const AIBinder_Class* clazz, void* args) {
486 if (clazz == nullptr) {
487 LOG(ERROR) << __func__ << ": Must provide class to construct local binder.";
488 return nullptr;
489 }
490
491 void* userData = clazz->onCreate(args);
492
Steven Moreland71cddc32018-08-30 23:39:22 -0700493 sp<AIBinder> ret = new ABBinder(clazz, userData);
494 ABBinderTag::attach(ret->getBinder());
495
496 AIBinder_incStrong(ret.get());
497 return ret.get();
Steven Moreland2e87adc2018-08-20 19:47:00 -0700498}
499
Steven Moreland5ea54da2018-09-04 13:29:55 -0700500bool AIBinder_isRemote(const AIBinder* binder) {
Steven Moreland2e87adc2018-08-20 19:47:00 -0700501 if (binder == nullptr) {
Steven Moreland56f752a2018-11-05 17:23:37 -0800502 return false;
Steven Moreland2e87adc2018-08-20 19:47:00 -0700503 }
504
505 return binder->isRemote();
506}
507
Steven Moreland65867d72018-09-04 14:22:26 -0700508bool AIBinder_isAlive(const AIBinder* binder) {
509 if (binder == nullptr) {
510 return false;
511 }
512
513 return const_cast<AIBinder*>(binder)->getBinder()->isBinderAlive();
514}
515
516binder_status_t AIBinder_ping(AIBinder* binder) {
517 if (binder == nullptr) {
Steven Moreland5d62e442018-09-13 15:01:02 -0700518 return STATUS_UNEXPECTED_NULL;
Steven Moreland65867d72018-09-04 14:22:26 -0700519 }
520
Steven Moreland5d62e442018-09-13 15:01:02 -0700521 return PruneStatusT(binder->getBinder()->pingBinder());
Steven Moreland65867d72018-09-04 14:22:26 -0700522}
523
Steven Morelanda194c452019-03-04 16:47:07 -0800524binder_status_t AIBinder_dump(AIBinder* binder, int fd, const char** args, uint32_t numArgs) {
525 if (binder == nullptr) {
526 return STATUS_UNEXPECTED_NULL;
527 }
528
529 ABBinder* bBinder = binder->asABBinder();
530 if (bBinder != nullptr) {
531 AIBinder_onDump onDump = binder->getClass()->onDump;
532 if (onDump == nullptr) {
533 return STATUS_OK;
534 }
535 return PruneStatusT(onDump(bBinder, fd, args, numArgs));
536 }
537
538 ::android::Vector<String16> utf16Args;
539 utf16Args.setCapacity(numArgs);
540 for (uint32_t i = 0; i < numArgs; i++) {
541 utf16Args.push(String16(String8(args[i])));
542 }
543
544 status_t status = binder->getBinder()->dump(fd, utf16Args);
545 return PruneStatusT(status);
546}
547
Steven Moreland901c7452018-09-04 16:17:28 -0700548binder_status_t AIBinder_linkToDeath(AIBinder* binder, AIBinder_DeathRecipient* recipient,
549 void* cookie) {
550 if (binder == nullptr || recipient == nullptr) {
Steven Moreland009fc1a2022-06-10 17:24:25 +0000551 LOG(ERROR) << __func__ << ": Must provide binder (" << binder << ") and recipient ("
552 << recipient << ")";
Steven Moreland5d62e442018-09-13 15:01:02 -0700553 return STATUS_UNEXPECTED_NULL;
Steven Moreland901c7452018-09-04 16:17:28 -0700554 }
555
Steven Moreland5d62e442018-09-13 15:01:02 -0700556 // returns binder_status_t
Steven Moreland64127ca2019-03-13 09:25:44 -0700557 return recipient->linkToDeath(binder->getBinder(), cookie);
Steven Moreland901c7452018-09-04 16:17:28 -0700558}
559
560binder_status_t AIBinder_unlinkToDeath(AIBinder* binder, AIBinder_DeathRecipient* recipient,
561 void* cookie) {
562 if (binder == nullptr || recipient == nullptr) {
Steven Moreland009fc1a2022-06-10 17:24:25 +0000563 LOG(ERROR) << __func__ << ": Must provide binder (" << binder << ") and recipient ("
564 << recipient << ")";
Steven Moreland5d62e442018-09-13 15:01:02 -0700565 return STATUS_UNEXPECTED_NULL;
Steven Moreland901c7452018-09-04 16:17:28 -0700566 }
567
Steven Moreland5d62e442018-09-13 15:01:02 -0700568 // returns binder_status_t
Steven Moreland64127ca2019-03-13 09:25:44 -0700569 return recipient->unlinkToDeath(binder->getBinder(), cookie);
Steven Moreland901c7452018-09-04 16:17:28 -0700570}
571
Steven Morelandf3034b02018-11-12 17:37:46 -0800572uid_t AIBinder_getCallingUid() {
573 return ::android::IPCThreadState::self()->getCallingUid();
574}
575
576pid_t AIBinder_getCallingPid() {
577 return ::android::IPCThreadState::self()->getCallingPid();
578}
579
Alice Ryhl59aeae82021-08-25 10:21:26 +0000580bool AIBinder_isHandlingTransaction() {
581 return ::android::IPCThreadState::self()->getServingStackPointer() != nullptr;
582}
583
Steven Moreland2e87adc2018-08-20 19:47:00 -0700584void AIBinder_incStrong(AIBinder* binder) {
585 if (binder == nullptr) {
Steven Moreland2e87adc2018-08-20 19:47:00 -0700586 return;
587 }
588
589 binder->incStrong(nullptr);
590}
591void AIBinder_decStrong(AIBinder* binder) {
592 if (binder == nullptr) {
593 LOG(ERROR) << __func__ << ": on null binder";
594 return;
595 }
596
597 binder->decStrong(nullptr);
598}
599int32_t AIBinder_debugGetRefCount(AIBinder* binder) {
600 if (binder == nullptr) {
601 LOG(ERROR) << __func__ << ": on null binder";
602 return -1;
603 }
604
605 return binder->getStrongCount();
606}
607
Steven Moreland71cddc32018-08-30 23:39:22 -0700608bool AIBinder_associateClass(AIBinder* binder, const AIBinder_Class* clazz) {
609 if (binder == nullptr) {
610 return false;
Steven Moreland2e87adc2018-08-20 19:47:00 -0700611 }
612
Steven Moreland71cddc32018-08-30 23:39:22 -0700613 return binder->associateClass(clazz);
Steven Moreland2e87adc2018-08-20 19:47:00 -0700614}
615
616const AIBinder_Class* AIBinder_getClass(AIBinder* binder) {
617 if (binder == nullptr) {
618 return nullptr;
619 }
620
621 return binder->getClass();
622}
623
624void* AIBinder_getUserData(AIBinder* binder) {
625 if (binder == nullptr) {
626 return nullptr;
627 }
628
629 ABBinder* bBinder = binder->asABBinder();
630 if (bBinder == nullptr) {
631 return nullptr;
632 }
633
634 return bBinder->getUserData();
635}
636
637binder_status_t AIBinder_prepareTransaction(AIBinder* binder, AParcel** in) {
638 if (binder == nullptr || in == nullptr) {
Steven Moreland009fc1a2022-06-10 17:24:25 +0000639 LOG(ERROR) << __func__ << ": requires non-null parameters binder (" << binder
640 << ") and in (" << in << ").";
Steven Moreland5d62e442018-09-13 15:01:02 -0700641 return STATUS_UNEXPECTED_NULL;
Steven Moreland2e87adc2018-08-20 19:47:00 -0700642 }
643 const AIBinder_Class* clazz = binder->getClass();
644 if (clazz == nullptr) {
645 LOG(ERROR) << __func__
646 << ": Class must be defined for a remote binder transaction. See "
647 "AIBinder_associateClass.";
Steven Moreland5d62e442018-09-13 15:01:02 -0700648 return STATUS_INVALID_OPERATION;
Steven Moreland2e87adc2018-08-20 19:47:00 -0700649 }
650
651 *in = new AParcel(binder);
Steven Moreland1fda67b2021-04-02 18:35:50 +0000652 (*in)->get()->markForBinder(binder->getBinder());
653
Steven Morelandf3ed8062021-08-27 14:31:14 -0700654 status_t status = android::OK;
Steven Morelandfaf25a42022-12-21 02:21:36 +0000655
656 // note - this is the only read of a value in clazz, and it comes with a warning
657 // on the API itself. Do not copy this design. Instead, attach data in a new
658 // version of the prepareTransaction function.
Steven Morelandf3ed8062021-08-27 14:31:14 -0700659 if (clazz->writeHeader) {
660 status = (*in)->get()->writeInterfaceToken(clazz->getInterfaceDescriptor());
661 }
Steven Moreland5d62e442018-09-13 15:01:02 -0700662 binder_status_t ret = PruneStatusT(status);
663
664 if (ret != STATUS_OK) {
Steven Moreland2e87adc2018-08-20 19:47:00 -0700665 delete *in;
666 *in = nullptr;
667 }
668
Steven Moreland5d62e442018-09-13 15:01:02 -0700669 return ret;
Steven Moreland2e87adc2018-08-20 19:47:00 -0700670}
671
Steven Moreland9b80e282018-09-19 13:57:23 -0700672static void DestroyParcel(AParcel** parcel) {
673 delete *parcel;
674 *parcel = nullptr;
675}
676
Steven Moreland2e87adc2018-08-20 19:47:00 -0700677binder_status_t AIBinder_transact(AIBinder* binder, transaction_code_t code, AParcel** in,
678 AParcel** out, binder_flags_t flags) {
679 if (in == nullptr) {
680 LOG(ERROR) << __func__ << ": requires non-null in parameter";
Steven Moreland5d62e442018-09-13 15:01:02 -0700681 return STATUS_UNEXPECTED_NULL;
Steven Moreland2e87adc2018-08-20 19:47:00 -0700682 }
683
Steven Morelandcaa776c2018-09-04 13:48:11 -0700684 using AutoParcelDestroyer = std::unique_ptr<AParcel*, void (*)(AParcel**)>;
Steven Moreland2e87adc2018-08-20 19:47:00 -0700685 // This object is the input to the transaction. This function takes ownership of it and deletes
686 // it.
Steven Moreland9b80e282018-09-19 13:57:23 -0700687 AutoParcelDestroyer forIn(in, DestroyParcel);
Steven Moreland2e87adc2018-08-20 19:47:00 -0700688
689 if (!isUserCommand(code)) {
Steven Moreland009fc1a2022-06-10 17:24:25 +0000690 LOG(ERROR) << __func__
691 << ": Only user-defined transactions can be made from the NDK, but requested: "
692 << code;
Steven Moreland5d62e442018-09-13 15:01:02 -0700693 return STATUS_UNKNOWN_TRANSACTION;
Steven Moreland2e87adc2018-08-20 19:47:00 -0700694 }
695
Steven Morelandf183fdd2020-10-27 00:12:12 +0000696 constexpr binder_flags_t kAllFlags = FLAG_PRIVATE_VENDOR | FLAG_ONEWAY | FLAG_CLEAR_BUF;
Steven Moreland46b5fea2019-10-15 11:22:18 -0700697 if ((flags & ~kAllFlags) != 0) {
Steven Moreland2e87adc2018-08-20 19:47:00 -0700698 LOG(ERROR) << __func__ << ": Unrecognized flags sent: " << flags;
Steven Moreland5d62e442018-09-13 15:01:02 -0700699 return STATUS_BAD_VALUE;
Steven Moreland2e87adc2018-08-20 19:47:00 -0700700 }
701
702 if (binder == nullptr || *in == nullptr || out == nullptr) {
Steven Moreland009fc1a2022-06-10 17:24:25 +0000703 LOG(ERROR) << __func__ << ": requires non-null parameters binder (" << binder << "), in ("
704 << in << "), and out (" << out << ").";
Steven Moreland5d62e442018-09-13 15:01:02 -0700705 return STATUS_UNEXPECTED_NULL;
Steven Moreland2e87adc2018-08-20 19:47:00 -0700706 }
707
708 if ((*in)->getBinder() != binder) {
709 LOG(ERROR) << __func__ << ": parcel is associated with binder object " << binder
710 << " but called with " << (*in)->getBinder();
Steven Moreland5d62e442018-09-13 15:01:02 -0700711 return STATUS_BAD_VALUE;
Steven Moreland2e87adc2018-08-20 19:47:00 -0700712 }
713
714 *out = new AParcel(binder);
715
Steven Morelandf18615b2018-09-14 11:43:06 -0700716 status_t status = binder->getBinder()->transact(code, *(*in)->get(), (*out)->get(), flags);
Steven Moreland5d62e442018-09-13 15:01:02 -0700717 binder_status_t ret = PruneStatusT(status);
Steven Moreland2e87adc2018-08-20 19:47:00 -0700718
Steven Moreland5d62e442018-09-13 15:01:02 -0700719 if (ret != STATUS_OK) {
Steven Moreland2e87adc2018-08-20 19:47:00 -0700720 delete *out;
721 *out = nullptr;
722 }
723
Steven Moreland5d62e442018-09-13 15:01:02 -0700724 return ret;
Steven Moreland2e87adc2018-08-20 19:47:00 -0700725}
Steven Moreland901c7452018-09-04 16:17:28 -0700726
727AIBinder_DeathRecipient* AIBinder_DeathRecipient_new(
728 AIBinder_DeathRecipient_onBinderDied onBinderDied) {
729 if (onBinderDied == nullptr) {
730 LOG(ERROR) << __func__ << ": requires non-null onBinderDied parameter.";
731 return nullptr;
732 }
Steven Moreland64127ca2019-03-13 09:25:44 -0700733 auto ret = new AIBinder_DeathRecipient(onBinderDied);
734 ret->incStrong(nullptr);
735 return ret;
Steven Moreland901c7452018-09-04 16:17:28 -0700736}
737
Alice Ryhlea9d9d22021-08-27 07:51:30 +0000738void AIBinder_DeathRecipient_setOnUnlinked(AIBinder_DeathRecipient* recipient,
739 AIBinder_DeathRecipient_onBinderUnlinked onUnlinked) {
740 if (recipient == nullptr) {
741 return;
742 }
743
744 recipient->setOnUnlinked(onUnlinked);
745}
746
Steven Moreland9b80e282018-09-19 13:57:23 -0700747void AIBinder_DeathRecipient_delete(AIBinder_DeathRecipient* recipient) {
Steven Moreland64127ca2019-03-13 09:25:44 -0700748 if (recipient == nullptr) {
749 return;
750 }
751
752 recipient->decStrong(nullptr);
Steven Moreland901c7452018-09-04 16:17:28 -0700753}
Steven Morelandea14ef22019-08-20 10:50:08 -0700754
755binder_status_t AIBinder_getExtension(AIBinder* binder, AIBinder** outExt) {
756 if (binder == nullptr || outExt == nullptr) {
757 if (outExt != nullptr) {
758 *outExt = nullptr;
759 }
760 return STATUS_UNEXPECTED_NULL;
761 }
762
763 sp<IBinder> ext;
764 status_t res = binder->getBinder()->getExtension(&ext);
765
766 if (res != android::OK) {
767 *outExt = nullptr;
768 return PruneStatusT(res);
769 }
770
771 sp<AIBinder> ret = ABpBinder::lookupOrCreateFromBinder(ext);
772 if (ret != nullptr) ret->incStrong(binder);
773
774 *outExt = ret.get();
775 return STATUS_OK;
776}
777
778binder_status_t AIBinder_setExtension(AIBinder* binder, AIBinder* ext) {
779 if (binder == nullptr || ext == nullptr) {
780 return STATUS_UNEXPECTED_NULL;
781 }
782
783 ABBinder* rawBinder = binder->asABBinder();
784 if (rawBinder == nullptr) {
785 return STATUS_INVALID_OPERATION;
786 }
787
788 rawBinder->setExtension(ext->getBinder());
789 return STATUS_OK;
790}
Steven Moreland2f405f52020-07-08 22:24:29 +0000791
792// platform methods follow
793
794void AIBinder_setRequestingSid(AIBinder* binder, bool requestingSid) {
795 ABBinder* localBinder = binder->asABBinder();
796 if (localBinder == nullptr) {
797 LOG(FATAL) << "AIBinder_setRequestingSid must be called on a local binder";
798 }
799
800 localBinder->setRequestingSid(requestingSid);
801}
802
803const char* AIBinder_getCallingSid() {
804 return ::android::IPCThreadState::self()->getCallingSid();
805}
Steven Morelandb2de9532020-05-29 21:44:41 +0000806
Ady Abraham96174ac2021-10-15 11:02:03 -0700807void AIBinder_setMinSchedulerPolicy(AIBinder* binder, int policy, int priority) {
808 binder->asABBinder()->setMinSchedulerPolicy(policy, priority);
809}
Steven Moreland454a26a2021-12-14 01:26:21 +0000810
811void AIBinder_setInheritRt(AIBinder* binder, bool inheritRt) {
812 ABBinder* localBinder = binder->asABBinder();
813 if (localBinder == nullptr) {
814 LOG(FATAL) << "AIBinder_setInheritRt must be called on a local binder";
815 }
816
817 localBinder->setInheritRt(inheritRt);
818}