compute_user_summary does not need any private data.
[adu.git] / error.h
1 /**
2 * This bit indicates whether a number is considered a system error code.
3 * If yes, the system errno is just the result of clearing this bit from
4 * the given number.
5 */
6 #define SYSTEM_ERROR_BIT 30
7
8 /** Check whether the system error bit is set. */
9 #define IS_SYSTEM_ERROR(num) (!!((num) & (1 << SYSTEM_ERROR_BIT)))
10
11 /** Set the system error bit for the given number. */
12 #define ERRNO_TO_ERROR(num) ((num) | (1 << SYSTEM_ERROR_BIT))
13
14 #define ALL_ERRORS \
15 _ERROR(SUCCESS, "success") \
16 _ERROR(SYNTAX, "syntax error") \
17 _ERROR(LOOP_COMPLETE, "loop complete") \
18 _ERROR(HASH_TABLE_OVERFLOW, "hash table too small") \
19 _ERROR(BAD_UID, "uid not found in hash table") \
20 _ERROR(ATOI_OVERFLOW, "value too large") \
21 _ERROR(STRTOLL, "unknown strtoll error") \
22 _ERROR(ATOI_NO_DIGITS, "no digits found in string") \
23 _ERROR(ATOI_JUNK_AT_END, "further characters after number") \
24 _ERROR(EMPTY, "file empty") \
25 _ERROR(MMAP, "mmap error") \
26 _ERROR(OSL, "osl error") \
27 _ERROR(SIGNAL_SIG_ERR, "signal() returned SIG_ERR") \
28 _ERROR(OUTPUT, "error writing output") \
29 _ERROR(MALFORMED_FORMAT, "malformed format string") \
30 _ERROR(BAD_ALIGN_SPEC, "bad alignment specifier") \
31 _ERROR(TRAILING_GARBAGE, "trailing garbage after specifier") \
32 _ERROR(UNIT, "no unit allowed here") \
33 _ERROR(BAD_UNIT, "invalid unit specifier") \
34 _ERROR(BAD_ATOM, "invalid atom") \
35 _ERROR(BAD_OUTPUT_ARG, "invalid name for output") \
36
37
38 /**
39 * This is temporarily defined to expand to its first argument (prefixed by
40 * 'E_') and gets later redefined to expand to the error text only
41 */
42 #define _ERROR(err, msg) E_ ## err,
43
44 enum error_codes {
45 ALL_ERRORS
46 };
47 #undef _ERROR
48 #define _ERROR(err, msg) msg,
49 #define DEFINE_ERRLIST char *adu_errlist[] = {ALL_ERRORS}
50
51 extern int osl_errno;
52 extern char *adu_errlist[];
53
54
55 /**
56 * adu's version of strerror(3).
57 *
58 * \param num The error number.
59 *
60 * \return The error text of \a num.
61 */
62 static inline const char *adu_strerror(int num)
63 {
64 assert(num > 0);
65 if (num == E_OSL) {
66 assert(osl_errno > 0);
67 return osl_strerror((osl_errno));
68 }
69 if (IS_SYSTEM_ERROR(num))
70 return strerror((num) & ((1 << SYSTEM_ERROR_BIT) - 1));
71 return adu_errlist[num];
72 }
73
74 /**
75 * Wrapper for osl library calls.
76 *
77 * This should be used for all calls to osl functions that return an osl error
78 * code. It changes the return value to \p -E_OSL appropriately so that it can
79 * be used for printing the correct error message.
80 *
81 * \return \a ret if \a ret >= 0, \p -E_OSL otherwise.
82 */
83 static inline int osl(int ret)
84 {
85 if (ret >= 0)
86 return ret;
87 osl_errno = -ret;
88 return -E_OSL;
89 }