blob: c8d8db900a95ab42158941b442f42a9acf30d71d [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 Coenene8c36e12017-05-30 16:25:07 -070097 hidl_handle(hidl_handle &&other) noexcept;
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 Coenene8c36e12017-05-30 16:25:07 -0700104 hidl_handle &operator=(hidl_handle &&other) noexcept;
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 Huber6688d602017-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.
Martijn Coenene8c36e12017-05-30 16:25:07 -0700136 hidl_string(hidl_string &&) noexcept;
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.
Martijn Coenene8c36e12017-05-30 16:25:07 -0700149 hidl_string &operator=(hidl_string &&other) noexcept;
Yifan Hong602b85a2016-10-24 13:40:01 -0700150 // 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
Chih-Hung Hsiehb30feca2017-08-01 15:40:48 -0700175// Use NOLINT to suppress missing parentheses warnings around OP.
Steven Moreland551396a2017-02-13 18:33:20 -0800176#define HIDL_STRING_OPERATOR(OP) \
177 inline bool operator OP(const hidl_string &hs1, const hidl_string &hs2) { \
Chih-Hung Hsiehb30feca2017-08-01 15:40:48 -0700178 return strcmp(hs1.c_str(), hs2.c_str()) OP 0; /* NOLINT */ \
Steven Moreland551396a2017-02-13 18:33:20 -0800179 } \
180 inline bool operator OP(const hidl_string &hs, const char *s) { \
Chih-Hung Hsiehb30feca2017-08-01 15:40:48 -0700181 return strcmp(hs.c_str(), s) OP 0; /* NOLINT */ \
Steven Moreland551396a2017-02-13 18:33:20 -0800182 } \
183 inline bool operator OP(const char *s, const hidl_string &hs) { \
Chih-Hung Hsiehb30feca2017-08-01 15:40:48 -0700184 return strcmp(hs.c_str(), s) OP 0; /* NOLINT */ \
Steven Moreland551396a2017-02-13 18:33:20 -0800185 }
Scott Randolphbb840f72016-11-21 14:39:26 -0800186
Steven Moreland551396a2017-02-13 18:33:20 -0800187HIDL_STRING_OPERATOR(==)
188HIDL_STRING_OPERATOR(!=)
189HIDL_STRING_OPERATOR(<)
190HIDL_STRING_OPERATOR(<=)
191HIDL_STRING_OPERATOR(>)
192HIDL_STRING_OPERATOR(>=)
Scott Randolphbb840f72016-11-21 14:39:26 -0800193
Steven Moreland551396a2017-02-13 18:33:20 -0800194#undef HIDL_STRING_OPERATOR
Yifan Hong5708fb42016-10-26 17:50:29 -0700195
Scott Randolph0c84ab42017-04-03 14:07:14 -0700196// Send our content to the output stream
197std::ostream& operator<<(std::ostream& os, const hidl_string& str);
198
199
Martijn Coenen30791002016-12-01 15:40:46 +0100200// hidl_memory is a structure that can be used to transfer
201// pieces of shared memory between processes. The assumption
202// of this object is that the memory remains accessible as
203// long as the file descriptors in the enclosed mHandle
204// - as well as all of its cross-process dups() - remain opened.
205struct hidl_memory {
206
Martijn Coenen04b91c02017-01-19 14:14:21 +0100207 hidl_memory() : mHandle(nullptr), mSize(0), mName("") {
Martijn Coenen30791002016-12-01 15:40:46 +0100208 }
209
210 /**
Martijn Coenen04b91c02017-01-19 14:14:21 +0100211 * Creates a hidl_memory object, but doesn't take ownership of
212 * the passed in native_handle_t; callers are responsible for
213 * making sure the handle remains valid while this object is
214 * used.
Martijn Coenen30791002016-12-01 15:40:46 +0100215 */
Martijn Coenen04b91c02017-01-19 14:14:21 +0100216 hidl_memory(const hidl_string &name, const native_handle_t *handle, size_t size)
217 : mHandle(handle),
Martijn Coenen30791002016-12-01 15:40:46 +0100218 mSize(size),
219 mName(name)
220 {}
221
222 // copy constructor
223 hidl_memory(const hidl_memory& other) {
224 *this = other;
225 }
226
227 // copy assignment
228 hidl_memory &operator=(const hidl_memory &other) {
229 if (this != &other) {
Martijn Coenen04b91c02017-01-19 14:14:21 +0100230 mHandle = other.mHandle;
Martijn Coenen30791002016-12-01 15:40:46 +0100231 mSize = other.mSize;
232 mName = other.mName;
233 }
234
235 return *this;
236 }
237
Hridya Valsaraju01268892017-02-27 08:48:38 -0800238 // move constructor
Martijn Coenene8c36e12017-05-30 16:25:07 -0700239 hidl_memory(hidl_memory&& other) noexcept {
Hridya Valsaraju01268892017-02-27 08:48:38 -0800240 *this = std::move(other);
241 }
242
243 // move assignment
Martijn Coenene8c36e12017-05-30 16:25:07 -0700244 hidl_memory &operator=(hidl_memory &&other) noexcept {
Hridya Valsaraju01268892017-02-27 08:48:38 -0800245 if (this != &other) {
246 mHandle = std::move(other.mHandle);
247 mSize = other.mSize;
248 mName = std::move(other.mName);
249 other.mSize = 0;
250 }
251
252 return *this;
253 }
254
Martijn Coenen30791002016-12-01 15:40:46 +0100255
256 ~hidl_memory() {
Martijn Coenen30791002016-12-01 15:40:46 +0100257 }
258
259 const native_handle_t* handle() const {
260 return mHandle;
261 }
262
263 const hidl_string &name() const {
264 return mName;
265 }
266
Hridya Valsaraju6d4acb12017-03-03 14:24:43 -0800267 uint64_t size() const {
Martijn Coenen30791002016-12-01 15:40:46 +0100268 return mSize;
269 }
270
271 // offsetof(hidl_memory, mHandle) exposed since mHandle is private.
272 static const size_t kOffsetOfHandle;
273 // offsetof(hidl_memory, mName) exposed since mHandle is private.
274 static const size_t kOffsetOfName;
Jeff Tinker0f3461d2017-01-03 10:40:55 -0800275
Martijn Coenen30791002016-12-01 15:40:46 +0100276private:
Hridya Valsaraju6d4acb12017-03-03 14:24:43 -0800277 hidl_handle mHandle __attribute__ ((aligned(8)));
278 uint64_t mSize __attribute__ ((aligned(8)));
279 hidl_string mName __attribute__ ((aligned(8)));
Martijn Coenen30791002016-12-01 15:40:46 +0100280};
281
Andreas Huber20dce082016-09-22 19:39:13 -0700282////////////////////////////////////////////////////////////////////////////////
283
Martijn Coenen72110162016-08-19 14:28:25 +0200284template<typename T>
Hridya Valsarajub7370302017-03-08 14:39:23 -0800285struct hidl_vec {
Martijn Coenen72110162016-08-19 14:28:25 +0200286 hidl_vec()
Stephen Hinesfd9ecee2017-09-27 18:52:52 -0700287 : mBuffer(nullptr),
Martijn Coenen72110162016-08-19 14:28:25 +0200288 mSize(0),
289 mOwnsBuffer(true) {
Hridya Valsaraju6d4acb12017-03-03 14:24:43 -0800290 static_assert(hidl_vec<T>::kOffsetOfBuffer == 0, "wrong offset");
Martijn Coenen72110162016-08-19 14:28:25 +0200291 }
292
Steven Moreland96e9de02017-09-29 14:11:20 -0700293 hidl_vec(size_t size) : hidl_vec() { resize(size); }
294
Yifan Hong602b85a2016-10-24 13:40:01 -0700295 hidl_vec(const hidl_vec<T> &other) : hidl_vec() {
Martijn Coenen72110162016-08-19 14:28:25 +0200296 *this = other;
297 }
298
Martijn Coenene8c36e12017-05-30 16:25:07 -0700299 hidl_vec(hidl_vec<T> &&other) noexcept
Steven Moreland9fbfe472016-11-14 16:49:17 -0800300 : mOwnsBuffer(false) {
Janis Danisevskisd3ddf622016-10-24 11:40:50 +0100301 *this = std::move(other);
Alexey Polyudov0ebdbe82016-10-18 09:31:46 -0700302 }
303
Steven Morelandb69926a2016-11-15 10:02:57 -0800304 hidl_vec(const std::initializer_list<T> list)
Yifan Hongca1d1bf2016-12-19 14:26:19 -0800305 : mOwnsBuffer(true) {
306 if (list.size() > UINT32_MAX) {
Hridya Valsarajub7370302017-03-08 14:39:23 -0800307 details::logAlwaysFatal("hidl_vec can't hold more than 2^32 elements.");
Yifan Hongca1d1bf2016-12-19 14:26:19 -0800308 }
309 mSize = static_cast<uint32_t>(list.size());
Steven Moreland9fbfe472016-11-14 16:49:17 -0800310 mBuffer = new T[mSize];
311
Steven Morelandb69926a2016-11-15 10:02:57 -0800312 size_t idx = 0;
Steven Moreland9fbfe472016-11-14 16:49:17 -0800313 for (auto it = list.begin(); it != list.end(); ++it) {
314 mBuffer[idx++] = *it;
315 }
316 }
317
Yifan Hong602b85a2016-10-24 13:40:01 -0700318 hidl_vec(const std::vector<T> &other) : hidl_vec() {
319 *this = other;
320 }
321
Tomasz Wasilczyka9f60732017-06-30 10:53:22 -0700322 template <typename InputIterator,
323 typename = typename std::enable_if<std::is_convertible<
324 typename std::iterator_traits<InputIterator>::iterator_category,
325 std::input_iterator_tag>::value>::type>
326 hidl_vec(InputIterator first, InputIterator last) : mOwnsBuffer(true) {
327 auto size = std::distance(first, last);
328 if (size > static_cast<int64_t>(UINT32_MAX)) {
329 details::logAlwaysFatal("hidl_vec can't hold more than 2^32 elements.");
330 }
331 if (size < 0) {
332 details::logAlwaysFatal("size can't be negative.");
333 }
334 mSize = static_cast<uint32_t>(size);
335 mBuffer = new T[mSize];
336
337 size_t idx = 0;
338 for (; first != last; ++first) {
339 mBuffer[idx++] = static_cast<T>(*first);
340 }
341 }
342
Martijn Coenen72110162016-08-19 14:28:25 +0200343 ~hidl_vec() {
344 if (mOwnsBuffer) {
345 delete[] mBuffer;
346 }
Stephen Hinesfd9ecee2017-09-27 18:52:52 -0700347 mBuffer = nullptr;
Martijn Coenen72110162016-08-19 14:28:25 +0200348 }
349
Alexey Polyudove2299012016-10-19 09:52:00 -0700350 // Reference an existing array, optionally taking ownership. It is the
Martijn Coenen72110162016-08-19 14:28:25 +0200351 // caller's responsibility to ensure that the underlying memory stays
352 // valid for the lifetime of this hidl_vec.
Alexey Polyudove2299012016-10-19 09:52:00 -0700353 void setToExternal(T *data, size_t size, bool shouldOwn = false) {
Martijn Coenen72110162016-08-19 14:28:25 +0200354 if (mOwnsBuffer) {
355 delete [] mBuffer;
356 }
357 mBuffer = data;
Martijn Coenen4ca39a02016-11-11 15:58:51 +0100358 if (size > UINT32_MAX) {
Hridya Valsarajub7370302017-03-08 14:39:23 -0800359 details::logAlwaysFatal("external vector size exceeds 2^32 elements.");
Martijn Coenen4ca39a02016-11-11 15:58:51 +0100360 }
361 mSize = static_cast<uint32_t>(size);
Alexey Polyudove2299012016-10-19 09:52:00 -0700362 mOwnsBuffer = shouldOwn;
Martijn Coenen72110162016-08-19 14:28:25 +0200363 }
364
Alexey Polyudov6f0c9a12016-10-18 09:37:35 -0700365 T *data() {
366 return mBuffer;
367 }
368
369 const T *data() const {
370 return mBuffer;
371 }
372
Alexey Polyudovc98a99c2016-10-18 09:43:56 -0700373 T *releaseData() {
374 if (!mOwnsBuffer && mSize > 0) {
375 resize(mSize);
376 }
377 mOwnsBuffer = false;
378 return mBuffer;
379 }
380
Martijn Coenene8c36e12017-05-30 16:25:07 -0700381 hidl_vec &operator=(hidl_vec &&other) noexcept {
Janis Danisevskisd3ddf622016-10-24 11:40:50 +0100382 if (mOwnsBuffer) {
383 delete[] mBuffer;
384 }
Alexey Polyudov0ebdbe82016-10-18 09:31:46 -0700385 mBuffer = other.mBuffer;
386 mSize = other.mSize;
387 mOwnsBuffer = other.mOwnsBuffer;
388 other.mOwnsBuffer = false;
389 return *this;
390 }
391
Martijn Coenen72110162016-08-19 14:28:25 +0200392 hidl_vec &operator=(const hidl_vec &other) {
393 if (this != &other) {
394 if (mOwnsBuffer) {
395 delete[] mBuffer;
396 }
Yifan Hong602b85a2016-10-24 13:40:01 -0700397 copyFrom(other, other.mSize);
Martijn Coenen72110162016-08-19 14:28:25 +0200398 }
399
400 return *this;
401 }
402
Yifan Hong602b85a2016-10-24 13:40:01 -0700403 // copy from an std::vector.
404 hidl_vec &operator=(const std::vector<T> &other) {
405 if (mOwnsBuffer) {
406 delete[] mBuffer;
407 }
408 copyFrom(other, other.size());
409 return *this;
410 }
411
412 // cast to an std::vector.
413 operator std::vector<T>() const {
414 std::vector<T> v(mSize);
415 for (size_t i = 0; i < mSize; ++i) {
416 v[i] = mBuffer[i];
417 }
418 return v;
419 }
420
Yifan Hong9fcbb362016-12-20 16:46:41 -0800421 // equality check, assuming that T::operator== is defined.
422 bool operator==(const hidl_vec &other) const {
423 if (mSize != other.size()) {
424 return false;
425 }
426 for (size_t i = 0; i < mSize; ++i) {
427 if (!(mBuffer[i] == other.mBuffer[i])) {
428 return false;
429 }
430 }
431 return true;
432 }
433
434 // inequality check, assuming that T::operator== is defined.
435 inline bool operator!=(const hidl_vec &other) const {
436 return !((*this) == other);
437 }
438
Martijn Coenen72110162016-08-19 14:28:25 +0200439 size_t size() const {
440 return mSize;
441 }
442
443 T &operator[](size_t index) {
444 return mBuffer[index];
445 }
446
447 const T &operator[](size_t index) const {
448 return mBuffer[index];
449 }
450
451 void resize(size_t size) {
Martijn Coenen4ca39a02016-11-11 15:58:51 +0100452 if (size > UINT32_MAX) {
Hridya Valsarajub7370302017-03-08 14:39:23 -0800453 details::logAlwaysFatal("hidl_vec can't hold more than 2^32 elements.");
Martijn Coenen4ca39a02016-11-11 15:58:51 +0100454 }
Martijn Coenen72110162016-08-19 14:28:25 +0200455 T *newBuffer = new T[size];
456
Martijn Coenen4ca39a02016-11-11 15:58:51 +0100457 for (size_t i = 0; i < std::min(static_cast<uint32_t>(size), mSize); ++i) {
Martijn Coenen72110162016-08-19 14:28:25 +0200458 newBuffer[i] = mBuffer[i];
459 }
460
461 if (mOwnsBuffer) {
462 delete[] mBuffer;
463 }
464 mBuffer = newBuffer;
465
Martijn Coenen4ca39a02016-11-11 15:58:51 +0100466 mSize = static_cast<uint32_t>(size);
Martijn Coenen72110162016-08-19 14:28:25 +0200467 mOwnsBuffer = true;
468 }
469
Yifan Hong089ae132016-11-11 11:32:52 -0800470 // offsetof(hidl_string, mBuffer) exposed since mBuffer is private.
471 static const size_t kOffsetOfBuffer;
Scott Randolphbb840f72016-11-21 14:39:26 -0800472
Yifan Hong64fdf4d2016-12-09 16:22:45 -0800473private:
Scott Randolphbb840f72016-11-21 14:39:26 -0800474 // Define std interator interface for walking the array contents
Yifan Hong64fdf4d2016-12-09 16:22:45 -0800475 template<bool is_const>
476 class iter : public std::iterator<
477 std::random_access_iterator_tag, /* Category */
478 T,
479 ptrdiff_t, /* Distance */
480 typename std::conditional<is_const, const T *, T *>::type /* Pointer */,
481 typename std::conditional<is_const, const T &, T &>::type /* Reference */>
Scott Randolphbb840f72016-11-21 14:39:26 -0800482 {
Yifan Hong64fdf4d2016-12-09 16:22:45 -0800483 using traits = std::iterator_traits<iter>;
484 using ptr_type = typename traits::pointer;
485 using ref_type = typename traits::reference;
486 using diff_type = typename traits::difference_type;
Scott Randolphbb840f72016-11-21 14:39:26 -0800487 public:
Yifan Hong64fdf4d2016-12-09 16:22:45 -0800488 iter(ptr_type ptr) : mPtr(ptr) { }
489 inline iter &operator++() { mPtr++; return *this; }
490 inline iter operator++(int) { iter i = *this; mPtr++; return i; }
491 inline iter &operator--() { mPtr--; return *this; }
492 inline iter operator--(int) { iter i = *this; mPtr--; return i; }
493 inline friend iter operator+(diff_type n, const iter &it) { return it.mPtr + n; }
494 inline iter operator+(diff_type n) const { return mPtr + n; }
495 inline iter operator-(diff_type n) const { return mPtr - n; }
496 inline diff_type operator-(const iter &other) const { return mPtr - other.mPtr; }
497 inline iter &operator+=(diff_type n) { mPtr += n; return *this; }
498 inline iter &operator-=(diff_type n) { mPtr -= n; return *this; }
499 inline ref_type operator*() const { return *mPtr; }
500 inline ptr_type operator->() const { return mPtr; }
501 inline bool operator==(const iter &rhs) const { return mPtr == rhs.mPtr; }
502 inline bool operator!=(const iter &rhs) const { return mPtr != rhs.mPtr; }
503 inline bool operator< (const iter &rhs) const { return mPtr < rhs.mPtr; }
504 inline bool operator> (const iter &rhs) const { return mPtr > rhs.mPtr; }
505 inline bool operator<=(const iter &rhs) const { return mPtr <= rhs.mPtr; }
506 inline bool operator>=(const iter &rhs) const { return mPtr >= rhs.mPtr; }
507 inline ref_type operator[](size_t n) const { return mPtr[n]; }
Scott Randolphbb840f72016-11-21 14:39:26 -0800508 private:
Yifan Hong64fdf4d2016-12-09 16:22:45 -0800509 ptr_type mPtr;
Scott Randolphbb840f72016-11-21 14:39:26 -0800510 };
Yifan Hong64fdf4d2016-12-09 16:22:45 -0800511public:
512 using iterator = iter<false /* is_const */>;
513 using const_iterator = iter<true /* is_const */>;
514
Scott Randolphbb840f72016-11-21 14:39:26 -0800515 iterator begin() { return data(); }
516 iterator end() { return data()+mSize; }
Yifan Hong64fdf4d2016-12-09 16:22:45 -0800517 const_iterator begin() const { return data(); }
518 const_iterator end() const { return data()+mSize; }
Scott Randolphbb840f72016-11-21 14:39:26 -0800519
Martijn Coenen72110162016-08-19 14:28:25 +0200520private:
Martijn Coenen4ca39a02016-11-11 15:58:51 +0100521 details::hidl_pointer<T> mBuffer;
522 uint32_t mSize;
Martijn Coenen72110162016-08-19 14:28:25 +0200523 bool mOwnsBuffer;
Yifan Hong602b85a2016-10-24 13:40:01 -0700524
525 // copy from an array-like object, assuming my resources are freed.
526 template <typename Array>
527 void copyFrom(const Array &data, size_t size) {
Chia-I Wu4b48edc2016-12-07 22:31:17 +0800528 mSize = static_cast<uint32_t>(size);
Yifan Hong602b85a2016-10-24 13:40:01 -0700529 mOwnsBuffer = true;
530 if (mSize > 0) {
531 mBuffer = new T[size];
532 for (size_t i = 0; i < size; ++i) {
533 mBuffer[i] = data[i];
534 }
535 } else {
Stephen Hinesfd9ecee2017-09-27 18:52:52 -0700536 mBuffer = nullptr;
Yifan Hong602b85a2016-10-24 13:40:01 -0700537 }
538 }
Martijn Coenen72110162016-08-19 14:28:25 +0200539};
540
Yifan Hong089ae132016-11-11 11:32:52 -0800541template <typename T>
542const size_t hidl_vec<T>::kOffsetOfBuffer = offsetof(hidl_vec<T>, mBuffer);
543
Andreas Huber20dce082016-09-22 19:39:13 -0700544////////////////////////////////////////////////////////////////////////////////
545
546namespace details {
547
548 template<size_t SIZE1, size_t... SIZES>
549 struct product {
550 static constexpr size_t value = SIZE1 * product<SIZES...>::value;
551 };
552
553 template<size_t SIZE1>
554 struct product<SIZE1> {
555 static constexpr size_t value = SIZE1;
556 };
557
558 template<typename T, size_t SIZE1, size_t... SIZES>
Yifan Hong44ab6232016-11-22 16:28:24 -0800559 struct std_array {
560 using type = std::array<typename std_array<T, SIZES...>::type, SIZE1>;
561 };
562
563 template<typename T, size_t SIZE1>
564 struct std_array<T, SIZE1> {
565 using type = std::array<T, SIZE1>;
566 };
567
568 template<typename T, size_t SIZE1, size_t... SIZES>
Andreas Huber20dce082016-09-22 19:39:13 -0700569 struct accessor {
Yifan Hong44ab6232016-11-22 16:28:24 -0800570
571 using std_array_type = typename std_array<T, SIZE1, SIZES...>::type;
572
Andreas Huber20dce082016-09-22 19:39:13 -0700573 explicit accessor(T *base)
574 : mBase(base) {
575 }
576
577 accessor<T, SIZES...> operator[](size_t index) {
578 return accessor<T, SIZES...>(
579 &mBase[index * product<SIZES...>::value]);
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>
594 struct accessor<T, SIZE1> {
Yifan Hong44ab6232016-11-22 16:28:24 -0800595
596 using std_array_type = typename std_array<T, SIZE1>::type;
597
Andreas Huber20dce082016-09-22 19:39:13 -0700598 explicit accessor(T *base)
599 : mBase(base) {
600 }
601
602 T &operator[](size_t index) {
603 return mBase[index];
604 }
605
Yifan Hong44ab6232016-11-22 16:28:24 -0800606 accessor &operator=(const std_array_type &other) {
607 for (size_t i = 0; i < SIZE1; ++i) {
608 (*this)[i] = other[i];
609 }
610 return *this;
611 }
612
Andreas Huber20dce082016-09-22 19:39:13 -0700613 private:
614 T *mBase;
615 };
616
617 template<typename T, size_t SIZE1, size_t... SIZES>
618 struct const_accessor {
Yifan Hong44ab6232016-11-22 16:28:24 -0800619
620 using std_array_type = typename std_array<T, SIZE1, SIZES...>::type;
621
Andreas Huber20dce082016-09-22 19:39:13 -0700622 explicit const_accessor(const T *base)
623 : mBase(base) {
624 }
625
Yifan Hongbe7a6882017-01-05 17:30:17 -0800626 const_accessor<T, SIZES...> operator[](size_t index) const {
Andreas Huber20dce082016-09-22 19:39:13 -0700627 return const_accessor<T, SIZES...>(
628 &mBase[index * product<SIZES...>::value]);
629 }
630
Yifan Hong44ab6232016-11-22 16:28:24 -0800631 operator std_array_type() {
632 std_array_type array;
633 for (size_t i = 0; i < SIZE1; ++i) {
634 array[i] = (*this)[i];
635 }
636 return array;
637 }
638
Andreas Huber20dce082016-09-22 19:39:13 -0700639 private:
640 const T *mBase;
641 };
642
643 template<typename T, size_t SIZE1>
644 struct const_accessor<T, SIZE1> {
Yifan Hong44ab6232016-11-22 16:28:24 -0800645
646 using std_array_type = typename std_array<T, SIZE1>::type;
647
Andreas Huber20dce082016-09-22 19:39:13 -0700648 explicit const_accessor(const T *base)
649 : mBase(base) {
650 }
651
652 const T &operator[](size_t index) const {
653 return mBase[index];
654 }
655
Yifan Hong44ab6232016-11-22 16:28:24 -0800656 operator std_array_type() {
657 std_array_type array;
658 for (size_t i = 0; i < SIZE1; ++i) {
659 array[i] = (*this)[i];
660 }
661 return array;
662 }
663
Andreas Huber20dce082016-09-22 19:39:13 -0700664 private:
665 const T *mBase;
666 };
667
668} // namespace details
669
670////////////////////////////////////////////////////////////////////////////////
671
Yifan Hong44ab6232016-11-22 16:28:24 -0800672// A multidimensional array of T's. Assumes that T::operator=(const T &) is defined.
Andreas Huber20dce082016-09-22 19:39:13 -0700673template<typename T, size_t SIZE1, size_t... SIZES>
674struct hidl_array {
Yifan Hong44ab6232016-11-22 16:28:24 -0800675
676 using std_array_type = typename details::std_array<T, SIZE1, SIZES...>::type;
677
Andreas Huber20dce082016-09-22 19:39:13 -0700678 hidl_array() = default;
679
Yifan Hong44ab6232016-11-22 16:28:24 -0800680 // Copies the data from source, using T::operator=(const T &).
681 hidl_array(const T *source) {
682 for (size_t i = 0; i < elementCount(); ++i) {
683 mBuffer[i] = source[i];
684 }
685 }
686
687 // Copies the data from the given std::array, using T::operator=(const T &).
688 hidl_array(const std_array_type &array) {
689 details::accessor<T, SIZE1, SIZES...> modifier(mBuffer);
690 modifier = array;
691 }
692
Andreas Huber20dce082016-09-22 19:39:13 -0700693 T *data() { return mBuffer; }
694 const T *data() const { return mBuffer; }
695
696 details::accessor<T, SIZES...> operator[](size_t index) {
697 return details::accessor<T, SIZES...>(
698 &mBuffer[index * details::product<SIZES...>::value]);
699 }
700
701 details::const_accessor<T, SIZES...> operator[](size_t index) const {
702 return details::const_accessor<T, SIZES...>(
703 &mBuffer[index * details::product<SIZES...>::value]);
704 }
705
Yifan Hong9fcbb362016-12-20 16:46:41 -0800706 // equality check, assuming that T::operator== is defined.
707 bool operator==(const hidl_array &other) const {
708 for (size_t i = 0; i < elementCount(); ++i) {
709 if (!(mBuffer[i] == other.mBuffer[i])) {
710 return false;
711 }
712 }
713 return true;
714 }
715
716 inline bool operator!=(const hidl_array &other) const {
717 return !((*this) == other);
718 }
719
Andreas Huber00a985c2016-09-28 14:24:53 -0700720 using size_tuple_type = std::tuple<decltype(SIZE1), decltype(SIZES)...>;
721
722 static constexpr size_tuple_type size() {
723 return std::make_tuple(SIZE1, SIZES...);
724 }
725
Yifan Hong44ab6232016-11-22 16:28:24 -0800726 static constexpr size_t elementCount() {
727 return details::product<SIZE1, SIZES...>::value;
728 }
729
730 operator std_array_type() const {
731 return details::const_accessor<T, SIZE1, SIZES...>(mBuffer);
732 }
733
Andreas Huber20dce082016-09-22 19:39:13 -0700734private:
Yifan Hong44ab6232016-11-22 16:28:24 -0800735 T mBuffer[elementCount()];
Andreas Huber20dce082016-09-22 19:39:13 -0700736};
737
Yifan Hong44ab6232016-11-22 16:28:24 -0800738// An array of T's. Assumes that T::operator=(const T &) is defined.
Andreas Huber20dce082016-09-22 19:39:13 -0700739template<typename T, size_t SIZE1>
740struct hidl_array<T, SIZE1> {
Yifan Hong44ab6232016-11-22 16:28:24 -0800741
742 using std_array_type = typename details::std_array<T, SIZE1>::type;
743
Andreas Huber20dce082016-09-22 19:39:13 -0700744 hidl_array() = default;
Yifan Hong44ab6232016-11-22 16:28:24 -0800745
746 // Copies the data from source, using T::operator=(const T &).
Sasha Levitskiy3da68482016-11-17 16:48:43 -0800747 hidl_array(const T *source) {
Yifan Hong44ab6232016-11-22 16:28:24 -0800748 for (size_t i = 0; i < elementCount(); ++i) {
749 mBuffer[i] = source[i];
750 }
Sasha Levitskiy3da68482016-11-17 16:48:43 -0800751 }
Andreas Huber20dce082016-09-22 19:39:13 -0700752
Yifan Hong44ab6232016-11-22 16:28:24 -0800753 // Copies the data from the given std::array, using T::operator=(const T &).
754 hidl_array(const std_array_type &array) : hidl_array(array.data()) {}
755
Andreas Huber20dce082016-09-22 19:39:13 -0700756 T *data() { return mBuffer; }
757 const T *data() const { return mBuffer; }
758
759 T &operator[](size_t index) {
760 return mBuffer[index];
761 }
762
763 const T &operator[](size_t index) const {
764 return mBuffer[index];
765 }
766
Yifan Hong9fcbb362016-12-20 16:46:41 -0800767 // equality check, assuming that T::operator== is defined.
768 bool operator==(const hidl_array &other) const {
769 for (size_t i = 0; i < elementCount(); ++i) {
770 if (!(mBuffer[i] == other.mBuffer[i])) {
771 return false;
772 }
773 }
774 return true;
775 }
776
777 inline bool operator!=(const hidl_array &other) const {
778 return !((*this) == other);
779 }
780
Andreas Huber00a985c2016-09-28 14:24:53 -0700781 static constexpr size_t size() { return SIZE1; }
Yifan Hong44ab6232016-11-22 16:28:24 -0800782 static constexpr size_t elementCount() { return SIZE1; }
783
784 // Copies the data to an std::array, using T::operator=(T).
785 operator std_array_type() const {
786 std_array_type array;
787 for (size_t i = 0; i < SIZE1; ++i) {
788 array[i] = mBuffer[i];
789 }
790 return array;
791 }
Andreas Huber00a985c2016-09-28 14:24:53 -0700792
Andreas Huber20dce082016-09-22 19:39:13 -0700793private:
794 T mBuffer[SIZE1];
795};
796
Martijn Coenen72110162016-08-19 14:28:25 +0200797// ----------------------------------------------------------------------
798// Version functions
799struct hidl_version {
800public:
Chia-I Wu666b76b2016-10-06 14:15:59 +0800801 constexpr hidl_version(uint16_t major, uint16_t minor) : mMajor(major), mMinor(minor) {}
Martijn Coenen72110162016-08-19 14:28:25 +0200802
Steven Moreland5d5ef7f2016-10-20 19:19:55 -0700803 bool operator==(const hidl_version& other) const {
Martijn Coenen72110162016-08-19 14:28:25 +0200804 return (mMajor == other.get_major() && mMinor == other.get_minor());
805 }
Martijn Coenenc28f1152016-08-22 14:06:56 +0200806
Eino-Ville Talvala19f4db52016-12-14 15:19:28 -0800807 bool operator<(const hidl_version& other) const {
808 return (mMajor < other.get_major() ||
809 (mMajor == other.get_major() && mMinor < other.get_minor()));
810 }
811
812 bool operator>(const hidl_version& other) const {
813 return other < *this;
814 }
815
816 bool operator<=(const hidl_version& other) const {
817 return !(*this > other);
818 }
819
820 bool operator>=(const hidl_version& other) const {
821 return !(*this < other);
822 }
823
Martijn Coenen097a7672016-09-08 16:56:41 +0200824 constexpr uint16_t get_major() const { return mMajor; }
825 constexpr uint16_t get_minor() const { return mMinor; }
Martijn Coenen72110162016-08-19 14:28:25 +0200826
Martijn Coenen72110162016-08-19 14:28:25 +0200827private:
828 uint16_t mMajor;
829 uint16_t mMinor;
830};
831
832inline android::hardware::hidl_version make_hidl_version(uint16_t major, uint16_t minor) {
833 return hidl_version(major,minor);
834}
835
Yifan Hongbe7a6882017-01-05 17:30:17 -0800836///////////////////// toString functions
837
Hridya Valsaraju4ff88a32017-03-09 16:01:02 -0800838std::string toString(const void *t);
Yifan Hongbe7a6882017-01-05 17:30:17 -0800839
840// toString alias for numeric types
841template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value, T>::type>
842inline std::string toString(T t) {
843 return std::to_string(t);
844}
845
Hridya Valsaraju4ff88a32017-03-09 16:01:02 -0800846namespace details {
847
Yifan Hongbe7a6882017-01-05 17:30:17 -0800848template<typename T, typename = typename std::enable_if<std::is_arithmetic<T>::value, T>::type>
849inline std::string toHexString(T t, bool prefix = true) {
850 std::ostringstream os;
851 if (prefix) { os << std::showbase; }
852 os << std::hex << t;
853 return os.str();
854}
855
856template<>
857inline std::string toHexString(uint8_t t, bool prefix) {
858 return toHexString(static_cast<int32_t>(t), prefix);
859}
860
861template<>
862inline std::string toHexString(int8_t t, bool prefix) {
863 return toHexString(static_cast<int32_t>(t), prefix);
864}
865
Hridya Valsaraju4ff88a32017-03-09 16:01:02 -0800866template<typename Array>
867std::string arrayToString(const Array &a, size_t size);
868
869template<size_t SIZE1>
870std::string arraySizeToString() {
871 return std::string{"["} + toString(SIZE1) + "]";
872}
873
874template<size_t SIZE1, size_t SIZE2, size_t... SIZES>
875std::string arraySizeToString() {
876 return std::string{"["} + toString(SIZE1) + "]" + arraySizeToString<SIZE2, SIZES...>();
877}
878
879template<typename T, size_t SIZE1>
880std::string toString(details::const_accessor<T, SIZE1> a) {
881 return arrayToString(a, SIZE1);
882}
883
884template<typename Array>
885std::string arrayToString(const Array &a, size_t size) {
886 using android::hardware::toString;
887 std::string os;
888 os += "{";
889 for (size_t i = 0; i < size; ++i) {
890 if (i > 0) {
891 os += ", ";
892 }
893 os += toString(a[i]);
894 }
895 os += "}";
896 return os;
897}
898
899template<typename T, size_t SIZE1, size_t SIZE2, size_t... SIZES>
900std::string toString(details::const_accessor<T, SIZE1, SIZE2, SIZES...> a) {
901 return arrayToString(a, SIZE1);
902}
903
904} //namespace details
905
906inline std::string toString(const void *t) {
907 return details::toHexString(reinterpret_cast<uintptr_t>(t));
Yifan Hongbe7a6882017-01-05 17:30:17 -0800908}
909
910// debug string dump. There will be quotes around the string!
911inline std::string toString(const hidl_string &hs) {
912 return std::string{"\""} + hs.c_str() + "\"";
913}
914
915// debug string dump
916inline std::string toString(const hidl_handle &hs) {
917 return toString(hs.getNativeHandle());
918}
919
920inline std::string toString(const hidl_memory &mem) {
921 return std::string{"memory {.name = "} + toString(mem.name()) + ", .size = "
922 + toString(mem.size())
923 + ", .handle = " + toString(mem.handle()) + "}";
924}
925
926inline std::string toString(const sp<hidl_death_recipient> &dr) {
927 return std::string{"death_recipient@"} + toString(dr.get());
928}
929
Yifan Hongbe7a6882017-01-05 17:30:17 -0800930// debug string dump, assuming that toString(T) is defined.
931template<typename T>
932std::string toString(const hidl_vec<T> &a) {
933 std::string os;
934 os += "[" + toString(a.size()) + "]";
Hridya Valsaraju4ff88a32017-03-09 16:01:02 -0800935 os += details::arrayToString(a, a.size());
Yifan Hongbe7a6882017-01-05 17:30:17 -0800936 return os;
937}
938
Yifan Hongbe7a6882017-01-05 17:30:17 -0800939template<typename T, size_t SIZE1>
940std::string toString(const hidl_array<T, SIZE1> &a) {
Hridya Valsaraju4ff88a32017-03-09 16:01:02 -0800941 return details::arraySizeToString<SIZE1>()
942 + details::toString(details::const_accessor<T, SIZE1>(a.data()));
Yifan Hongbe7a6882017-01-05 17:30:17 -0800943}
944
945template<typename T, size_t SIZE1, size_t SIZE2, size_t... SIZES>
946std::string toString(const hidl_array<T, SIZE1, SIZE2, SIZES...> &a) {
Hridya Valsaraju4ff88a32017-03-09 16:01:02 -0800947 return details::arraySizeToString<SIZE1, SIZE2, SIZES...>()
948 + details::toString(details::const_accessor<T, SIZE1, SIZE2, SIZES...>(a.data()));
Yifan Hongbe7a6882017-01-05 17:30:17 -0800949}
950
Martijn Coenen72110162016-08-19 14:28:25 +0200951} // namespace hardware
952} // namespace android
953
Martijn Coenenc28f1152016-08-22 14:06:56 +0200954
Martijn Coenen72110162016-08-19 14:28:25 +0200955#endif // ANDROID_HIDL_SUPPORT_H