1 /*
2 * Copyright (C) 2015 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 #include <binder/Status.h>
18
19 namespace android {
20 namespace binder {
21
ok()22 Status Status::ok() {
23 return Status();
24 }
25
fromExceptionCode(int32_t exceptionCode)26 Status Status::fromExceptionCode(int32_t exceptionCode) {
27 if (exceptionCode == EX_TRANSACTION_FAILED) {
28 return Status(exceptionCode, FAILED_TRANSACTION);
29 }
30 return Status(exceptionCode, OK);
31 }
32
fromExceptionCode(int32_t exceptionCode,const String8 & message)33 Status Status::fromExceptionCode(int32_t exceptionCode,
34 const String8& message) {
35 if (exceptionCode == EX_TRANSACTION_FAILED) {
36 return Status(exceptionCode, FAILED_TRANSACTION, message);
37 }
38 return Status(exceptionCode, OK, message);
39 }
40
fromExceptionCode(int32_t exceptionCode,const char * message)41 Status Status::fromExceptionCode(int32_t exceptionCode,
42 const char* message) {
43 return fromExceptionCode(exceptionCode, String8(message));
44 }
45
fromServiceSpecificError(int32_t serviceSpecificErrorCode)46 Status Status::fromServiceSpecificError(int32_t serviceSpecificErrorCode) {
47 return Status(EX_SERVICE_SPECIFIC, serviceSpecificErrorCode);
48 }
49
fromServiceSpecificError(int32_t serviceSpecificErrorCode,const String8 & message)50 Status Status::fromServiceSpecificError(int32_t serviceSpecificErrorCode,
51 const String8& message) {
52 return Status(EX_SERVICE_SPECIFIC, serviceSpecificErrorCode, message);
53 }
54
fromServiceSpecificError(int32_t serviceSpecificErrorCode,const char * message)55 Status Status::fromServiceSpecificError(int32_t serviceSpecificErrorCode,
56 const char* message) {
57 return fromServiceSpecificError(serviceSpecificErrorCode, String8(message));
58 }
59
fromStatusT(status_t status)60 Status Status::fromStatusT(status_t status) {
61 Status ret;
62 ret.setFromStatusT(status);
63 return ret;
64 }
65
exceptionToString(int32_t exceptionCode)66 std::string Status::exceptionToString(int32_t exceptionCode) {
67 switch (exceptionCode) {
68 #define EXCEPTION_TO_CASE(EXCEPTION) case EXCEPTION: return #EXCEPTION;
69 EXCEPTION_TO_CASE(EX_NONE)
70 EXCEPTION_TO_CASE(EX_SECURITY)
71 EXCEPTION_TO_CASE(EX_BAD_PARCELABLE)
72 EXCEPTION_TO_CASE(EX_ILLEGAL_ARGUMENT)
73 EXCEPTION_TO_CASE(EX_NULL_POINTER)
74 EXCEPTION_TO_CASE(EX_ILLEGAL_STATE)
75 EXCEPTION_TO_CASE(EX_NETWORK_MAIN_THREAD)
76 EXCEPTION_TO_CASE(EX_UNSUPPORTED_OPERATION)
77 EXCEPTION_TO_CASE(EX_SERVICE_SPECIFIC)
78 EXCEPTION_TO_CASE(EX_PARCELABLE)
79 EXCEPTION_TO_CASE(EX_HAS_REPLY_HEADER)
80 EXCEPTION_TO_CASE(EX_TRANSACTION_FAILED)
81 #undef EXCEPTION_TO_CASE
82 default: return std::to_string(exceptionCode);
83 }
84 }
85
Status(int32_t exceptionCode,int32_t errorCode)86 Status::Status(int32_t exceptionCode, int32_t errorCode)
87 : mException(exceptionCode),
88 mErrorCode(errorCode) {}
89
Status(int32_t exceptionCode,int32_t errorCode,const String8 & message)90 Status::Status(int32_t exceptionCode, int32_t errorCode, const String8& message)
91 : mException(exceptionCode),
92 mErrorCode(errorCode),
93 mMessage(message) {}
94
readFromParcel(const Parcel & parcel)95 status_t Status::readFromParcel(const Parcel& parcel) {
96 status_t status = parcel.readInt32(&mException);
97 if (status != OK) {
98 setFromStatusT(status);
99 return status;
100 }
101
102 if (mException == EX_HAS_NOTED_APPOPS_REPLY_HEADER) {
103 status = skipUnusedHeader(parcel);
104 if (status != OK) {
105 setFromStatusT(status);
106 return status;
107 }
108 // Read next exception code.
109 status = parcel.readInt32(&mException);
110 if (status != OK) {
111 setFromStatusT(status);
112 return status;
113 }
114 }
115
116 // Skip over fat response headers. Not used (or propagated) in native code.
117 if (mException == EX_HAS_REPLY_HEADER) {
118 status = skipUnusedHeader(parcel);
119 if (status != OK) {
120 setFromStatusT(status);
121 return status;
122 }
123
124 // And fat response headers are currently only used when there are no
125 // exceptions, so act like there was no error.
126 mException = EX_NONE;
127 }
128
129 if (mException == EX_NONE) {
130 return status;
131 }
132
133 // The remote threw an exception. Get the message back.
134 std::optional<String16> message;
135 status = parcel.readString16(&message);
136 if (status != OK) {
137 setFromStatusT(status);
138 return status;
139 }
140 mMessage = String8(message.value_or(String16()));
141
142 // Skip over the remote stack trace data
143 const size_t remote_start = parcel.dataPosition();
144 // Get available size before reading more
145 const size_t remote_avail = parcel.dataAvail();
146 int32_t remote_stack_trace_header_size;
147 status = parcel.readInt32(&remote_stack_trace_header_size);
148 if (status != OK) {
149 setFromStatusT(status);
150 return status;
151 }
152 if (remote_stack_trace_header_size < 0 ||
153 static_cast<size_t>(remote_stack_trace_header_size) > remote_avail) {
154
155 android_errorWriteLog(0x534e4554, "132650049");
156 setFromStatusT(UNKNOWN_ERROR);
157 return UNKNOWN_ERROR;
158 }
159
160 if (remote_stack_trace_header_size != 0) {
161 parcel.setDataPosition(remote_start + remote_stack_trace_header_size);
162 }
163
164 if (mException == EX_SERVICE_SPECIFIC) {
165 status = parcel.readInt32(&mErrorCode);
166 } else if (mException == EX_PARCELABLE) {
167 // Skip over the blob of Parcelable data
168 const size_t header_start = parcel.dataPosition();
169 // Get available size before reading more
170 const size_t header_avail = parcel.dataAvail();
171
172 int32_t header_size;
173 status = parcel.readInt32(&header_size);
174 if (status != OK) {
175 setFromStatusT(status);
176 return status;
177 }
178
179 if (header_size < 0 || static_cast<size_t>(header_size) > header_avail) {
180 android_errorWriteLog(0x534e4554, "132650049");
181 setFromStatusT(UNKNOWN_ERROR);
182 return UNKNOWN_ERROR;
183 }
184
185 parcel.setDataPosition(header_start + header_size);
186 }
187 if (status != OK) {
188 setFromStatusT(status);
189 return status;
190 }
191
192 return status;
193 }
194
writeToParcel(Parcel * parcel) const195 status_t Status::writeToParcel(Parcel* parcel) const {
196 // Something really bad has happened, and we're not going to even
197 // try returning rich error data.
198 if (mException == EX_TRANSACTION_FAILED) {
199 return mErrorCode;
200 }
201
202 status_t status = parcel->writeInt32(mException);
203 if (status != OK) return status;
204 if (mException == EX_NONE) {
205 // We have no more information to write.
206 return status;
207 }
208 status = parcel->writeString16(String16(mMessage));
209 if (status != OK) return status;
210 status = parcel->writeInt32(0); // Empty remote stack trace header
211 if (status != OK) return status;
212 if (mException == EX_SERVICE_SPECIFIC) {
213 status = parcel->writeInt32(mErrorCode);
214 } else if (mException == EX_PARCELABLE) {
215 // Sending Parcelable blobs currently not supported
216 status = parcel->writeInt32(0);
217 }
218 return status;
219 }
220
writeOverParcel(Parcel * parcel) const221 status_t Status::writeOverParcel(Parcel* parcel) const {
222 parcel->setDataSize(0);
223 parcel->setDataPosition(0);
224 return writeToParcel(parcel);
225 }
226
setException(int32_t ex,const String8 & message)227 void Status::setException(int32_t ex, const String8& message) {
228 mException = ex;
229 mErrorCode = ex == EX_TRANSACTION_FAILED ? FAILED_TRANSACTION : NO_ERROR;
230 mMessage.setTo(message);
231 }
232
setServiceSpecificError(int32_t errorCode,const String8 & message)233 void Status::setServiceSpecificError(int32_t errorCode, const String8& message) {
234 setException(EX_SERVICE_SPECIFIC, message);
235 mErrorCode = errorCode;
236 }
237
setFromStatusT(status_t status)238 void Status::setFromStatusT(status_t status) {
239 mException = (status == NO_ERROR) ? EX_NONE : EX_TRANSACTION_FAILED;
240 mErrorCode = status;
241 mMessage.clear();
242 }
243
toString8() const244 String8 Status::toString8() const {
245 String8 ret;
246 if (mException == EX_NONE) {
247 ret.append("No error");
248 } else {
249 ret.appendFormat("Status(%d, %s): '", mException, exceptionToString(mException).c_str());
250 if (mException == EX_SERVICE_SPECIFIC) {
251 ret.appendFormat("%d: ", mErrorCode);
252 } else if (mException == EX_TRANSACTION_FAILED) {
253 ret.appendFormat("%s: ", statusToString(mErrorCode).c_str());
254 }
255 ret.append(String8(mMessage));
256 ret.append("'");
257 }
258 return ret;
259 }
260
skipUnusedHeader(const Parcel & parcel)261 status_t Status::skipUnusedHeader(const Parcel& parcel) {
262 // Note that the header size includes the 4 byte size field.
263 const size_t header_start = parcel.dataPosition();
264 // Get available size before reading more
265 const size_t header_avail = parcel.dataAvail();
266
267 int32_t header_size;
268 status_t status = parcel.readInt32(&header_size);
269 ALOGD("Skip unused header. exception code: %d, start: %zu, size: %d.",
270 mException, header_start, header_size);
271 if (status != OK) {
272 return status;
273 }
274
275 if (header_size < 0 || static_cast<size_t>(header_size) > header_avail) {
276 android_errorWriteLog(0x534e4554, "132650049");
277 return UNKNOWN_ERROR;
278 }
279
280 parcel.setDataPosition(header_start + header_size);
281 return OK;
282 }
283
284 } // namespace binder
285 } // namespace android
286