1 /*
2 * SysDB - src/include/utils/error.h
3 * Copyright (C) 2013 Sebastian 'tokkee' Harl <sh@tokkee.org>
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
19 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
28 /*
29 * SysDB error handling:
30 * Error handling in SysDB is done on a by-thread basis, that is, each thread
31 * will use its own memory region to store information about the last reported
32 * error.
33 * Once the error message has been passed to SysDB, it will log the entire
34 * message at once. The message will be sent to all registered log functions.
35 */
37 #ifndef SDB_UTILS_ERROR_H
38 #define SDB_UTILS_ERROR_H 1
40 #include <stddef.h>
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
46 /* On Linux systems and possibly others, this should be the same as the LOG_
47 * constants defined by syslog. */
48 enum {
49 SDB_LOG_EMERG = 0,
50 SDB_LOG_ERR = 3,
51 SDB_LOG_WARNING = 4,
52 SDB_LOG_NOTICE = 5,
53 SDB_LOG_INFO = 6,
54 SDB_LOG_DEBUG = 7,
55 };
56 #define SDB_LOG_PRIO_TO_STRING(prio) \
57 (((prio) == SDB_LOG_EMERG) ? "EMERG" \
58 : ((prio) == SDB_LOG_ERR) ? "ERROR" \
59 : ((prio) == SDB_LOG_WARNING) ? "WARNING" \
60 : ((prio) == SDB_LOG_NOTICE) ? "NOTICE" \
61 : ((prio) == SDB_LOG_INFO) ? "INFO" \
62 : ((prio) == SDB_LOG_DEBUG) ? "DEBUG" : "UNKNOWN")
64 /*
65 * sdb_error_set_logger:
66 * Set the logging callback to be used for logging messages. By default (or
67 * when explicitely setting the logger to NULL), logs will be written to the
68 * stderr channel.
69 */
70 void
71 sdb_error_set_logger(int (*f)(int, const char *));
73 /*
74 * sdb_log:
75 * Log the specified message. The string will be formatted in printf-style
76 * using the specified format and arguments and logged with the specified
77 * priority. In addition, the error message will be stored as the current
78 * error message. This function is basically the same as calling sdb_error_set
79 * and sdb_error_log. XXX: SDB_LOG_EMERG might, at some point and/or depending
80 * on configuration, try a clean shut-down of the process.
81 */
82 int
83 sdb_log(int prio, const char *fmt, ...);
85 /*
86 * sdb_error_set, sdb_error_append:
87 * Compose the current error message. The string will be formatted in printf-
88 * style using the specified format and arguments. No automatic logging will
89 * be done.
90 */
91 int
92 sdb_error_set(const char *fmt, ...);
93 int
94 sdb_error_append(const char *fmt, ...);
96 /*
97 * sdb_error_chomp:
98 * Remove all consecutive newline characters at the end of the error message.
99 */
100 int
101 sdb_error_chomp(void);
103 /*
104 * sdb_error_log:
105 * Log the current error message with the specified priority. See sdb_log for
106 * more information.
107 */
108 int
109 sdb_error_log(int prio);
111 /*
112 * sdb_error_get:
113 * Get the current error message. The string returned by this function is
114 * owned by SysDB and might point to static memory -- do not modify or free
115 * it.
116 */
117 const char *
118 sdb_error_get(void);
120 /*
121 * sdb_error_get_prio:
122 * Get the priority of the last logged error message -- see the SDB_LOG_
123 * constants for details.
124 */
125 int
126 sdb_error_get_prio(void);
128 /*
129 * sdb_strerror:
130 * This is a wrapper around the system's strerror function which ensures that
131 * a pointer to the formatted error message is returned.
132 */
133 char *
134 sdb_strerror(int errnum, char *strerrbuf, size_t buflen);
136 #ifdef __cplusplus
137 } /* extern "C" */
138 #endif
140 #endif /* ! SDB_UTILS_ERROR_H */
142 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */