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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
|
/*
* Copyright (c) 2016-2019, 2021, 2023 Arm Limited.
*
* SPDX-License-Identifier: MIT
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#ifndef ARM_COMPUTE_ERROR_H
#define ARM_COMPUTE_ERROR_H
#include <array>
#include <string>
namespace arm_compute
{
/** Ignores unused arguments
*
* @tparam T Argument types
*
* @param[in] ... Ignored arguments
*/
template <typename... T>
inline void ignore_unused(T &&...)
{
}
/** Available error codes */
enum class ErrorCode
{
OK, /**< No error */
RUNTIME_ERROR, /**< Generic runtime error */
UNSUPPORTED_EXTENSION_USE /**< Unsupported extension used*/
};
/** Status class */
class Status
{
public:
/** Default Constructor **/
Status() : _code(ErrorCode::OK), _error_description(" ")
{
}
/** Default Constructor
*
* @param error_status Error status.
* @param error_description (Optional) Error description if error_status is not valid.
*/
explicit Status(ErrorCode error_status, std::string error_description = " ")
: _code(error_status), _error_description(error_description)
{
}
/** Allow instances of this class to be copy constructed */
Status(const Status &) = default;
/** Allow instances of this class to be move constructed */
Status(Status &&) = default;
/** Allow instances of this class to be copy assigned */
Status &operator=(const Status &) = default;
/** Allow instances of this class to be move assigned */
Status &operator=(Status &&) = default;
/** Explicit bool conversion operator
*
* @return True if there is no error else false
*/
explicit operator bool() const noexcept
{
return _code == ErrorCode::OK;
}
/** Gets error code
*
* @return Error code.
*/
ErrorCode error_code() const
{
return _code;
}
/** Gets error description if any
*
* @return Error description.
*/
std::string error_description() const
{
return _error_description;
}
/** Throws a runtime exception in case it contains a valid error status */
void throw_if_error() const
{
if (!bool(*this))
{
internal_throw_on_error();
}
}
private:
/** Internal throwing function */
[[noreturn]] void internal_throw_on_error() const;
private:
ErrorCode _code;
std::string _error_description;
};
/** Creates an error containing the error message
*
* @param[in] error_code Error code
* @param[in] msg Message to display before abandoning.
*
* @return status containing the error
*/
Status create_error(ErrorCode error_code, std::string msg);
/** Creates an error and the error message
*
* @param[in] error_code Error code
* @param[in] func Function in which the error occurred.
* @param[in] file File in which the error occurred.
* @param[in] line Line in which the error occurred.
* @param[in] msg Message to display before abandoning.
*
* @return status containing the error
*/
Status create_error_msg(ErrorCode error_code, const char *func, const char *file, int line, const char *msg);
/** Throw an std::runtime_error
*
* @param[in] err Error status
*/
[[noreturn]] void throw_error(Status err);
} // namespace arm_compute
/** To avoid unused variables warnings
*
* This is useful if for example a variable is only used
* in debug builds and generates a warning in release builds.
*
* @param[in] ... Variables which are unused.
*/
#define ARM_COMPUTE_UNUSED(...) ::arm_compute::ignore_unused(__VA_ARGS__) // NOLINT
/** Creates an error with a given message
*
* @param[in] error_code Error code.
* @param[in] msg Message to encapsulate.
*/
#define ARM_COMPUTE_CREATE_ERROR(error_code, msg) \
arm_compute::create_error_msg(error_code, __func__, __FILE__, __LINE__, msg)
/** Creates an error on location with a given message
*
* @param[in] error_code Error code.
* @param[in] func Function in which the error occurred.
* @param[in] file File in which the error occurred.
* @param[in] line Line in which the error occurred.
* @param[in] msg Message to display before abandoning.
*/
#define ARM_COMPUTE_CREATE_ERROR_LOC(error_code, func, file, line, msg) \
arm_compute::create_error_msg(error_code, func, file, line, msg)
/** Creates an error on location with a given message. Accepts a message format
* and a variable list of arguments matching the format description.
*
* @param[in] error_code Error code.
* @param[in] func Function in which the error occurred.
* @param[in] file File in which the error occurred.
* @param[in] line Line in which the error occurred.
* @param[in] msg Error description message format.
* @param[in] ... List of arguments matching the format description.
*/
#define ARM_COMPUTE_CREATE_ERROR_LOC_VAR(error_code, func, file, line, msg, ...) \
do \
{ \
std::array<char, 512> out{0}; \
int offset = snprintf(out.data(), out.size(), "in %s %s:%d: ", func, file, line); \
snprintf(out.data() + offset, out.size() - offset, msg, __VA_ARGS__); \
arm_compute::create_error(error_code, std::string(out.data())); \
} while (false)
/** An error is returned with the given description.
*
* @param[in] ... Error description message.
*/
#define ARM_COMPUTE_RETURN_ERROR_MSG(...) \
do \
{ \
return ARM_COMPUTE_CREATE_ERROR(arm_compute::ErrorCode::RUNTIME_ERROR, __VA_ARGS__); \
} while (false)
/** Checks if a status contains an error and returns it
*
* @param[in] status Status value to check
*/
#define ARM_COMPUTE_RETURN_ON_ERROR(status) \
do \
{ \
const auto s = status; \
if (!bool(s)) \
{ \
return s; \
} \
} while (false)
/** Checks if an error value is valid if not throws an exception with the error
*
* @param[in] error Error value to check.
*/
#define ARM_COMPUTE_THROW_ON_ERROR(error) error.throw_if_error();
/** If the condition is true, an error is returned. Accepts a message format
* and a variable list of arguments matching the format description.
*
* @param[in] cond Condition to evaluate.
* @param[in] msg Error description message format.
* @param[in] ... List of arguments matching the format description.
*/
#define ARM_COMPUTE_RETURN_ERROR_ON_MSG_VAR(cond, msg, ...) \
do \
{ \
if (cond) \
{ \
std::array<char, 512> out{0}; \
int offset = snprintf(out.data(), out.size(), "in %s %s:%d: ", __func__, __FILE__, __LINE__); \
snprintf(out.data() + offset, out.size() - offset, msg, __VA_ARGS__); \
return arm_compute::create_error(arm_compute::ErrorCode::RUNTIME_ERROR, std::string(out.data())); \
} \
} while (false)
/** If the condition is true, an error is returned
*
* @param[in] cond Condition to evaluate.
* @param[in] msg Error description message
*/
#define ARM_COMPUTE_RETURN_ERROR_ON_MSG(cond, msg) \
do \
{ \
if (cond) \
{ \
return arm_compute::create_error_msg(arm_compute::ErrorCode::RUNTIME_ERROR, __func__, __FILE__, __LINE__, \
msg); \
} \
} while (false)
/** If the condition is true, an error is thrown. Accepts a message format
* and a variable list of arguments matching the format description.
*
* @param[in] cond Condition to evaluate.
* @param[in] func Function in which the error occurred.
* @param[in] file File in which the error occurred.
* @param[in] line Line in which the error occurred.
* @param[in] msg Error description message format.
* @param[in] ... List of arguments matching the format description.
*/
#define ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG_VAR(cond, func, file, line, msg, ...) \
do \
{ \
if (cond) \
{ \
std::array<char, 512> out{0}; \
int offset = snprintf(out.data(), out.size(), "in %s %s:%d: ", func, file, line); \
snprintf(out.data() + offset, out.size() - offset, msg, __VA_ARGS__); \
return arm_compute::create_error(ErrorCode::RUNTIME_ERROR, std::string(out.data())); \
} \
} while (false)
/** If the condition is true, an error is thrown.
*
* @param[in] cond Condition to evaluate.
* @param[in] func Function in which the error occurred.
* @param[in] file File in which the error occurred.
* @param[in] line Line in which the error occurred.
* @param[in] msg Message to display.
*/
#define ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG(cond, func, file, line, msg) \
do \
{ \
if (cond) \
{ \
return arm_compute::create_error_msg(ErrorCode::RUNTIME_ERROR, func, file, line, msg); \
} \
} while (false)
/** If the condition is true, an error is returned
*
* @param[in] cond Condition to evaluate
*/
#define ARM_COMPUTE_RETURN_ERROR_ON(cond) ARM_COMPUTE_RETURN_ERROR_ON_MSG(cond, #cond)
/** If the condition is true, an error is returned
*
* @param[in] cond Condition to evaluate.
* @param[in] func Function in which the error occurred.
* @param[in] file File in which the error occurred.
* @param[in] line Line in which the error occurred.
*/
#define ARM_COMPUTE_RETURN_ERROR_ON_LOC(cond, func, file, line) \
ARM_COMPUTE_RETURN_ERROR_ON_LOC_MSG(cond, func, file, line, #cond)
/** Print the given message then throw an std::runtime_error.
*
* @param[in] func Function in which the error occurred.
* @param[in] file File in which the error occurred.
* @param[in] line Line in which the error occurred.
* @param[in] msg Message to display.
*/
#define ARM_COMPUTE_THROW_ERROR(func, file, line, msg) \
do \
{ \
arm_compute::throw_error( \
arm_compute::create_error_msg(arm_compute::ErrorCode::RUNTIME_ERROR, func, file, line, msg)); \
} while (false)
/** Print the given message then throw an std::runtime_error. Accepts a message format
* and a variable list of arguments matching the format description.
*
* @param[in] func Function in which the error occurred.
* @param[in] file File in which the error occurred.
* @param[in] line Line in which the error occurred.
* @param[in] msg Error description message format.
* @param[in] ... List of arguments matching the format description.
*/
#define ARM_COMPUTE_THROW_ERROR_VAR(func, file, line, msg, ...) \
do \
{ \
std::array<char, 512> out{0}; \
int offset = snprintf(out.data(), out.size(), "in %s %s:%d: ", func, file, line); \
snprintf(out.data() + offset, out.size() - offset, msg, __VA_ARGS__); \
arm_compute::throw_error(arm_compute::Status(arm_compute::ErrorCode::RUNTIME_ERROR, std::string(out.data()))); \
} while (false)
/** Print the given message then throw an std::runtime_error. Accepts a message format
* and a variable list of arguments matching the format description.
*
* @param[in] msg Error description message format.
* @param[in] ... List of arguments matching the format description.
*/
#define ARM_COMPUTE_ERROR_VAR(msg, ...) ARM_COMPUTE_THROW_ERROR_VAR(__func__, __FILE__, __LINE__, msg, __VA_ARGS__)
/** Print the given message then throw an std::runtime_error.
*
* @param[in] msg Message to display.
*/
#define ARM_COMPUTE_ERROR(msg) ARM_COMPUTE_THROW_ERROR(__func__, __FILE__, __LINE__, msg)
/** Print the given message then throw an std::runtime_error. Accepts a message format
* and a variable list of arguments matching the format description.
*
* @param[in] func Function in which the error occurred.
* @param[in] file File in which the error occurred.
* @param[in] line Line in which the error occurred.
* @param[in] msg Error description message format.
* @param[in] ... List of arguments matching the format description.
*/
#define ARM_COMPUTE_ERROR_LOC_VAR(func, file, line, msg, ...) \
ARM_COMPUTE_THROW_ERROR_VAR(func, file, line, msg, __VA_ARGS__) // NOLINT
/** Print the given message then throw an std::runtime_error.
*
* @param[in] func Function in which the error occurred.
* @param[in] file File in which the error occurred.
* @param[in] line Line in which the error occurred.
* @param[in] msg Message to display.
*/
#define ARM_COMPUTE_ERROR_LOC(func, file, line, msg) ARM_COMPUTE_THROW_ERROR(func, file, line, msg) // NOLINT
/** If the condition is true, the given message is printed and program exits
*
* @param[in] cond Condition to evaluate.
* @param[in] msg Message to display.
*/
#define ARM_COMPUTE_EXIT_ON_MSG(cond, msg) \
do \
{ \
if (cond) \
{ \
ARM_COMPUTE_ERROR(msg); \
} \
} while (false)
/** If the condition is true, the given message is printed and program exits. Accepts a message format
* and a variable list of arguments matching the format description.
*
* @param[in] cond Condition to evaluate.
* @param[in] msg Error description message format.
* @param[in] ... List of arguments matching the format description.
*/
#define ARM_COMPUTE_EXIT_ON_MSG_VAR(cond, msg, ...) \
do \
{ \
if (cond) \
{ \
ARM_COMPUTE_ERROR_VAR(msg, __VA_ARGS__); \
} \
} while (false)
#ifdef ARM_COMPUTE_ASSERTS_ENABLED
/** Checks if a status value is valid if not throws an exception with the error
*
* @param[in] status Status value to check.
*/
#define ARM_COMPUTE_ERROR_THROW_ON(status) status.throw_if_error()
/** If the condition is true, the given message is printed and an exception is thrown
*
* @param[in] cond Condition to evaluate.
* @param[in] msg Message to display.
*/
#define ARM_COMPUTE_ERROR_ON_MSG(cond, msg) ARM_COMPUTE_EXIT_ON_MSG(cond, msg)
/** If the condition is true, the given message is printed and an exception is thrown. Accepts a message format
* and a variable list of arguments matching the format description.
*
* @param[in] cond Condition to evaluate.
* @param[in] msg Error description message format.
* @param[in] ... List of arguments matching the format description.
*/
#define ARM_COMPUTE_ERROR_ON_MSG_VAR(cond, msg, ...) ARM_COMPUTE_EXIT_ON_MSG_VAR(cond, msg, __VA_ARGS__)
/** If the condition is true, the given message is printed and an exception is thrown.
*
* @param[in] cond Condition to evaluate.
* @param[in] func Function in which the error occurred.
* @param[in] file File in which the error occurred.
* @param[in] line Line in which the error occurred.
* @param[in] ... Message to print if cond is false.
*/
#define ARM_COMPUTE_ERROR_ON_LOC_MSG(cond, func, file, line, ...) \
do \
{ \
if (cond) \
{ \
ARM_COMPUTE_ERROR_LOC_VAR(func, file, line, __VA_ARGS__); \
} \
} while (false)
/** If the condition is true, the given message is printed and an exception is thrown, otherwise value is returned
*
* @param[in] cond Condition to evaluate.
* @param[in] val Value to be returned.
* @param[in] msg Message to print if cond is false.
*/
#define ARM_COMPUTE_CONST_ON_ERROR(cond, val, msg) (cond) ? throw std::logic_error(msg) : val;
#else /* ARM_COMPUTE_ASSERTS_ENABLED */
#define ARM_COMPUTE_ERROR_THROW_ON(status)
#define ARM_COMPUTE_ERROR_ON_MSG(cond, msg)
#define ARM_COMPUTE_ERROR_ON_MSG_VAR(cond, msg, ...)
#define ARM_COMPUTE_ERROR_ON_LOC_MSG(cond, func, file, line, ...)
#define ARM_COMPUTE_CONST_ON_ERROR(cond, val, msg) val
#endif /* ARM_COMPUTE_ASSERTS_ENABLED */
/** If the condition is true then an error message is printed and an exception thrown
*
* @param[in] cond Condition to evaluate.
*/
#define ARM_COMPUTE_ERROR_ON(cond) ARM_COMPUTE_ERROR_ON_MSG(cond, #cond)
/** If the condition is true then an error message is printed and an exception thrown
*
* @param[in] cond Condition to evaluate.
* @param[in] func Function in which the error occurred.
* @param[in] file File in which the error occurred.
* @param[in] line Line in which the error occurred.
*/
#define ARM_COMPUTE_ERROR_ON_LOC(cond, func, file, line) \
ARM_COMPUTE_ERROR_ON_LOC_MSG(cond, func, file, line, "%s", #cond)
#ifndef ARM_COMPUTE_EXCEPTIONS_DISABLED
#define ARM_COMPUTE_THROW(ex) throw(ex)
#else /* ARM_COMPUTE_EXCEPTIONS_DISABLED */
#define ARM_COMPUTE_THROW(ex) (ex), std::abort()
#endif /* ARM_COMPUTE_EXCEPTIONS_DISABLED */
#endif /* ARM_COMPUTE_ERROR_H */
|
