xref: /aosp_15_r20/frameworks/native/libs/binder/Utils.h (revision 38e8c45f13ce32b0dcecb25141ffecaf386fa17f)
1*38e8c45fSAndroid Build Coastguard Worker /*
2*38e8c45fSAndroid Build Coastguard Worker  * Copyright (C) 2020 The Android Open Source Project
3*38e8c45fSAndroid Build Coastguard Worker  *
4*38e8c45fSAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*38e8c45fSAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*38e8c45fSAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*38e8c45fSAndroid Build Coastguard Worker  *
8*38e8c45fSAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*38e8c45fSAndroid Build Coastguard Worker  *
10*38e8c45fSAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*38e8c45fSAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*38e8c45fSAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*38e8c45fSAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*38e8c45fSAndroid Build Coastguard Worker  * limitations under the License.
15*38e8c45fSAndroid Build Coastguard Worker  */
16*38e8c45fSAndroid Build Coastguard Worker 
17*38e8c45fSAndroid Build Coastguard Worker #pragma once
18*38e8c45fSAndroid Build Coastguard Worker 
19*38e8c45fSAndroid Build Coastguard Worker #include <stddef.h>
20*38e8c45fSAndroid Build Coastguard Worker #include <sys/uio.h>
21*38e8c45fSAndroid Build Coastguard Worker #include <chrono>
22*38e8c45fSAndroid Build Coastguard Worker #include <cstdint>
23*38e8c45fSAndroid Build Coastguard Worker #include <optional>
24*38e8c45fSAndroid Build Coastguard Worker 
25*38e8c45fSAndroid Build Coastguard Worker #include <binder/Common.h>
26*38e8c45fSAndroid Build Coastguard Worker #include <log/log.h>
27*38e8c45fSAndroid Build Coastguard Worker #include <utils/Errors.h>
28*38e8c45fSAndroid Build Coastguard Worker 
29*38e8c45fSAndroid Build Coastguard Worker #define PLOGE(fmt, ...)                                                     \
30*38e8c45fSAndroid Build Coastguard Worker     do {                                                                    \
31*38e8c45fSAndroid Build Coastguard Worker         auto savedErrno = errno;                                            \
32*38e8c45fSAndroid Build Coastguard Worker         ALOGE(fmt ": %s" __VA_OPT__(, ) __VA_ARGS__, strerror(savedErrno)); \
33*38e8c45fSAndroid Build Coastguard Worker     } while (0)
34*38e8c45fSAndroid Build Coastguard Worker #define PLOGF(fmt, ...)                                                                \
35*38e8c45fSAndroid Build Coastguard Worker     do {                                                                               \
36*38e8c45fSAndroid Build Coastguard Worker         auto savedErrno = errno;                                                       \
37*38e8c45fSAndroid Build Coastguard Worker         LOG_ALWAYS_FATAL(fmt ": %s" __VA_OPT__(, ) __VA_ARGS__, strerror(savedErrno)); \
38*38e8c45fSAndroid Build Coastguard Worker     } while (0)
39*38e8c45fSAndroid Build Coastguard Worker 
40*38e8c45fSAndroid Build Coastguard Worker /* TEMP_FAILURE_RETRY is not available on macOS and Trusty. */
41*38e8c45fSAndroid Build Coastguard Worker #ifndef TEMP_FAILURE_RETRY
42*38e8c45fSAndroid Build Coastguard Worker /* Used to retry syscalls that can return EINTR. */
43*38e8c45fSAndroid Build Coastguard Worker #define TEMP_FAILURE_RETRY(exp)                \
44*38e8c45fSAndroid Build Coastguard Worker     ({                                         \
45*38e8c45fSAndroid Build Coastguard Worker         __typeof__(exp) _rc;                   \
46*38e8c45fSAndroid Build Coastguard Worker         do {                                   \
47*38e8c45fSAndroid Build Coastguard Worker             _rc = (exp);                       \
48*38e8c45fSAndroid Build Coastguard Worker         } while (_rc == -1 && errno == EINTR); \
49*38e8c45fSAndroid Build Coastguard Worker         _rc;                                   \
50*38e8c45fSAndroid Build Coastguard Worker     })
51*38e8c45fSAndroid Build Coastguard Worker #endif
52*38e8c45fSAndroid Build Coastguard Worker 
53*38e8c45fSAndroid Build Coastguard Worker #define TEST_AND_RETURN(value, expr)            \
54*38e8c45fSAndroid Build Coastguard Worker     do {                                        \
55*38e8c45fSAndroid Build Coastguard Worker         if (!(expr)) {                          \
56*38e8c45fSAndroid Build Coastguard Worker             ALOGE("Failed to call: %s", #expr); \
57*38e8c45fSAndroid Build Coastguard Worker             return value;                       \
58*38e8c45fSAndroid Build Coastguard Worker         }                                       \
59*38e8c45fSAndroid Build Coastguard Worker     } while (0)
60*38e8c45fSAndroid Build Coastguard Worker 
61*38e8c45fSAndroid Build Coastguard Worker #define LIBBINDER_PRAGMA(arg) _Pragma(#arg)
62*38e8c45fSAndroid Build Coastguard Worker #if defined(__clang__)
63*38e8c45fSAndroid Build Coastguard Worker #define LIBBINDER_PRAGMA_FOR_COMPILER(arg) LIBBINDER_PRAGMA(clang arg)
64*38e8c45fSAndroid Build Coastguard Worker #elif defined(__GNUC__)
65*38e8c45fSAndroid Build Coastguard Worker #define LIBBINDER_PRAGMA_FOR_COMPILER(arg) LIBBINDER_PRAGMA(GCC arg)
66*38e8c45fSAndroid Build Coastguard Worker #else
67*38e8c45fSAndroid Build Coastguard Worker #define LIBBINDER_PRAGMA_FOR_COMPILER(arg)
68*38e8c45fSAndroid Build Coastguard Worker #endif
69*38e8c45fSAndroid Build Coastguard Worker #define LIBBINDER_IGNORE(warning_flag)             \
70*38e8c45fSAndroid Build Coastguard Worker     LIBBINDER_PRAGMA_FOR_COMPILER(diagnostic push) \
71*38e8c45fSAndroid Build Coastguard Worker     LIBBINDER_PRAGMA_FOR_COMPILER(diagnostic ignored warning_flag)
72*38e8c45fSAndroid Build Coastguard Worker #define LIBBINDER_IGNORE_END() LIBBINDER_PRAGMA_FOR_COMPILER(diagnostic pop)
73*38e8c45fSAndroid Build Coastguard Worker 
74*38e8c45fSAndroid Build Coastguard Worker namespace android {
75*38e8c45fSAndroid Build Coastguard Worker 
76*38e8c45fSAndroid Build Coastguard Worker /**
77*38e8c45fSAndroid Build Coastguard Worker  * Get the size of a statically initialized array.
78*38e8c45fSAndroid Build Coastguard Worker  *
79*38e8c45fSAndroid Build Coastguard Worker  * \param N the array to get the size of.
80*38e8c45fSAndroid Build Coastguard Worker  * \return the size of the array.
81*38e8c45fSAndroid Build Coastguard Worker  */
82*38e8c45fSAndroid Build Coastguard Worker template <typename T, size_t N>
countof(T (&)[N])83*38e8c45fSAndroid Build Coastguard Worker constexpr size_t countof(T (&)[N]) {
84*38e8c45fSAndroid Build Coastguard Worker     return N;
85*38e8c45fSAndroid Build Coastguard Worker }
86*38e8c45fSAndroid Build Coastguard Worker 
87*38e8c45fSAndroid Build Coastguard Worker // avoid optimizations
88*38e8c45fSAndroid Build Coastguard Worker void zeroMemory(uint8_t* data, size_t size);
89*38e8c45fSAndroid Build Coastguard Worker 
90*38e8c45fSAndroid Build Coastguard Worker // View of contiguous sequence. Similar to std::span.
91*38e8c45fSAndroid Build Coastguard Worker template <typename T>
92*38e8c45fSAndroid Build Coastguard Worker struct Span {
93*38e8c45fSAndroid Build Coastguard Worker     T* data = nullptr;
94*38e8c45fSAndroid Build Coastguard Worker     size_t size = 0;
95*38e8c45fSAndroid Build Coastguard Worker 
byteSizeSpan96*38e8c45fSAndroid Build Coastguard Worker     size_t byteSize() { return size * sizeof(T); }
97*38e8c45fSAndroid Build Coastguard Worker 
toIovecSpan98*38e8c45fSAndroid Build Coastguard Worker     iovec toIovec() { return {const_cast<std::remove_const_t<T>*>(data), byteSize()}; }
99*38e8c45fSAndroid Build Coastguard Worker 
100*38e8c45fSAndroid Build Coastguard Worker     // Truncates `this` to a length of `offset` and returns a span with the
101*38e8c45fSAndroid Build Coastguard Worker     // remainder.
102*38e8c45fSAndroid Build Coastguard Worker     //
103*38e8c45fSAndroid Build Coastguard Worker     // `std::nullopt` iff offset > size.
splitOffSpan104*38e8c45fSAndroid Build Coastguard Worker     std::optional<Span<T>> splitOff(size_t offset) {
105*38e8c45fSAndroid Build Coastguard Worker         if (offset > size) {
106*38e8c45fSAndroid Build Coastguard Worker             return std::nullopt;
107*38e8c45fSAndroid Build Coastguard Worker         }
108*38e8c45fSAndroid Build Coastguard Worker         Span<T> rest = {data + offset, size - offset};
109*38e8c45fSAndroid Build Coastguard Worker         size = offset;
110*38e8c45fSAndroid Build Coastguard Worker         return rest;
111*38e8c45fSAndroid Build Coastguard Worker     }
112*38e8c45fSAndroid Build Coastguard Worker 
113*38e8c45fSAndroid Build Coastguard Worker     // Returns nullopt if the byte size of `this` isn't evenly divisible by sizeof(U).
114*38e8c45fSAndroid Build Coastguard Worker     template <typename U>
reinterpretSpan115*38e8c45fSAndroid Build Coastguard Worker     std::optional<Span<U>> reinterpret() const {
116*38e8c45fSAndroid Build Coastguard Worker         // Only allow casting from bytes for simplicity.
117*38e8c45fSAndroid Build Coastguard Worker         static_assert(std::is_same_v<std::remove_const_t<T>, uint8_t>);
118*38e8c45fSAndroid Build Coastguard Worker         if (size % sizeof(U) != 0) {
119*38e8c45fSAndroid Build Coastguard Worker             return std::nullopt;
120*38e8c45fSAndroid Build Coastguard Worker         }
121*38e8c45fSAndroid Build Coastguard Worker         return Span<U>{reinterpret_cast<U*>(data), size / sizeof(U)};
122*38e8c45fSAndroid Build Coastguard Worker     }
123*38e8c45fSAndroid Build Coastguard Worker };
124*38e8c45fSAndroid Build Coastguard Worker 
125*38e8c45fSAndroid Build Coastguard Worker // Converts binary data into a hexString.
126*38e8c45fSAndroid Build Coastguard Worker //
127*38e8c45fSAndroid Build Coastguard Worker // Hex values are printed in order, e.g. 0xDEAD will result in 'adde' because
128*38e8c45fSAndroid Build Coastguard Worker // Android is little-endian.
129*38e8c45fSAndroid Build Coastguard Worker LIBBINDER_INTERNAL_EXPORTED std::string HexString(const void* bytes, size_t len);
130*38e8c45fSAndroid Build Coastguard Worker 
131*38e8c45fSAndroid Build Coastguard Worker // Converts any std::chrono duration to the number of milliseconds
132*38e8c45fSAndroid Build Coastguard Worker template <class Rep, class Period>
to_ms(std::chrono::duration<Rep,Period> duration)133*38e8c45fSAndroid Build Coastguard Worker uint64_t to_ms(std::chrono::duration<Rep, Period> duration) {
134*38e8c45fSAndroid Build Coastguard Worker     return std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
135*38e8c45fSAndroid Build Coastguard Worker }
136*38e8c45fSAndroid Build Coastguard Worker 
137*38e8c45fSAndroid Build Coastguard Worker }   // namespace android
138