blob: d7c3b8338338826f88b65e1acebf2e043fdfc1a4 [file] [log] [blame]
Martijn Coenen72110162016-08-19 14:28:25 +02001/*
2 * Copyright (C) 2016 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#ifndef ANDROID_HIDL_SUPPORT_H
18#define ANDROID_HIDL_SUPPORT_H
19
Iliyan Malchev692070a2016-09-12 16:30:44 -070020#include <algorithm>
Yifan Hong44ab6232016-11-22 16:28:24 -080021#include <array>
Scott Randolphbb840f72016-11-21 14:39:26 -080022#include <iterator>
Martijn Coenen4d1e9cc2016-11-18 15:20:18 +010023#include <cutils/native_handle.h>
Steven Moreland337c3ae2016-11-22 13:37:32 -080024#include <hidl/HidlInternal.h>
Yifan Honga3c31842016-10-21 10:33:14 -070025#include <hidl/Status.h>
Yifan Hong1e265bb2016-11-08 12:33:44 -080026#include <map>
Yifan Hongbe7a6882017-01-05 17:30:17 -080027#include <sstream>
Yifan Hong64fdf4d2016-12-09 16:22:45 -080028#include <stddef.h>
Andreas Huber00a985c2016-09-28 14:24:53 -070029#include <tuple>
Yifan Hong64fdf4d2016-12-09 16:22:45 -080030#include <type_traits>
Iliyan Malchev692070a2016-09-12 16:30:44 -070031#include <utils/Errors.h>
32#include <utils/RefBase.h>
33#include <utils/StrongPointer.h>
Yifan Hong7f97f442016-11-14 18:31:05 -080034#include <vector>
Martijn Coenen72110162016-08-19 14:28:25 +020035
36namespace android {
Martijn Coenen30791002016-12-01 15:40:46 +010037
Martijn Coenen9b8f9c32016-12-09 15:51:06 +010038// this file is included by all hidl interface, so we must forward declare the
39// IMemory and IBase types.
Martijn Coenen30791002016-12-01 15:40:46 +010040namespace hidl {
41namespace memory {
42namespace V1_0 {
43 struct IMemory;
44}; // namespace V1_0
45}; // namespace manager
46}; // namespace hidl
47
Martijn Coenen9b8f9c32016-12-09 15:51:06 +010048namespace hidl {
49namespace base {
50namespace V1_0 {
51 struct IBase;
52}; // namespace V1_0
53}; // namespace base
54}; // namespace hidl
55
Martijn Coenen72110162016-08-19 14:28:25 +020056namespace hardware {
57
Yifan Hong24332ef2017-03-07 16:22:19 -080058namespace details {
59// Return true on userdebug / eng builds and false on user builds.
60bool debuggable();
61} // namespace details
62
Martijn Coenen9b8f9c32016-12-09 15:51:06 +010063// hidl_death_recipient is a callback interfaced that can be used with
64// linkToDeath() / unlinkToDeath()
65struct hidl_death_recipient : public virtual RefBase {
66 virtual void serviceDied(uint64_t cookie,
67 const ::android::wp<::android::hidl::base::V1_0::IBase>& who) = 0;
68};
69
Martijn Coenen4d1e9cc2016-11-18 15:20:18 +010070// hidl_handle wraps a pointer to a native_handle_t in a hidl_pointer,
71// so that it can safely be transferred between 32-bit and 64-bit processes.
Martijn Coenen04b91c02017-01-19 14:14:21 +010072// The ownership semantics for this are:
73// 1) The conversion constructor and assignment operator taking a const native_handle_t*
74// do not take ownership of the handle; this is because these operations are usually
75// just done for IPC, and cloning by default is a waste of resources. If you want
76// a hidl_handle to take ownership, call setTo(handle, true /*shouldOwn*/);
77// 2) The copy constructor/assignment operator taking a hidl_handle *DO* take ownership;
78// that is because it's not intuitive that this class encapsulates a native_handle_t
79// which needs cloning to be valid; in particular, this allows constructs like this:
80// hidl_handle copy;
81// foo->someHidlCall([&](auto incoming_handle) {
82// copy = incoming_handle;
83// });
84// // copy and its enclosed file descriptors will remain valid here.
85// 3) The move constructor does what you would expect; it only owns the handle if the
86// original did.
Martijn Coenen4d1e9cc2016-11-18 15:20:18 +010087struct hidl_handle {
Martijn Coenen04b91c02017-01-19 14:14:21 +010088 hidl_handle();
89 ~hidl_handle();
Martijn Coenen4d1e9cc2016-11-18 15:20:18 +010090
Martijn Coenen04b91c02017-01-19 14:14:21 +010091 hidl_handle(const native_handle_t *handle);
Martijn Coenen4d1e9cc2016-11-18 15:20:18 +010092
Martijn Coenen04b91c02017-01-19 14:14:21 +010093 // copy constructor.
94 hidl_handle(const hidl_handle &other);
Martijn Coenen4d1e9cc2016-11-18 15:20:18 +010095
96 // move constructor.
Martijn Coenen04b91c02017-01-19 14:14:21 +010097 hidl_handle(hidl_handle &&other);
Martijn Coenen4d1e9cc2016-11-18 15:20:18 +010098
Steven Moreland6ffdc2a2017-01-23 12:34:33 -080099 // assignment operators
Martijn Coenen04b91c02017-01-19 14:14:21 +0100100 hidl_handle &operator=(const hidl_handle &other);
Martijn Coenen4d1e9cc2016-11-18 15:20:18 +0100101
Martijn Coenen04b91c02017-01-19 14:14:21 +0100102 hidl_handle &operator=(const native_handle_t *native_handle);
Martijn Coenen4d1e9cc2016-11-18 15:20:18 +0100103
Martijn Coenen04b91c02017-01-19 14:14:21 +0100104 hidl_handle &operator=(hidl_handle &&other);
Martijn Coenen4d1e9cc2016-11-18 15:20:18 +0100105
Martijn Coenen04b91c02017-01-19 14:14:21 +0100106 void setTo(native_handle_t* handle, bool shouldOwn = false);
107
108 const native_handle_t* operator->() const;
109
Martijn Coenen4d1e9cc2016-11-18 15:20:18 +0100110 // implicit conversion to const native_handle_t*
Martijn Coenen04b91c02017-01-19 14:14:21 +0100111 operator const native_handle_t *() const;
112
Martijn Coenen4d1e9cc2016-11-18 15:20:18 +0100113 // explicit conversion
Martijn Coenen04b91c02017-01-19 14:14:21 +0100114 const native_handle_t *getNativeHandle() const;
Martijn Coenen4d1e9cc2016-11-18 15:20:18 +0100115private:
Martijn Coenen04b91c02017-01-19 14:14:21 +0100116 void freeHandle();
117
Andreas Huber6b9cc692017-03-30 10:58:29 -0700118 details::hidl_pointer<const native_handle_t> mHandle __attribute__ ((aligned(8)));
119 bool mOwnsHandle __attribute ((aligned(8)));
Martijn Coenen4d1e9cc2016-11-18 15:20:18 +0100120};
121
Martijn Coenen72110162016-08-19 14:28:25 +0200122struct hidl_string {
123 hidl_string();
124 ~hidl_string();
125
Yifan Hong602b85a2016-10-24 13:40:01 -0700126 // copy constructor.
Martijn Coenen72110162016-08-19 14:28:25 +0200127 hidl_string(const hidl_string &);
Steven Morelanda21d84f2017-02-16 09:23:45 -0800128 // copy from a C-style string. nullptr will create an empty string
Steven Morelande03c0872016-10-24 10:43:50 -0700129 hidl_string(const char *);
Steven Moreland53120f72017-01-12 09:39:26 -0800130 // copy the first length characters from a C-style string.
131 hidl_string(const char *, size_t length);
Yifan Hong602b85a2016-10-24 13:40:01 -0700132 // copy from an std::string.
133 hidl_string(const std::string &);
134
135 // move constructor.
136 hidl_string(hidl_string &&);
Martijn Coenen72110162016-08-19 14:28:25 +0200137
138 const char *c_str() const;
139 size_t size() const;
140 bool empty() const;
141
Yifan Hong602b85a2016-10-24 13:40:01 -0700142 // copy assignment operator.
Steven Morelande03c0872016-10-24 10:43:50 -0700143 hidl_string &operator=(const hidl_string &);
Yifan Hong602b85a2016-10-24 13:40:01 -0700144 // copy from a C-style string.
Martijn Coenen72110162016-08-19 14:28:25 +0200145 hidl_string &operator=(const char *s);
Yifan Hong602b85a2016-10-24 13:40:01 -0700146 // copy from an std::string.
147 hidl_string &operator=(const std::string &);
148 // move assignment operator.
149 hidl_string &operator=(hidl_string &&other);
150 // cast to std::string.
151 operator std::string() const;
Steven Morelande03c0872016-10-24 10:43:50 -0700152
Martijn Coenen72110162016-08-19 14:28:25 +0200153 void clear();
154
155 // Reference an external char array. Ownership is _not_ transferred.
156 // Caller is responsible for ensuring that underlying memory is valid
157 // for the lifetime of this hidl_string.
158 void setToExternal(const char *data, size_t size);
159
Andreas Huberebfeb362016-08-25 13:39:05 -0700160 // offsetof(hidl_string, mBuffer) exposed since mBuffer is private.
161 static const size_t kOffsetOfBuffer;
162
Martijn Coenen72110162016-08-19 14:28:25 +0200163private:
Martijn Coenen4ca39a02016-11-11 15:58:51 +0100164 details::hidl_pointer<const char> mBuffer;
165 uint32_t mSize; // NOT including the terminating '\0'.
Yifan Hong602b85a2016-10-24 13:40:01 -0700166 bool mOwnsBuffer; // if true then mBuffer is a mutable char *
Martijn Coenen72110162016-08-19 14:28:25 +0200167
Yifan Hong602b85a2016-10-24 13:40:01 -0700168 // copy from data with size. Assume that my memory is freed
169 // (through clear(), for example)
170 void copyFrom(const char *data, size_t size);
171 // move from another hidl_string
172 void moveFrom(hidl_string &&);
Martijn Coenen72110162016-08-19 14:28:25 +0200173};
174
Steven Moreland551396a2017-02-13 18:33:20 -0800175#define HIDL_STRING_OPERATOR(OP) \
176 inline bool operator OP(const hidl_string &hs1, const hidl_string &hs2) { \
177 return strcmp(hs1.c_str(), hs2.c_str()) OP 0; \
178 } \
179 inline bool operator OP(const hidl_string &hs, const char *s) { \
180 return strcmp(hs.c_str(), s) OP 0; \
181 } \
182 inline bool operator OP(const char *s, const hidl_string &hs) { \
183 return strcmp(hs.c_str(), s) OP 0; \
184 }
Scott Randolphbb840f72016-11-21 14:39:26 -0800185
Steven Moreland551396a2017-02-13 18:33:20 -0800186HIDL_STRING_OPERATOR(==)
187HIDL_STRING_OPERATOR(!=)
188HIDL_STRING_OPERATOR(<)
189HIDL_STRING_OPERATOR(<=)
190HIDL_STRING_OPERATOR(>)
191HIDL_STRING_OPERATOR(>=)
Scott Randolphbb840f72016-11-21 14:39:26 -0800192
Steven Moreland551396a2017-02-13 18:33:20 -0800193#undef HIDL_STRING_OPERATOR
Yifan Hong5708fb42016-10-26 17:50:29 -0700194
Scott Randolpheb0c3372017-04-03 14:07:14 -0700195// Send our content to the output stream
196std::ostream& operator<<(std::ostream& os, const hidl_string& str);
197
198
Martijn Coenen30791002016-12-01 15:40:46 +0100199// hidl_memory is a structure that can be used to transfer
200// pieces of shared memory between processes. The assumption
201// of this object is that the memory remains accessible as
202// long as the file descriptors in the enclosed mHandle
203// - as well as all of its cross-process dups() - remain opened.
204struct hidl_memory {
205
Martijn Coenen04b91c02017-01-19 14:14:21 +0100206 hidl_memory() : mHandle(nullptr), mSize(0), mName("") {
Martijn Coenen30791002016-12-01 15:40:46 +0100207 }
208
209 /**
Martijn Coenen04b91c02017-01-19 14:14:21 +0100210 * Creates a hidl_memory object, but doesn't take ownership of
211 * the passed in native_handle_t; callers are responsible for
212 * making sure the handle remains valid while this object is
213 * used.
Martijn Coenen30791002016-12-01 15:40:46 +0100214 */
Martijn Coenen04b91c02017-01-19 14:14:21 +0100215 hidl_memory(const hidl_string &name, const native_handle_t *handle, size_t size)
216 : mHandle(handle),
Martijn Coenen30791002016-12-01 15:40:46 +0100217 mSize(size),
218 mName(name)
219 {}
220
221 // copy constructor
222 hidl_memory(const hidl_memory& other) {
223 *this = other;
224 }
225
226 // copy assignment
227 hidl_memory &operator=(const hidl_memory &other) {
228 if (this != &other) {
Martijn Coenen04b91c02017-01-19 14:14:21 +0100229 mHandle = other.mHandle;
Martijn Coenen30791002016-12-01 15:40:46 +0100230 mSize = other.mSize;
231 mName = other.mName;
232 }
233
234 return *this;
235 }
236
Hridya Valsaraju01268892017-02-27 08:48:38 -0800237 // move constructor
238 hidl_memory(hidl_memory&& other) {
239 *this = std::move(other);
240 }
241
242 // move assignment
243 hidl_memory &operator=(hidl_memory &&other) {
244 if (this != &other) {
245 mHandle = std::move(other.mHandle);
246 mSize = other.mSize;
247 mName = std::move(other.mName);
248 other.mSize = 0;
249 }
250
251 return *this;
252 }
253
Martijn Coenen30791002016-12-01 15:40:46 +0100254
255 ~hidl_memory() {
Martijn Coenen30791002016-12-01 15:40:46 +0100256 }
257
258 const native_handle_t* handle() const {
259 return mHandle;
260 }
261
262 const hidl_string &name() const {
263 return mName;
264 }
265
Hridya Valsaraju6d4acb12017-03-03 14:24:43 -0800266 uint64_t size() const {
Martijn Coenen30791002016-12-01 15:40:46 +0100267 return mSize;
268 }
269
270 // offsetof(hidl_memory, mHandle) exposed since mHandle is private.
271 static const size_t kOffsetOfHandle;
272 // offsetof(hidl_memory, mName) exposed since mHandle is private.
273 static const size_t kOffsetOfName;
Jeff Tinker0f3461d2017-01-03 10:40:55 -0800274
Martijn Coenen30791002016-12-01 15:40:46 +0100275private:
Hridya Valsaraju6d4acb12017-03-03 14:24:43 -0800276 hidl_handle mHandle __attribute__ ((aligned(8)));
277 uint64_t mSize __attribute__ ((aligned(8)));
278 hidl_string mName __attribute__ ((aligned(8)));
Martijn Coenen30791002016-12-01 15:40:46 +0100279};
280
Andreas Huber20dce082016-09-22 19:39:13 -0700281////////////////////////////////////////////////////////////////////////////////
282
Martijn Coenen72110162016-08-19 14:28:25 +0200283template<typename T>
Hridya Valsarajub7370302017-03-08 14:39:23 -0800284struct hidl_vec {
Martijn Coenen72110162016-08-19 14:28:25 +0200285 hidl_vec()
286 : mBuffer(NULL),
287 mSize(0),
288 mOwnsBuffer(true) {
Hridya Valsaraju6d4acb12017-03-03 14:24:43 -0800289 static_assert(hidl_vec<T>::kOffsetOfBuffer == 0, "wrong offset");
Martijn Coenen72110162016-08-19 14:28:25 +0200290 }
291
Yifan Hong602b85a2016-10-24 13:40:01 -0700292 hidl_vec(const hidl_vec<T> &other) : hidl_vec() {
Martijn Coenen72110162016-08-19 14:28:25 +0200293 *this = other;
294 }
295
Janis Danisevskisd3ddf622016-10-24 11:40:50 +0100296 hidl_vec(hidl_vec<T> &&other)
Steven Moreland9fbfe472016-11-14 16:49:17 -0800297 : mOwnsBuffer(false) {
Janis Danisevskisd3ddf622016-10-24 11:40:50 +0100298 *this = std::move(other);
Alexey Polyudov0ebdbe82016-10-18 09:31:46 -0700299 }
300
Steven Morelandb69926a2016-11-15 10:02:57 -0800301 hidl_vec(const std::initializer_list<T> list)
Yifan Hongca1d1bf2016-12-19 14:26:19 -0800302 : mOwnsBuffer(true) {
303 if (list.size() > UINT32_MAX) {
Hridya Valsarajub7370302017-03-08 14:39:23 -0800304 details::logAlwaysFatal("hidl_vec can't hold more than 2^32 elements.");
Yifan Hongca1d1bf2016-12-19 14:26:19 -0800305 }
306 mSize = static_cast<uint32_t>(list.size());
Steven Moreland9fbfe472016-11-14 16:49:17 -0800307 mBuffer = new T[mSize];
308
Steven Morelandb69926a2016-11-15 10:02:57 -0800309 size_t idx = 0;
Steven Moreland9fbfe472016-11-14 16:49:17 -0800310 for (auto it = list.begin(); it != list.end(); ++it) {
311 mBuffer[idx++] = *it;
312 }
313 }
314
Yifan Hong602b85a2016-10-24 13:40:01 -0700315 hidl_vec(const std::vector<T> &other) : hidl_vec() {
316 *this = other;
317 }
318
Martijn Coenen72110162016-08-19 14:28:25 +0200319 ~hidl_vec() {
320 if (mOwnsBuffer) {
321 delete[] mBuffer;
322 }
323 mBuffer = NULL;
324 }
325
Alexey Polyudove2299012016-10-19 09:52:00 -0700326 // Reference an existing array, optionally taking ownership. It is the
Martijn Coenen72110162016-08-19 14:28:25 +0200327 // caller's responsibility to ensure that the underlying memory stays
328 // valid for the lifetime of this hidl_vec.
Alexey Polyudove2299012016-10-19 09:52:00 -0700329 void setToExternal(T *data, size_t size, bool shouldOwn = false) {
Martijn Coenen72110162016-08-19 14:28:25 +0200330 if (mOwnsBuffer) {
331 delete [] mBuffer;
332 }
333 mBuffer = data;
Martijn Coenen4ca39a02016-11-11 15:58:51 +0100334 if (size > UINT32_MAX) {
Hridya Valsarajub7370302017-03-08 14:39:23 -0800335 details::logAlwaysFatal("external vector size exceeds 2^32 elements.");
Martijn Coenen4ca39a02016-11-11 15:58:51 +0100336 }
337 mSize = static_cast<uint32_t>(size);
Alexey Polyudove2299012016-10-19 09:52:00 -0700338 mOwnsBuffer = shouldOwn;
Martijn Coenen72110162016-08-19 14:28:25 +0200339 }
340
Alexey Polyudov6f0c9a12016-10-18 09:37:35 -0700341 T *data() {
342 return mBuffer;
343 }
344
345 const T *data() const {
346 return mBuffer;
347 }
348
Alexey Polyudovc98a99c2016-10-18 09:43:56 -0700349 T *releaseData() {
350 if (!mOwnsBuffer && mSize > 0) {
351 resize(mSize);
352 }
353 mOwnsBuffer = false;
354 return mBuffer;
355 }
356
Alexey Polyudov0ebdbe82016-10-18 09:31:46 -0700357 hidl_vec &operator=(hidl_vec &&other) {
Janis Danisevskisd3ddf622016-10-24 11:40:50 +0100358 if (mOwnsBuffer) {
359 delete[] mBuffer;
360 }
Alexey Polyudov0ebdbe82016-10-18 09:31:46 -0700361 mBuffer = other.mBuffer;
362 mSize = other.mSize;
363 mOwnsBuffer = other.mOwnsBuffer;
364 other.mOwnsBuffer = false;
365 return *this;
366 }
367
Martijn Coenen72110162016-08-19 14:28:25 +0200368 hidl_vec &operator=(const hidl_vec &other) {
369 if (this != &other) {
370 if (mOwnsBuffer) {
371 delete[] mBuffer;
372 }
Yifan Hong602b85a2016-10-24 13:40:01 -0700373 copyFrom(other, other.mSize);
Martijn Coenen72110162016-08-19 14:28:25 +0200374 }
375
376 return *this;
377 }
378
Yifan Hong602b85a2016-10-24 13:40:01 -0700379 // copy from an std::vector.
380 hidl_vec &operator=(const std::vector<T> &other) {
381 if (mOwnsBuffer) {
382 delete[] mBuffer;
383 }
384 copyFrom(other, other.size());
385 return *this;
386 }
387
388 // cast to an std::vector.
389 operator std::vector<T>() const {
390 std::vector<T> v(mSize);
391 for (size_t i = 0; i < mSize; ++i) {
392 v[i] = mBuffer[i];
393 }
394 return v;
395 }
396
Yifan Hong9fcbb362016-12-20 16:46:41 -0800397 // equality check, assuming that T::operator== is defined.
398 bool operator==(const hidl_vec &other) const {
399 if (mSize != other.size()) {
400 return false;
401 }
402 for (size_t i = 0; i < mSize; ++i) {
403 if (!(mBuffer[i] == other.mBuffer[i])) {
404 return false;
405 }
406 }
407 return true;
408 }
409
410 // inequality check, assuming that T::operator== is defined.
411 inline bool operator!=(const hidl_vec &other) const {
412 return !((*this) == other);
413 }
414
Martijn Coenen72110162016-08-19 14:28:25 +0200415 size_t size() const {
416 return mSize;
417 }
418
419 T &operator[](size_t index) {
420 return mBuffer[index];
421 }
422
423 const T &operator[](size_t index) const {
424 return mBuffer[index];
425 }
426
427 void resize(size_t size) {
Martijn Coenen4ca39a02016-11-11 15:58:51 +0100428 if (size > UINT32_MAX) {
Hridya Valsarajub7370302017-03-08 14:39:23 -0800429 details::logAlwaysFatal("hidl_vec can't hold more than 2^32 elements.");
Martijn Coenen4ca39a02016-11-11 15:58:51 +0100430 }
Martijn Coenen72110162016-08-19 14:28:25 +0200431 T *newBuffer = new T[size];
432
Martijn Coenen4ca39a02016-11-11 15:58:51 +0100433 for (size_t i = 0; i < std::min(static_cast<uint32_t>(size), mSize); ++i) {
Martijn Coenen72110162016-08-19 14:28:25 +0200434 newBuffer[i] = mBuffer[i];
435 }
436
437 if (mOwnsBuffer) {
438 delete[] mBuffer;
439 }
440 mBuffer = newBuffer;
441
Martijn Coenen4ca39a02016-11-11 15:58:51 +0100442 mSize = static_cast<uint32_t>(size);
Martijn Coenen72110162016-08-19 14:28:25 +0200443 mOwnsBuffer = true;
444 }
445
Yifan Hong089ae132016-11-11 11:32:52 -0800446 // offsetof(hidl_string, mBuffer) exposed since mBuffer is private.
447 static const size_t kOffsetOfBuffer;
Scott Randolphbb840f72016-11-21 14:39:26 -0800448
Yifan Hong64fdf4d2016-12-09 16:22:45 -0800449private:
Scott Randolphbb840f72016-11-21 14:39:26 -0800450 // Define std interator interface for walking the array contents
Yifan Hong64fdf4d2016-12-09 16:22:45 -0800451 template<bool is_const>
452 class iter : public std::iterator<
453 std::random_access_iterator_tag, /* Category */
454 T,
455 ptrdiff_t, /* Distance */
456 typename std::conditional<is_const, const T *, T *>::type /* Pointer */,
457 typename std::conditional<is_const, const T &, T &>::type /* Reference */>
Scott Randolphbb840f72016-11-21 14:39:26 -0800458 {
Yifan Hong64fdf4d2016-12-09 16:22:45 -0800459 using traits = std::iterator_traits<iter>;
460 using ptr_type = typename traits::pointer;
461 using ref_type = typename traits::reference;
462 using diff_type = typename traits::difference_type;
Scott Randolphbb840f72016-11-21 14:39:26 -0800463 public:
Yifan Hong64fdf4d2016-12-09 16:22:45 -0800464 iter(ptr_type ptr) : mPtr(ptr) { }
465 inline iter &operator++() { mPtr++; return *this; }
466 inline iter operator++(int) { iter i = *this; mPtr++; return i; }
467 inline iter &operator--() { mPtr--; return *this; }
468 inline iter operator--(int) { iter i = *this; mPtr--; return i; }
469 inline friend iter operator+(diff_type n, const iter &it) { return it.mPtr + n; }
470 inline iter operator+(diff_type n) const { return mPtr + n; }
471 inline iter operator-(diff_type n) const { return mPtr - n; }
472 inline diff_type operator-(const iter &other) const { return mPtr - other.mPtr; }
473 inline iter &operator+=(diff_type n) { mPtr += n; return *this; }
474 inline iter &operator-=(diff_type n) { mPtr -= n; return *this; }
475 inline ref_type operator*() const { return *mPtr; }
476 inline ptr_type operator->() const { return mPtr; }
477 inline bool operator==(const iter &rhs) const { return mPtr == rhs.mPtr; }
478 inline bool operator!=(const iter &rhs) const { return mPtr != rhs.mPtr; }
479 inline bool operator< (const iter &rhs) const { return mPtr < rhs.mPtr; }
480 inline bool operator> (const iter &rhs) const { return mPtr > rhs.mPtr; }
481 inline bool operator<=(const iter &rhs) const { return mPtr <= rhs.mPtr; }
482 inline bool operator>=(const iter &rhs) const { return mPtr >= rhs.mPtr; }
483 inline ref_type operator[](size_t n) const { return mPtr[n]; }
Scott Randolphbb840f72016-11-21 14:39:26 -0800484 private:
Yifan Hong64fdf4d2016-12-09 16:22:45 -0800485 ptr_type mPtr;
Scott Randolphbb840f72016-11-21 14:39:26 -0800486 };
Yifan Hong64fdf4d2016-12-09 16:22:45 -0800487public:
488 using iterator = iter<false /* is_const */>;
489 using const_iterator = iter<true /* is_const */>;
490
Scott Randolphbb840f72016-11-21 14:39:26 -0800491 iterator begin() { return data(); }
492 iterator end() { return data()+mSize; }
Yifan Hong64fdf4d2016-12-09 16:22:45 -0800493 const_iterator begin() const { return data(); }
494 const_iterator end() const { return data()+mSize; }
Scott Randolphbb840f72016-11-21 14:39:26 -0800495
Martijn Coenen72110162016-08-19 14:28:25 +0200496private:
Martijn Coenen4ca39a02016-11-11 15:58:51 +0100497 details::hidl_pointer<T> mBuffer;
498 uint32_t mSize;
Martijn Coenen72110162016-08-19 14:28:25 +0200499 bool mOwnsBuffer;
Yifan Hong602b85a2016-10-24 13:40:01 -0700500
501 // copy from an array-like object, assuming my resources are freed.
502 template <typename Array>
503 void copyFrom(const Array &data, size_t size) {
Chia-I Wu4b48edc2016-12-07 22:31:17 +0800504 mSize = static_cast<uint32_t>(size);
Yifan Hong602b85a2016-10-24 13:40:01 -0700505 mOwnsBuffer = true;
506 if (mSize > 0) {
507 mBuffer = new T[size];
508 for (size_t i = 0; i < size; ++i) {
509 mBuffer[i] = data[i];
510 }
511 } else {
512 mBuffer = NULL;
513 }
514 }
Martijn Coenen72110162016-08-19 14:28:25 +0200515};
516
Yifan Hong089ae132016-11-11 11:32:52 -0800517template <typename T>
518const size_t hidl_vec<T>::kOffsetOfBuffer = offsetof(hidl_vec<T>, mBuffer);
519
Andreas Huber20dce082016-09-22 19:39:13 -0700520////////////////////////////////////////////////////////////////////////////////
521
522namespace details {
523
524 template<size_t SIZE1, size_t... SIZES>
525 struct product {
526 static constexpr size_t value = SIZE1 * product<SIZES...>::value;
527 };
528
529 template<size_t SIZE1>
530 struct product<SIZE1> {
531 static constexpr size_t value = SIZE1;
532 };
533
534 template<typename T, size_t SIZE1, size_t... SIZES>
Yifan Hong44ab6232016-11-22 16:28:24 -0800535 struct std_array {
536 using type = std::array<typename std_array<T, SIZES...>::type, SIZE1>;
537 };
538
539 template<typename T, size_t SIZE1>
540 struct std_array<T, SIZE1> {
541 using type = std::array<T, SIZE1>;
542 };
543
544 template<typename T, size_t SIZE1, size_t... SIZES>
Andreas Huber20dce082016-09-22 19:39:13 -0700545 struct accessor {
Yifan Hong44ab6232016-11-22 16:28:24 -0800546
547 using std_array_type = typename std_array<T, SIZE1, SIZES...>::type;
548
Andreas Huber20dce082016-09-22 19:39:13 -0700549 explicit accessor(T *base)
550 : mBase(base) {
551 }
552
553 accessor<T, SIZES...> operator[](size_t index) {
554 return accessor<T, SIZES...>(
555 &mBase[index * product<SIZES...>::value]);
556 }
557
Yifan Hong44ab6232016-11-22 16:28:24 -0800558 accessor &operator=(const std_array_type &other) {
559 for (size_t i = 0; i < SIZE1; ++i) {
560 (*this)[i] = other[i];
561 }
562 return *this;
563 }
564
Andreas Huber20dce082016-09-22 19:39:13 -0700565 private:
566 T *mBase;
567 };
568
569 template<typename T, size_t SIZE1>
570 struct accessor<T, SIZE1> {
Yifan Hong44ab6232016-11-22 16:28:24 -0800571
572 using std_array_type = typename std_array<T, SIZE1>::type;
573
Andreas Huber20dce082016-09-22 19:39:13 -0700574 explicit accessor(T *base)
575 : mBase(base) {
576 }
577
578 T &operator[](size_t index) {
579 return mBase[index];
580 }
581
Yifan Hong44ab6232016-11-22 16:28:24 -0800582 accessor &operator=(const std_array_type &other) {
583 for (size_t i = 0; i < SIZE1; ++i) {
584 (*this)[i] = other[i];
585 }
586 return *this;
587 }
588
Andreas Huber20dce082016-09-22 19:39:13 -0700589 private:
590 T *mBase;
591 };
592
593 template<typename T, size_t SIZE1, size_t... SIZES>
594 struct const_accessor {
Yifan Hong44ab6232016-11-22 16:28:24 -0800595
596 using std_array_type = typename std_array<T, SIZE1, SIZES...>::type;
597
Andreas Huber20dce082016-09-22 19:39:13 -0700598 explicit const_accessor(const T *base)
599 : mBase(base) {
600 }
601
Yifan Hongbe7a6882017-01-05 17:30:17 -0800602 const_accessor<T, SIZES...> operator[](size_t index) const {
Andreas Huber20dce082016-09-22 19:39:13 -0700603 return const_accessor<T, SIZES...>(
604 &mBase[index * product<SIZES...>::value]);
605 }
606
Yifan Hong44ab6232016-11-22 16:28:24 -0800607 operator std_array_type() {
608 std_array_type array;
609 for (size_t i = 0; i < SIZE1; ++i) {
610 array[i] = (*this)[i];
611 }
612 return array;
613 }
614
Andreas Huber20dce082016-09-22 19:39:13 -0700615 private:
616 const T *mBase;
617 };
618
619 template<typename T, size_t SIZE1>
620 struct const_accessor<T, SIZE1> {
Yifan Hong44ab6232016-11-22 16:28:24 -0800621
622 using std_array_type = typename std_array<T, SIZE1>::type;
623
Andreas Huber20dce082016-09-22 19:39:13 -0700624 explicit const_accessor(const T *base)
625 : mBase(base) {
626 }
627
628 const T &operator[](size_t index) const {
629 return mBase[index];
630 }
631
Yifan Hong44ab6232016-11-22 16:28:24 -0800632 operator std_array_type() {
633 std_array_type array;
634 for (size_t i = 0; i < SIZE1; ++i) {
635 array[i] = (*this)[i];
636 }
637 return array;
638 }
639
Andreas Huber20dce082016-09-22 19:39:13 -0700640 private:
641 const T *mBase;
642 };
643
644} // namespace details
645
646////////////////////////////////////////////////////////////////////////////////
647
Yifan Hong44ab6232016-11-22 16:28:24 -0800648// A multidimensional array of T's. Assumes that T::operator=(const T &) is defined.
Andreas Huber20dce082016-09-22 19:39:13 -0700649template<typename T, size_t SIZE1, size_t... SIZES>
650struct hidl_array {
Yifan Hong44ab6232016-11-22 16:28:24 -0800651
652 using std_array_type = typename details::std_array<T, SIZE1, SIZES...>::type;
653
Andreas Huber20dce082016-09-22 19:39:13 -0700654 hidl_array() = default;
655
Yifan Hong44ab6232016-11-22 16:28:24 -0800656 // Copies the data from source, using T::operator=(const T &).
657 hidl_array(const T *source) {
658 for (size_t i = 0; i < elementCount(); ++i) {
659 mBuffer[i] = source[i];
660 }
661 }
662
663 // Copies the data from the given std::array, using T::operator=(const T &).
664 hidl_array(const std_array_type &array) {
665 details::accessor<T, SIZE1, SIZES...> modifier(mBuffer);
666 modifier = array;
667 }
668
Andreas Huber20dce082016-09-22 19:39:13 -0700669 T *data() { return mBuffer; }
670 const T *data() const { return mBuffer; }
671
672 details::accessor<T, SIZES...> operator[](size_t index) {
673 return details::accessor<T, SIZES...>(
674 &mBuffer[index * details::product<SIZES...>::value]);
675 }
676
677 details::const_accessor<T, SIZES...> operator[](size_t index) const {
678 return details::const_accessor<T, SIZES...>(
679 &mBuffer[index * details::product<SIZES...>::value]);
680 }
681
Yifan Hong9fcbb362016-12-20 16:46:41 -0800682 // equality check, assuming that T::operator== is defined.
683 bool operator==(const hidl_array &other) const {
684 for (size_t i = 0; i < elementCount(); ++i) {
685 if (!(mBuffer[i] == other.mBuffer[i])) {
686 return false;
687 }
688 }
689 return true;
690 }
691
692 inline bool operator!=(const hidl_array &other) const {
693 return !((*this) == other);
694 }
695
Andreas Huber00a985c2016-09-28 14:24:53 -0700696 using size_tuple_type = std::tuple<decltype(SIZE1), decltype(SIZES)...>;
697
698 static constexpr size_tuple_type size() {
699 return std::make_tuple(SIZE1, SIZES...);
700 }
701
Yifan Hong44ab6232016-11-22 16:28:24 -0800702 static constexpr size_t elementCount() {
703 return details::product<SIZE1, SIZES...>::value;
704 }
705
706 operator std_array_type() const {
707 return details::const_accessor<T, SIZE1, SIZES...>(mBuffer);
708 }
709
Andreas Huber20dce082016-09-22 19:39:13 -0700710private:
Yifan Hong44ab6232016-11-22 16:28:24 -0800711 T mBuffer[elementCount()];
Andreas Huber20dce082016-09-22 19:39:13 -0700712};
713
Yifan Hong44ab6232016-11-22 16:28:24 -0800714// An array of T's. Assumes that T::operator=(const T &) is defined.
Andreas Huber20dce082016-09-22 19:39:13 -0700715template<typename T, size_t SIZE1>
716struct hidl_array<T, SIZE1> {
Yifan Hong44ab6232016-11-22 16:28:24 -0800717
718 using std_array_type = typename details::std_array<T, SIZE1>::type;
719
Andreas Huber20dce082016-09-22 19:39:13 -0700720 hidl_array() = default;
Yifan Hong44ab6232016-11-22 16:28:24 -0800721
722 // Copies the data from source, using T::operator=(const T &).
Sasha Levitskiy3da68482016-11-17 16:48:43 -0800723 hidl_array(const T *source) {
Yifan Hong44ab6232016-11-22 16:28:24 -0800724 for (size_t i = 0; i < elementCount(); ++i) {
725 mBuffer[i] = source[i];
726 }
Sasha Levitskiy3da68482016-11-17 16:48:43 -0800727 }
Andreas Huber20dce082016-09-22 19:39:13 -0700728
Yifan Hong44ab6232016-11-22 16:28:24 -0800729 // Copies the data from the given std::array, using T::operator=(const T &).
730 hidl_array(const std_array_type &array) : hidl_array(array.data()) {}
731
Andreas Huber20dce082016-09-22 19:39:13 -0700732 T *data() { return mBuffer; }
733 const T *data() const { return mBuffer; }
734
735 T &operator[](size_t index) {
736 return mBuffer[index];
737 }
738
739 const T &operator[](size_t index) const {
740 return mBuffer[index];
741 }
742
Yifan Hong9fcbb362016-12-20 16:46:41 -0800743 // equality check, assuming that T::operator== is defined.
744 bool operator==(const hidl_array &other) const {
745 for (size_t i = 0; i < elementCount(); ++i) {
746 if (!(mBuffer[i] == other.mBuffer[i])) {
747 return false;
748 }
749 }
750 return true;
751 }
752
753 inline bool operator!=(const hidl_array &other) const {
754 return !((*this) == other);
755 }
756
Andreas Huber00a985c2016-09-28 14:24:53 -0700757 static constexpr size_t size() { return SIZE1; }
Yifan Hong44ab6232016-11-22 16:28:24 -0800758 static constexpr size_t elementCount() { return SIZE1; }
759
760 // Copies the data to an std::array, using T::operator=(T).
761 operator std_array_type() const {
762 std_array_type array;
763 for (size_t i = 0; i < SIZE1; ++i) {
764 array[i] = mBuffer[i];
765 }
766 return array;
767 }
Andreas Huber00a985c2016-09-28 14:24:53 -0700768
Andreas Huber20dce082016-09-22 19:39:13 -0700769private:
770 T mBuffer[SIZE1];
771};
772
Martijn Coenen72110162016-08-19 14:28:25 +0200773// ----------------------------------------------------------------------
774// Version functions
775struct hidl_version {
776public:
Chia-I Wu666b76b2016-10-06 14:15:59 +0800777 constexpr hidl_version(uint16_t major, uint16_t minor) : mMajor(major), mMinor(minor) {}
Martijn Coenen72110162016-08-19 14:28:25 +0200778
Steven Moreland5d5ef7f2016-10-20 19:19:55 -0700779 bool operator==(const hidl_version& other) const {
Martijn Coenen72110162016-08-19 14:28:25 +0200780 return (mMajor == other.get_major() && mMinor == other.get_minor());
781 }
Martijn Coenenc28f1152016-08-22 14:06:56 +0200782
Eino-Ville Talvala19f4db52016-12-14 15:19:28 -0800783 bool operator<(const hidl_version& other) const {
784 return (mMajor < other.get_major() ||
785 (mMajor == other.get_major() && mMinor < other.get_minor()));
786 }
787
788 bool operator>(const hidl_version& other) const {
789 return other < *this;
790 }
791
792 bool operator<=(const hidl_version& other) const {
793 return !(*this > other);
794 }
795
796 bool operator>=(const hidl_version& other) const {
797 return !(*this < other);
798 }
799
Martijn Coenen097a7672016-09-08 16:56:41 +0200800 constexpr uint16_t get_major() const { return mMajor; }
801 constexpr uint16_t get_minor() const { return mMinor; }
Martijn Coenen72110162016-08-19 14:28:25 +0200802
Martijn Coenen72110162016-08-19 14:28:25 +0200803private:
804 uint16_t mMajor;
805 uint16_t mMinor;
806};
807
808inline android::hardware::hidl_version make_hidl_version(uint16_t major, uint16_t minor) {
809 return hidl_version(major,minor);
810}
811
Yifan Hongbe7a6882017-01-05 17:30:17 -0800812///////////////////// toString functions
813
Hridya Valsaraju4ff88a32017-03-09 16:01:02 -0800814std::string toString(const void *t);
Yifan Hongbe7a6882017-01-05 17:30:17 -0800815
816// toString alias for numeric types
817template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value, T>::type>
818inline std::string toString(T t) {
819 return std::to_string(t);
820}
821
Hridya Valsaraju4ff88a32017-03-09 16:01:02 -0800822namespace details {
823
Yifan Hongbe7a6882017-01-05 17:30:17 -0800824template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value, T>::type>
825inline std::string toHexString(T t, bool prefix = true) {
826 std::ostringstream os;
827 if (prefix) { os << std::showbase; }
828 os << std::hex << t;
829 return os.str();
830}
831
832template<>
833inline std::string toHexString(uint8_t t, bool prefix) {
834 return toHexString(static_cast<int32_t>(t), prefix);
835}
836
837template<>
838inline std::string toHexString(int8_t t, bool prefix) {
839 return toHexString(static_cast<int32_t>(t), prefix);
840}
841
Hridya Valsaraju4ff88a32017-03-09 16:01:02 -0800842template<typename Array>
843std::string arrayToString(const Array &a, size_t size);
844
845template<size_t SIZE1>
846std::string arraySizeToString() {
847 return std::string{"["} + toString(SIZE1) + "]";
848}
849
850template<size_t SIZE1, size_t SIZE2, size_t... SIZES>
851std::string arraySizeToString() {
852 return std::string{"["} + toString(SIZE1) + "]" + arraySizeToString<SIZE2, SIZES...>();
853}
854
855template<typename T, size_t SIZE1>
856std::string toString(details::const_accessor<T, SIZE1> a) {
857 return arrayToString(a, SIZE1);
858}
859
860template<typename Array>
861std::string arrayToString(const Array &a, size_t size) {
862 using android::hardware::toString;
863 std::string os;
864 os += "{";
865 for (size_t i = 0; i < size; ++i) {
866 if (i > 0) {
867 os += ", ";
868 }
869 os += toString(a[i]);
870 }
871 os += "}";
872 return os;
873}
874
875template<typename T, size_t SIZE1, size_t SIZE2, size_t... SIZES>
876std::string toString(details::const_accessor<T, SIZE1, SIZE2, SIZES...> a) {
877 return arrayToString(a, SIZE1);
878}
879
880} //namespace details
881
882inline std::string toString(const void *t) {
883 return details::toHexString(reinterpret_cast<uintptr_t>(t));
Yifan Hongbe7a6882017-01-05 17:30:17 -0800884}
885
886// debug string dump. There will be quotes around the string!
887inline std::string toString(const hidl_string &hs) {
888 return std::string{"\""} + hs.c_str() + "\"";
889}
890
891// debug string dump
892inline std::string toString(const hidl_handle &hs) {
893 return toString(hs.getNativeHandle());
894}
895
896inline std::string toString(const hidl_memory &mem) {
897 return std::string{"memory {.name = "} + toString(mem.name()) + ", .size = "
898 + toString(mem.size())
899 + ", .handle = " + toString(mem.handle()) + "}";
900}
901
902inline std::string toString(const sp<hidl_death_recipient> &dr) {
903 return std::string{"death_recipient@"} + toString(dr.get());
904}
905
Yifan Hongbe7a6882017-01-05 17:30:17 -0800906// debug string dump, assuming that toString(T) is defined.
907template<typename T>
908std::string toString(const hidl_vec<T> &a) {
909 std::string os;
910 os += "[" + toString(a.size()) + "]";
Hridya Valsaraju4ff88a32017-03-09 16:01:02 -0800911 os += details::arrayToString(a, a.size());
Yifan Hongbe7a6882017-01-05 17:30:17 -0800912 return os;
913}
914
Yifan Hongbe7a6882017-01-05 17:30:17 -0800915template<typename T, size_t SIZE1>
916std::string toString(const hidl_array<T, SIZE1> &a) {
Hridya Valsaraju4ff88a32017-03-09 16:01:02 -0800917 return details::arraySizeToString<SIZE1>()
918 + details::toString(details::const_accessor<T, SIZE1>(a.data()));
Yifan Hongbe7a6882017-01-05 17:30:17 -0800919}
920
921template<typename T, size_t SIZE1, size_t SIZE2, size_t... SIZES>
922std::string toString(const hidl_array<T, SIZE1, SIZE2, SIZES...> &a) {
Hridya Valsaraju4ff88a32017-03-09 16:01:02 -0800923 return details::arraySizeToString<SIZE1, SIZE2, SIZES...>()
924 + details::toString(details::const_accessor<T, SIZE1, SIZE2, SIZES...>(a.data()));
Yifan Hongbe7a6882017-01-05 17:30:17 -0800925}
926
Martijn Coenen72110162016-08-19 14:28:25 +0200927} // namespace hardware
928} // namespace android
929
Martijn Coenenc28f1152016-08-22 14:06:56 +0200930
Martijn Coenen72110162016-08-19 14:28:25 +0200931#endif // ANDROID_HIDL_SUPPORT_H