Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2020 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | #pragma once |
| 17 | |
| 18 | #include <android-base/unique_fd.h> |
| 19 | #include <binder/IBinder.h> |
| 20 | #include <binder/Parcel.h> |
Steven Moreland | bdb53ab | 2021-05-05 17:57:41 +0000 | [diff] [blame] | 21 | #include <binder/RpcSession.h> |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 22 | |
| 23 | #include <map> |
Steven Moreland | e839334 | 2021-05-05 23:27:53 +0000 | [diff] [blame] | 24 | #include <optional> |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 25 | #include <queue> |
| 26 | |
| 27 | namespace android { |
| 28 | |
| 29 | struct RpcWireHeader; |
| 30 | |
| 31 | /** |
| 32 | * Log a lot more information about RPC calls, when debugging issues. Usually, |
| 33 | * you would want to enable this in only one process. If repeated issues require |
| 34 | * a specific subset of logs to debug, this could be broken up like |
| 35 | * IPCThreadState's. |
| 36 | */ |
| 37 | #define SHOULD_LOG_RPC_DETAIL false |
| 38 | |
| 39 | #if SHOULD_LOG_RPC_DETAIL |
| 40 | #define LOG_RPC_DETAIL(...) ALOGI(__VA_ARGS__) |
| 41 | #else |
| 42 | #define LOG_RPC_DETAIL(...) ALOGV(__VA_ARGS__) // for type checking |
| 43 | #endif |
| 44 | |
Steven Moreland | b817679 | 2021-06-22 20:29:21 +0000 | [diff] [blame] | 45 | #define RPC_FLAKE_PRONE false |
| 46 | |
Devin Moore | 0825643 | 2021-07-02 13:03:49 -0700 | [diff] [blame] | 47 | #if RPC_FLAKE_PRONE |
Steven Moreland | b817679 | 2021-06-22 20:29:21 +0000 | [diff] [blame] | 48 | void rpcMaybeWaitToFlake(); |
| 49 | #define MAYBE_WAIT_IN_FLAKE_MODE rpcMaybeWaitToFlake() |
| 50 | #else |
| 51 | #define MAYBE_WAIT_IN_FLAKE_MODE do {} while (false) |
| 52 | #endif |
| 53 | |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 54 | /** |
| 55 | * Abstracts away management of ref counts and the wire format from |
Steven Moreland | bdb53ab | 2021-05-05 17:57:41 +0000 | [diff] [blame] | 56 | * RpcSession |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 57 | */ |
| 58 | class RpcState { |
| 59 | public: |
| 60 | RpcState(); |
| 61 | ~RpcState(); |
| 62 | |
Steven Moreland | fc027e0 | 2021-10-25 15:31:31 -0700 | [diff] [blame] | 63 | [[nodiscard]] status_t readNewSessionResponse(const sp<RpcSession::RpcConnection>& connection, |
| 64 | const sp<RpcSession>& session, uint32_t* version); |
| 65 | [[nodiscard]] status_t sendConnectionInit(const sp<RpcSession::RpcConnection>& connection, |
| 66 | const sp<RpcSession>& session); |
| 67 | [[nodiscard]] status_t readConnectionInit(const sp<RpcSession::RpcConnection>& connection, |
| 68 | const sp<RpcSession>& session); |
Steven Moreland | c88b7fc | 2021-06-10 00:40:39 +0000 | [diff] [blame] | 69 | |
Steven Moreland | 7c5e6c2 | 2021-05-01 02:55:20 +0000 | [diff] [blame] | 70 | // TODO(b/182940634): combine some special transactions into one "getServerInfo" call? |
Steven Moreland | 5ae6256 | 2021-06-10 03:21:42 +0000 | [diff] [blame] | 71 | sp<IBinder> getRootObject(const sp<RpcSession::RpcConnection>& connection, |
| 72 | const sp<RpcSession>& session); |
Steven Moreland | fc027e0 | 2021-10-25 15:31:31 -0700 | [diff] [blame] | 73 | [[nodiscard]] status_t getMaxThreads(const sp<RpcSession::RpcConnection>& connection, |
| 74 | const sp<RpcSession>& session, size_t* maxThreadsOut); |
| 75 | [[nodiscard]] status_t getSessionId(const sp<RpcSession::RpcConnection>& connection, |
| 76 | const sp<RpcSession>& session, |
| 77 | std::vector<uint8_t>* sessionIdOut); |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 78 | |
Steven Moreland | 5ae6256 | 2021-06-10 03:21:42 +0000 | [diff] [blame] | 79 | [[nodiscard]] status_t transact(const sp<RpcSession::RpcConnection>& connection, |
| 80 | const sp<IBinder>& address, uint32_t code, const Parcel& data, |
Steven Moreland | bdb53ab | 2021-05-05 17:57:41 +0000 | [diff] [blame] | 81 | const sp<RpcSession>& session, Parcel* reply, uint32_t flags); |
Steven Moreland | 5ae6256 | 2021-06-10 03:21:42 +0000 | [diff] [blame] | 82 | [[nodiscard]] status_t transactAddress(const sp<RpcSession::RpcConnection>& connection, |
Steven Moreland | 5623d1a | 2021-09-10 15:45:34 -0700 | [diff] [blame] | 83 | uint64_t address, uint32_t code, const Parcel& data, |
| 84 | const sp<RpcSession>& session, Parcel* reply, |
| 85 | uint32_t flags); |
Steven Moreland | fd1e8a0 | 2021-07-21 23:30:29 +0000 | [diff] [blame] | 86 | |
| 87 | /** |
| 88 | * The ownership model here carries an implicit strong refcount whenever a |
| 89 | * binder is sent across processes. Since we have a local strong count in |
| 90 | * sp<> over these objects, we only ever need to keep one of these. So, |
| 91 | * typically we tell the remote process that we drop all the implicit dec |
| 92 | * strongs, and we hold onto the last one. 'target' here is the target |
| 93 | * timesRecd (the number of remaining reference counts) we wish to keep. |
| 94 | * Typically this should be '0' or '1'. The target is used instead of an |
| 95 | * explicit decrement count in order to allow multiple threads to lower the |
| 96 | * number of counts simultaneously. Since we only lower the count to 0 when |
| 97 | * a binder is deleted, targets of '1' should only be sent when the caller |
| 98 | * owns a local strong reference to the binder. Larger targets may be used |
| 99 | * for testing, and to make the function generic, but generally this should |
| 100 | * be avoided because it would be hard to guarantee another thread doesn't |
| 101 | * lower the number of held refcounts to '1'. Note also, these refcounts |
| 102 | * must be sent actively. If they are sent when binders are deleted, this |
| 103 | * can cause leaks, since even remote binders carry an implicit strong ref |
| 104 | * when they are sent to another process. |
| 105 | */ |
| 106 | [[nodiscard]] status_t sendDecStrongToTarget(const sp<RpcSession::RpcConnection>& connection, |
| 107 | const sp<RpcSession>& session, uint64_t address, |
| 108 | size_t target); |
Steven Moreland | 52eee94 | 2021-06-03 00:59:28 +0000 | [diff] [blame] | 109 | |
| 110 | enum class CommandType { |
| 111 | ANY, |
| 112 | CONTROL_ONLY, |
| 113 | }; |
Steven Moreland | 5ae6256 | 2021-06-10 03:21:42 +0000 | [diff] [blame] | 114 | [[nodiscard]] status_t getAndExecuteCommand(const sp<RpcSession::RpcConnection>& connection, |
Steven Moreland | 52eee94 | 2021-06-03 00:59:28 +0000 | [diff] [blame] | 115 | const sp<RpcSession>& session, CommandType type); |
Steven Moreland | 5ae6256 | 2021-06-10 03:21:42 +0000 | [diff] [blame] | 116 | [[nodiscard]] status_t drainCommands(const sp<RpcSession::RpcConnection>& connection, |
| 117 | const sp<RpcSession>& session, CommandType type); |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 118 | |
| 119 | /** |
| 120 | * Called by Parcel for outgoing binders. This implies one refcount of |
| 121 | * ownership to the outgoing binder. |
| 122 | */ |
Steven Moreland | bdb53ab | 2021-05-05 17:57:41 +0000 | [diff] [blame] | 123 | [[nodiscard]] status_t onBinderLeaving(const sp<RpcSession>& session, const sp<IBinder>& binder, |
Steven Moreland | 5623d1a | 2021-09-10 15:45:34 -0700 | [diff] [blame] | 124 | uint64_t* outAddress); |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 125 | |
| 126 | /** |
| 127 | * Called by Parcel for incoming binders. This either returns the refcount |
| 128 | * to the process, if this process already has one, or it takes ownership of |
| 129 | * that refcount |
| 130 | */ |
Steven Moreland | 5623d1a | 2021-09-10 15:45:34 -0700 | [diff] [blame] | 131 | [[nodiscard]] status_t onBinderEntering(const sp<RpcSession>& session, uint64_t address, |
| 132 | sp<IBinder>* out); |
Steven Moreland | d808331 | 2021-09-22 13:37:10 -0700 | [diff] [blame] | 133 | /** |
| 134 | * Called on incoming binders to update refcounting information. This should |
| 135 | * only be called when it is done as part of making progress on a |
| 136 | * transaction. |
| 137 | */ |
| 138 | [[nodiscard]] status_t flushExcessBinderRefs(const sp<RpcSession>& session, uint64_t address, |
| 139 | const sp<IBinder>& binder); |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 140 | |
| 141 | size_t countBinders(); |
| 142 | void dump(); |
| 143 | |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 144 | /** |
Steven Moreland | bdb53ab | 2021-05-05 17:57:41 +0000 | [diff] [blame] | 145 | * Called when reading or writing data to a session fails to clean up |
| 146 | * data associated with the session in order to cleanup binders. |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 147 | * Specifically, we have a strong dependency cycle, since BpBinder is |
| 148 | * OBJECT_LIFETIME_WEAK (so that onAttemptIncStrong may return true). |
| 149 | * |
Steven Moreland | bdb53ab | 2021-05-05 17:57:41 +0000 | [diff] [blame] | 150 | * BpBinder -> RpcSession -> RpcState |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 151 | * ^-----------------------------/ |
| 152 | * |
| 153 | * In the success case, eventually all refcounts should be propagated over |
Steven Moreland | bdb53ab | 2021-05-05 17:57:41 +0000 | [diff] [blame] | 154 | * the session, though this could also be called to eagerly cleanup |
| 155 | * the session. |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 156 | * |
Steven Moreland | bdb53ab | 2021-05-05 17:57:41 +0000 | [diff] [blame] | 157 | * WARNING: RpcState is responsible for calling this when the session is |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 158 | * no longer recoverable. |
| 159 | */ |
Steven Moreland | c9d7b53 | 2021-06-04 20:57:41 +0000 | [diff] [blame] | 160 | void clear(); |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 161 | |
Steven Moreland | 659416d | 2021-05-11 00:47:50 +0000 | [diff] [blame] | 162 | private: |
Steven Moreland | 583a14a | 2021-06-04 02:04:58 +0000 | [diff] [blame] | 163 | void dumpLocked(); |
Steven Moreland | 583a14a | 2021-06-04 02:04:58 +0000 | [diff] [blame] | 164 | |
Steven Moreland | dbe7183 | 2021-05-12 23:31:00 +0000 | [diff] [blame] | 165 | // Alternative to std::vector<uint8_t> that doesn't abort on allocation failure and caps |
| 166 | // large allocations to avoid being requested from allocating too much data. |
| 167 | struct CommandData { |
| 168 | explicit CommandData(size_t size); |
Steven Moreland | e839334 | 2021-05-05 23:27:53 +0000 | [diff] [blame] | 169 | bool valid() { return mSize == 0 || mData != nullptr; } |
| 170 | size_t size() { return mSize; } |
| 171 | uint8_t* data() { return mData.get(); } |
| 172 | uint8_t* release() { return mData.release(); } |
| 173 | |
| 174 | private: |
| 175 | std::unique_ptr<uint8_t[]> mData; |
| 176 | size_t mSize; |
| 177 | }; |
| 178 | |
Steven Moreland | 5ae6256 | 2021-06-10 03:21:42 +0000 | [diff] [blame] | 179 | [[nodiscard]] status_t rpcSend(const sp<RpcSession::RpcConnection>& connection, |
| 180 | const sp<RpcSession>& session, const char* what, |
Steven Moreland | 43921d5 | 2021-09-27 17:15:56 -0700 | [diff] [blame] | 181 | const void* data, size_t size, |
| 182 | const std::function<status_t()>& altPoll = nullptr); |
Steven Moreland | 5ae6256 | 2021-06-10 03:21:42 +0000 | [diff] [blame] | 183 | [[nodiscard]] status_t rpcRec(const sp<RpcSession::RpcConnection>& connection, |
| 184 | const sp<RpcSession>& session, const char* what, void* data, |
| 185 | size_t size); |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 186 | |
Steven Moreland | 5ae6256 | 2021-06-10 03:21:42 +0000 | [diff] [blame] | 187 | [[nodiscard]] status_t waitForReply(const sp<RpcSession::RpcConnection>& connection, |
| 188 | const sp<RpcSession>& session, Parcel* reply); |
Steven Moreland | 19fc9f7 | 2021-06-10 03:57:30 +0000 | [diff] [blame] | 189 | [[nodiscard]] status_t processCommand(const sp<RpcSession::RpcConnection>& connection, |
| 190 | const sp<RpcSession>& session, |
| 191 | const RpcWireHeader& command, CommandType type); |
Steven Moreland | 5ae6256 | 2021-06-10 03:21:42 +0000 | [diff] [blame] | 192 | [[nodiscard]] status_t processTransact(const sp<RpcSession::RpcConnection>& connection, |
| 193 | const sp<RpcSession>& session, |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 194 | const RpcWireHeader& command); |
Steven Moreland | 5ae6256 | 2021-06-10 03:21:42 +0000 | [diff] [blame] | 195 | [[nodiscard]] status_t processTransactInternal(const sp<RpcSession::RpcConnection>& connection, |
Steven Moreland | bdb53ab | 2021-05-05 17:57:41 +0000 | [diff] [blame] | 196 | const sp<RpcSession>& session, |
Steven Moreland | ada72bd | 2021-06-09 23:29:13 +0000 | [diff] [blame] | 197 | CommandData transactionData); |
Steven Moreland | 5ae6256 | 2021-06-10 03:21:42 +0000 | [diff] [blame] | 198 | [[nodiscard]] status_t processDecStrong(const sp<RpcSession::RpcConnection>& connection, |
Steven Moreland | ee3f466 | 2021-05-22 01:07:33 +0000 | [diff] [blame] | 199 | const sp<RpcSession>& session, |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 200 | const RpcWireHeader& command); |
| 201 | |
| 202 | struct BinderNode { |
| 203 | // Two cases: |
| 204 | // A - local binder we are serving |
| 205 | // B - remote binder, we are sending transactions to |
| 206 | wp<IBinder> binder; |
| 207 | |
| 208 | // if timesSent > 0, this will be equal to binder.promote() |
| 209 | sp<IBinder> sentRef; |
| 210 | |
| 211 | // Number of times we've sent this binder out of process, which |
| 212 | // translates to an implicit strong count. A client must send RPC binder |
| 213 | // socket's dec ref for each time it is sent out of process in order to |
| 214 | // deallocate it. Note, a proxy binder we are holding onto might be |
| 215 | // sent (this is important when the only remaining refcount of this |
| 216 | // binder is the one associated with a transaction sending it back to |
| 217 | // its server) |
| 218 | size_t timesSent = 0; |
| 219 | |
| 220 | // Number of times we've received this binder, each time corresponds to |
| 221 | // a reference we hold over the wire (not a local incStrong/decStrong) |
| 222 | size_t timesRecd = 0; |
| 223 | |
| 224 | // transaction ID, for async transactions |
| 225 | uint64_t asyncNumber = 0; |
| 226 | |
| 227 | // |
| 228 | // CASE A - local binder we are serving |
| 229 | // |
| 230 | |
| 231 | // async transaction queue, _only_ for local binder |
| 232 | struct AsyncTodo { |
Steven Moreland | f517427 | 2021-05-25 00:39:28 +0000 | [diff] [blame] | 233 | sp<IBinder> ref; |
Steven Moreland | dbe7183 | 2021-05-12 23:31:00 +0000 | [diff] [blame] | 234 | CommandData data; |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 235 | uint64_t asyncNumber = 0; |
| 236 | |
| 237 | bool operator<(const AsyncTodo& o) const { |
| 238 | return asyncNumber > /* !!! */ o.asyncNumber; |
| 239 | } |
| 240 | }; |
| 241 | std::priority_queue<AsyncTodo> asyncTodo; |
| 242 | |
| 243 | // |
| 244 | // CASE B - remote binder, we are sending transactions to |
| 245 | // |
| 246 | |
| 247 | // (no additional data specific to remote binders) |
| 248 | }; |
| 249 | |
Steven Moreland | 31bde7a | 2021-06-04 00:57:36 +0000 | [diff] [blame] | 250 | // checks if there is any reference left to a node and erases it. If erase |
| 251 | // happens, and there is a strong reference to the binder kept by |
| 252 | // binderNode, this returns that strong reference, so that it can be |
| 253 | // dropped after any locks are removed. |
Steven Moreland | 5623d1a | 2021-09-10 15:45:34 -0700 | [diff] [blame] | 254 | sp<IBinder> tryEraseNode(std::map<uint64_t, BinderNode>::iterator& it); |
Steven Moreland | 583a14a | 2021-06-04 02:04:58 +0000 | [diff] [blame] | 255 | // true - success |
Steven Moreland | c9d7b53 | 2021-06-04 20:57:41 +0000 | [diff] [blame] | 256 | // false - session shutdown, halt |
| 257 | [[nodiscard]] bool nodeProgressAsyncNumber(BinderNode* node); |
Steven Moreland | 31bde7a | 2021-06-04 00:57:36 +0000 | [diff] [blame] | 258 | |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 259 | std::mutex mNodeMutex; |
| 260 | bool mTerminated = false; |
Steven Moreland | 5623d1a | 2021-09-10 15:45:34 -0700 | [diff] [blame] | 261 | uint32_t mNextId = 0; |
Steven Moreland | bdb53ab | 2021-05-05 17:57:41 +0000 | [diff] [blame] | 262 | // binders known by both sides of a session |
Steven Moreland | 5623d1a | 2021-09-10 15:45:34 -0700 | [diff] [blame] | 263 | std::map<uint64_t, BinderNode> mNodeForAddress; |
Steven Moreland | 5553ac4 | 2020-11-11 02:14:45 +0000 | [diff] [blame] | 264 | }; |
| 265 | |
| 266 | } // namespace android |