1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
/*
* Copyright (C) 2015 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#define LOG_TAG "HidlStatus"
#include <android-base/logging.h>
#include <hidl/Status.h>
#include <utils/CallStack.h>
#include <unordered_map>
namespace android {
namespace hardware {
static std::string statusToString(status_t s) {
const std::unordered_map<status_t, std::string> statusStrings{{
#define STATUS_TO_STRING_PAIR(STATUS) {STATUS, #STATUS}
STATUS_TO_STRING_PAIR(OK),
STATUS_TO_STRING_PAIR(UNKNOWN_ERROR),
STATUS_TO_STRING_PAIR(NO_MEMORY),
STATUS_TO_STRING_PAIR(INVALID_OPERATION),
STATUS_TO_STRING_PAIR(BAD_VALUE),
STATUS_TO_STRING_PAIR(BAD_TYPE),
STATUS_TO_STRING_PAIR(NAME_NOT_FOUND),
STATUS_TO_STRING_PAIR(PERMISSION_DENIED),
STATUS_TO_STRING_PAIR(NO_INIT),
STATUS_TO_STRING_PAIR(ALREADY_EXISTS),
STATUS_TO_STRING_PAIR(DEAD_OBJECT),
STATUS_TO_STRING_PAIR(FAILED_TRANSACTION),
STATUS_TO_STRING_PAIR(BAD_INDEX),
STATUS_TO_STRING_PAIR(NOT_ENOUGH_DATA),
STATUS_TO_STRING_PAIR(WOULD_BLOCK),
STATUS_TO_STRING_PAIR(TIMED_OUT),
STATUS_TO_STRING_PAIR(UNKNOWN_TRANSACTION),
STATUS_TO_STRING_PAIR(FDS_NOT_ALLOWED),
STATUS_TO_STRING_PAIR(UNEXPECTED_NULL)
}};
auto it = statusStrings.find(s);
if (it != statusStrings.end()) {
return it->second;
}
std::string str = std::to_string(s);
char *err = strerror(-s);
if (err != nullptr) {
str.append(1, ' ').append(err);
}
return str;
}
static std::string exceptionToString(int32_t ex) {
const std::unordered_map<int32_t, std::string> exceptionStrings{{
#define EXCEPTION_TO_STRING_PAIR(EXCEPTION) {Status::Exception::EXCEPTION, #EXCEPTION}
EXCEPTION_TO_STRING_PAIR(EX_NONE),
EXCEPTION_TO_STRING_PAIR(EX_SECURITY),
EXCEPTION_TO_STRING_PAIR(EX_BAD_PARCELABLE),
EXCEPTION_TO_STRING_PAIR(EX_ILLEGAL_ARGUMENT),
EXCEPTION_TO_STRING_PAIR(EX_NULL_POINTER),
EXCEPTION_TO_STRING_PAIR(EX_ILLEGAL_STATE),
EXCEPTION_TO_STRING_PAIR(EX_NETWORK_MAIN_THREAD),
EXCEPTION_TO_STRING_PAIR(EX_UNSUPPORTED_OPERATION),
EXCEPTION_TO_STRING_PAIR(EX_HAS_REPLY_HEADER),
EXCEPTION_TO_STRING_PAIR(EX_TRANSACTION_FAILED)
}};
auto it = exceptionStrings.find(ex);
return it == exceptionStrings.end() ? std::to_string(ex) : it->second;
}
Status Status::ok() {
return Status();
}
Status Status::fromExceptionCode(int32_t exceptionCode) {
if (exceptionCode == EX_TRANSACTION_FAILED) {
return Status(exceptionCode, FAILED_TRANSACTION);
}
return Status(exceptionCode, OK);
}
Status Status::fromExceptionCode(int32_t exceptionCode,
const char *message) {
if (exceptionCode == EX_TRANSACTION_FAILED) {
return Status(exceptionCode, FAILED_TRANSACTION, message);
}
return Status(exceptionCode, OK, message);
}
Status Status::fromStatusT(status_t status) {
Status ret;
ret.setFromStatusT(status);
return ret;
}
Status::Status(int32_t exceptionCode, int32_t errorCode)
: mException(exceptionCode),
mErrorCode(errorCode) {}
Status::Status(int32_t exceptionCode, int32_t errorCode, const char *message)
: mException(exceptionCode),
mErrorCode(errorCode),
mMessage(message) {}
void Status::setException(int32_t ex, const char *message) {
mException = ex;
mErrorCode = ex == EX_TRANSACTION_FAILED ? FAILED_TRANSACTION : NO_ERROR;
mMessage = message;
}
void Status::setFromStatusT(status_t status) {
mException = (status == NO_ERROR) ? EX_NONE : EX_TRANSACTION_FAILED;
mErrorCode = status;
mMessage.clear();
}
std::string Status::description() const {
std::ostringstream oss;
oss << (*this);
return oss.str();
}
std::ostream& operator<< (std::ostream& stream, const Status& s) {
if (s.exceptionCode() == Status::EX_NONE) {
stream << "No error";
} else {
stream << "Status(" << exceptionToString(s.exceptionCode()) << "): '";
if (s.exceptionCode() == Status::EX_TRANSACTION_FAILED) {
stream << statusToString(s.transactionError()) << ": ";
}
stream << s.exceptionMessage() << "'";
}
return stream;
}
static HidlReturnRestriction gReturnRestriction = HidlReturnRestriction::NONE;
void setProcessHidlReturnRestriction(HidlReturnRestriction restriction) {
gReturnRestriction = restriction;
}
namespace details {
void return_status::onValueRetrieval() const {
if (!isOk()) {
LOG(FATAL) << "Attempted to retrieve value from failed HIDL call: " << description();
}
}
void return_status::assertOk() const {
if (!isOk()) {
LOG(FATAL) << "Failed HIDL return status not checked. Usually this happens because of "
"a transport error (error parceling, binder driver, or from unparceling)"
". If you see this in code calling into \"Bn\" classes in for a HAL "
"server process, then it is likely that the code there is returning "
"transport errors there (as opposed to errors defined within its "
"protocol). Error is: " << description();
}
}
return_status::~return_status() {
// mCheckedStatus must be checked before isOk since isOk modifies mCheckedStatus
if (mCheckedStatus) return;
assertOk();
if (gReturnRestriction == HidlReturnRestriction::NONE) {
return;
}
if (gReturnRestriction == HidlReturnRestriction::ERROR_IF_UNCHECKED) {
LOG(ERROR) << "Failed to check status of HIDL Return.";
CallStack::logStack("unchecked HIDL return", CallStack::getCurrent(10).get(), ANDROID_LOG_ERROR);
} else {
LOG(FATAL) << "Failed to check status of HIDL Return.";
}
}
return_status& return_status::operator=(return_status&& other) noexcept {
if (!mCheckedStatus) {
assertOk();
}
std::swap(mStatus, other.mStatus);
std::swap(mCheckedStatus, other.mCheckedStatus);
return *this;
}
} // namespace details
} // namespace hardware
} // namespace android
|
