Steven Moreland | 2e87adc | 2018-08-20 19:47:00 -0700 | [diff] [blame] | 1 | /* |
| 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 | |
| 17 | #pragma once |
| 18 | |
| 19 | #include <android/binder_ibinder.h> |
Ruchir Rastogi | cc7a746 | 2020-01-31 14:29:15 -0800 | [diff] [blame] | 20 | #include <android/binder_shell.h> |
Steven Moreland | 4d5ad49 | 2018-09-13 12:49:16 -0700 | [diff] [blame] | 21 | #include "ibinder_internal.h" |
Steven Moreland | 2e87adc | 2018-08-20 19:47:00 -0700 | [diff] [blame] | 22 | |
| 23 | #include <atomic> |
Steven Moreland | 901c745 | 2018-09-04 16:17:28 -0700 | [diff] [blame] | 24 | #include <mutex> |
| 25 | #include <vector> |
Steven Moreland | 2e87adc | 2018-08-20 19:47:00 -0700 | [diff] [blame] | 26 | |
| 27 | #include <binder/Binder.h> |
| 28 | #include <binder/IBinder.h> |
Steven Moreland | a194c45 | 2019-03-04 16:47:07 -0800 | [diff] [blame] | 29 | #include <utils/Vector.h> |
Steven Moreland | 2e87adc | 2018-08-20 19:47:00 -0700 | [diff] [blame] | 30 | |
| 31 | inline bool isUserCommand(transaction_code_t code) { |
| 32 | return code >= FIRST_CALL_TRANSACTION && code <= LAST_CALL_TRANSACTION; |
| 33 | } |
| 34 | |
| 35 | struct ABBinder; |
| 36 | struct ABpBinder; |
| 37 | |
| 38 | struct AIBinder : public virtual ::android::RefBase { |
Chih-Hung Hsieh | 5ca1ea4 | 2018-12-20 15:42:22 -0800 | [diff] [blame] | 39 | explicit AIBinder(const AIBinder_Class* clazz); |
Steven Moreland | 2e87adc | 2018-08-20 19:47:00 -0700 | [diff] [blame] | 40 | virtual ~AIBinder(); |
| 41 | |
Steven Moreland | 71cddc3 | 2018-08-30 23:39:22 -0700 | [diff] [blame] | 42 | bool associateClass(const AIBinder_Class* clazz); |
Steven Moreland | 2e87adc | 2018-08-20 19:47:00 -0700 | [diff] [blame] | 43 | const AIBinder_Class* getClass() const { return mClazz; } |
| 44 | |
Steven Moreland | 2e87adc | 2018-08-20 19:47:00 -0700 | [diff] [blame] | 45 | virtual ::android::sp<::android::IBinder> getBinder() = 0; |
| 46 | virtual ABBinder* asABBinder() { return nullptr; } |
| 47 | virtual ABpBinder* asABpBinder() { return nullptr; } |
| 48 | |
Steven Moreland | 5ea54da | 2018-09-04 13:29:55 -0700 | [diff] [blame] | 49 | bool isRemote() const { |
| 50 | ::android::sp<::android::IBinder> binder = const_cast<AIBinder*>(this)->getBinder(); |
| 51 | return binder->remoteBinder() != nullptr; |
| 52 | } |
Steven Moreland | 2e87adc | 2018-08-20 19:47:00 -0700 | [diff] [blame] | 53 | |
Steven Moreland | 6cf66ac | 2018-11-02 18:14:54 -0700 | [diff] [blame] | 54 | private: |
Steven Moreland | 2e87adc | 2018-08-20 19:47:00 -0700 | [diff] [blame] | 55 | // AIBinder instance is instance of this class for a local object. In order to transact on a |
| 56 | // remote object, this also must be set for simplicity (although right now, only the |
| 57 | // interfaceDescriptor from it is used). |
| 58 | const AIBinder_Class* mClazz; |
| 59 | }; |
| 60 | |
| 61 | // This is a local AIBinder object with a known class. |
| 62 | struct ABBinder : public AIBinder, public ::android::BBinder { |
Steven Moreland | 2e87adc | 2018-08-20 19:47:00 -0700 | [diff] [blame] | 63 | virtual ~ABBinder(); |
| 64 | |
| 65 | void* getUserData() { return mUserData; } |
| 66 | |
| 67 | ::android::sp<::android::IBinder> getBinder() override { return this; } |
| 68 | ABBinder* asABBinder() override { return this; } |
| 69 | |
| 70 | const ::android::String16& getInterfaceDescriptor() const override; |
Steven Moreland | a194c45 | 2019-03-04 16:47:07 -0800 | [diff] [blame] | 71 | ::android::status_t dump(int fd, const ::android::Vector<::android::String16>& args) override; |
Steven Moreland | 5d62e44 | 2018-09-13 15:01:02 -0700 | [diff] [blame] | 72 | ::android::status_t onTransact(uint32_t code, const ::android::Parcel& data, |
| 73 | ::android::Parcel* reply, binder_flags_t flags) override; |
Steven Moreland | 2e87adc | 2018-08-20 19:47:00 -0700 | [diff] [blame] | 74 | |
Steven Moreland | 6cf66ac | 2018-11-02 18:14:54 -0700 | [diff] [blame] | 75 | private: |
Steven Moreland | 71cddc3 | 2018-08-30 23:39:22 -0700 | [diff] [blame] | 76 | ABBinder(const AIBinder_Class* clazz, void* userData); |
| 77 | |
| 78 | // only thing that should create an ABBinder |
| 79 | friend AIBinder* AIBinder_new(const AIBinder_Class*, void*); |
| 80 | |
Steven Moreland | 2e87adc | 2018-08-20 19:47:00 -0700 | [diff] [blame] | 81 | // Can contain implementation if this is a local binder. This can still be nullptr for a local |
| 82 | // binder. If it is nullptr, the implication is the implementation state is entirely external to |
| 83 | // this object and the functionality provided in the AIBinder_Class is sufficient. |
| 84 | void* mUserData; |
| 85 | }; |
| 86 | |
Steven Moreland | 9496895 | 2018-09-05 14:42:59 -0700 | [diff] [blame] | 87 | // This binder object may be remote or local (even though it is 'Bp'). The implication if it is |
| 88 | // local is that it is an IBinder object created outside of the domain of libbinder_ndk. |
Steven Moreland | 2e87adc | 2018-08-20 19:47:00 -0700 | [diff] [blame] | 89 | struct ABpBinder : public AIBinder, public ::android::BpRefBase { |
Steven Moreland | 9496895 | 2018-09-05 14:42:59 -0700 | [diff] [blame] | 90 | // Looks up to see if this object has or is an existing ABBinder or ABpBinder object, otherwise |
| 91 | // it creates an ABpBinder object. |
| 92 | static ::android::sp<AIBinder> lookupOrCreateFromBinder( |
| 93 | const ::android::sp<::android::IBinder>& binder); |
Steven Moreland | 71cddc3 | 2018-08-30 23:39:22 -0700 | [diff] [blame] | 94 | |
Steven Moreland | 2e87adc | 2018-08-20 19:47:00 -0700 | [diff] [blame] | 95 | virtual ~ABpBinder(); |
| 96 | |
Steven Moreland | 9496895 | 2018-09-05 14:42:59 -0700 | [diff] [blame] | 97 | void onLastStrongRef(const void* id) override; |
| 98 | |
Steven Moreland | 2e87adc | 2018-08-20 19:47:00 -0700 | [diff] [blame] | 99 | ::android::sp<::android::IBinder> getBinder() override { return remote(); } |
| 100 | ABpBinder* asABpBinder() override { return this; } |
Steven Moreland | 71cddc3 | 2018-08-30 23:39:22 -0700 | [diff] [blame] | 101 | |
Steven Moreland | 6cf66ac | 2018-11-02 18:14:54 -0700 | [diff] [blame] | 102 | private: |
Chih-Hung Hsieh | 5ca1ea4 | 2018-12-20 15:42:22 -0800 | [diff] [blame] | 103 | explicit ABpBinder(const ::android::sp<::android::IBinder>& binder); |
Steven Moreland | 2e87adc | 2018-08-20 19:47:00 -0700 | [diff] [blame] | 104 | }; |
| 105 | |
| 106 | struct AIBinder_Class { |
| 107 | AIBinder_Class(const char* interfaceDescriptor, AIBinder_Class_onCreate onCreate, |
| 108 | AIBinder_Class_onDestroy onDestroy, AIBinder_Class_onTransact onTransact); |
| 109 | |
| 110 | const ::android::String16& getInterfaceDescriptor() const { return mInterfaceDescriptor; } |
| 111 | |
Steven Moreland | a194c45 | 2019-03-04 16:47:07 -0800 | [diff] [blame] | 112 | // required to be non-null, implemented for every class |
Steven Moreland | 8823407 | 2020-08-06 19:32:45 +0000 | [diff] [blame^] | 113 | const AIBinder_Class_onCreate onCreate = nullptr; |
| 114 | const AIBinder_Class_onDestroy onDestroy = nullptr; |
| 115 | const AIBinder_Class_onTransact onTransact = nullptr; |
Steven Moreland | 2e87adc | 2018-08-20 19:47:00 -0700 | [diff] [blame] | 116 | |
Steven Moreland | a194c45 | 2019-03-04 16:47:07 -0800 | [diff] [blame] | 117 | // optional methods for a class |
Steven Moreland | 8823407 | 2020-08-06 19:32:45 +0000 | [diff] [blame^] | 118 | AIBinder_onDump onDump = nullptr; |
| 119 | AIBinder_handleShellCommand handleShellCommand = nullptr; |
Steven Moreland | a194c45 | 2019-03-04 16:47:07 -0800 | [diff] [blame] | 120 | |
Steven Moreland | 6cf66ac | 2018-11-02 18:14:54 -0700 | [diff] [blame] | 121 | private: |
Steven Moreland | 2e87adc | 2018-08-20 19:47:00 -0700 | [diff] [blame] | 122 | // This must be a String16 since BBinder virtual getInterfaceDescriptor returns a reference to |
| 123 | // one. |
| 124 | const ::android::String16 mInterfaceDescriptor; |
| 125 | }; |
Steven Moreland | 901c745 | 2018-09-04 16:17:28 -0700 | [diff] [blame] | 126 | |
| 127 | // Ownership is like this (when linked to death): |
| 128 | // |
| 129 | // AIBinder_DeathRecipient -sp-> TransferDeathRecipient <-wp-> IBinder |
| 130 | // |
| 131 | // When the AIBinder_DeathRecipient is dropped, so are the actual underlying death recipients. When |
| 132 | // the IBinder dies, only a wp to it is kept. |
Steven Moreland | 64127ca | 2019-03-13 09:25:44 -0700 | [diff] [blame] | 133 | struct AIBinder_DeathRecipient : ::android::RefBase { |
Steven Moreland | 901c745 | 2018-09-04 16:17:28 -0700 | [diff] [blame] | 134 | // One of these is created for every linkToDeath. This is to be able to recover data when a |
| 135 | // binderDied receipt only gives us information about the IBinder. |
| 136 | struct TransferDeathRecipient : ::android::IBinder::DeathRecipient { |
| 137 | TransferDeathRecipient(const ::android::wp<::android::IBinder>& who, void* cookie, |
Steven Moreland | 64127ca | 2019-03-13 09:25:44 -0700 | [diff] [blame] | 138 | const ::android::wp<AIBinder_DeathRecipient>& parentRecipient, |
Steven Moreland | e88055b | 2019-03-13 09:23:18 -0700 | [diff] [blame] | 139 | const AIBinder_DeathRecipient_onBinderDied onDied) |
Steven Moreland | 64127ca | 2019-03-13 09:25:44 -0700 | [diff] [blame] | 140 | : mWho(who), mCookie(cookie), mParentRecipient(parentRecipient), mOnDied(onDied) {} |
Steven Moreland | 901c745 | 2018-09-04 16:17:28 -0700 | [diff] [blame] | 141 | |
| 142 | void binderDied(const ::android::wp<::android::IBinder>& who) override; |
| 143 | |
| 144 | const ::android::wp<::android::IBinder>& getWho() { return mWho; } |
| 145 | void* getCookie() { return mCookie; } |
| 146 | |
Steven Moreland | 6cf66ac | 2018-11-02 18:14:54 -0700 | [diff] [blame] | 147 | private: |
Steven Moreland | 901c745 | 2018-09-04 16:17:28 -0700 | [diff] [blame] | 148 | ::android::wp<::android::IBinder> mWho; |
| 149 | void* mCookie; |
Steven Moreland | 64127ca | 2019-03-13 09:25:44 -0700 | [diff] [blame] | 150 | |
| 151 | ::android::wp<AIBinder_DeathRecipient> mParentRecipient; |
| 152 | |
| 153 | // This is kept separately from AIBinder_DeathRecipient in case the death recipient is |
| 154 | // deleted while the death notification is fired |
Steven Moreland | e88055b | 2019-03-13 09:23:18 -0700 | [diff] [blame] | 155 | const AIBinder_DeathRecipient_onBinderDied mOnDied; |
Steven Moreland | 901c745 | 2018-09-04 16:17:28 -0700 | [diff] [blame] | 156 | }; |
| 157 | |
Chih-Hung Hsieh | 5ca1ea4 | 2018-12-20 15:42:22 -0800 | [diff] [blame] | 158 | explicit AIBinder_DeathRecipient(AIBinder_DeathRecipient_onBinderDied onDied); |
Steven Moreland | 64127ca | 2019-03-13 09:25:44 -0700 | [diff] [blame] | 159 | binder_status_t linkToDeath(::android::sp<::android::IBinder>, void* cookie); |
| 160 | binder_status_t unlinkToDeath(::android::sp<::android::IBinder> binder, void* cookie); |
Steven Moreland | 901c745 | 2018-09-04 16:17:28 -0700 | [diff] [blame] | 161 | |
Steven Moreland | 6cf66ac | 2018-11-02 18:14:54 -0700 | [diff] [blame] | 162 | private: |
Steven Moreland | 64127ca | 2019-03-13 09:25:44 -0700 | [diff] [blame] | 163 | // When the user of this API deletes a Bp object but not the death recipient, the |
| 164 | // TransferDeathRecipient object can't be cleaned up. This is called whenever a new |
| 165 | // TransferDeathRecipient is linked, and it ensures that mDeathRecipients can't grow unbounded. |
| 166 | void pruneDeadTransferEntriesLocked(); |
| 167 | |
Steven Moreland | 901c745 | 2018-09-04 16:17:28 -0700 | [diff] [blame] | 168 | std::mutex mDeathRecipientsMutex; |
| 169 | std::vector<::android::sp<TransferDeathRecipient>> mDeathRecipients; |
| 170 | AIBinder_DeathRecipient_onBinderDied mOnDied; |
| 171 | }; |