src/include/utils/error.h

   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  */
  27
  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  */
  36
  37 #ifndef SDB_UTILS_ERROR_H
  38 #define SDB_UTILS_ERROR_H 1
  39
  40 #include <stddef.h>
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 /* max length of any error message */
  47 #ifndef SDB_MAX_ERROR
  48 #       define SDB_MAX_ERROR 4096
  49 #endif /* ! SDB_MAX_ERROR */
  50
  51 /* On Linux systems and possibly others, this should be the same as the LOG_
  52  * constants defined by syslog. */
  53 enum {
  54         SDB_LOG_EMERG   = 0,
  55         SDB_LOG_ERR     = 3,
  56         SDB_LOG_WARNING = 4,
  57         SDB_LOG_NOTICE  = 5,
  58         SDB_LOG_INFO    = 6,
  59         SDB_LOG_DEBUG   = 7,
  60 };
  61 #define SDB_LOG_PRIO_TO_STRING(prio) \
  62         (((prio) == SDB_LOG_EMERG) ? "EMERG" \
  63                 : ((prio) == SDB_LOG_ERR) ? "ERROR" \
  64                 : ((prio) == SDB_LOG_WARNING) ? "WARNING" \
  65                 : ((prio) == SDB_LOG_NOTICE) ? "NOTICE" \
  66                 : ((prio) == SDB_LOG_INFO) ? "INFO" \
  67                 : ((prio) == SDB_LOG_DEBUG) ? "DEBUG" : "UNKNOWN")
  68
  69 /*
  70  * sdb_error_set_logger:
  71  * Set the logging callback to be used for logging messages. By default (or
  72  * when explicitely setting the logger to NULL), logs will be written to the
  73  * stderr channel.
  74  */
  75 void
  76 sdb_error_set_logger(int (*f)(int, const char *));
  77
  78 /*
  79  * sdb_log:
  80  * Log the specified message. The string will be formatted in printf-style
  81  * using the specified format and arguments and logged with the specified
  82  * priority. In addition, the error message will be stored as the current
  83  * error message. This function is basically the same as calling sdb_error_set
  84  * and sdb_error_log. XXX: SDB_LOG_EMERG might, at some point and/or depending
  85  * on configuration, try a clean shut-down of the process.
  86  */
  87 int
  88 sdb_log(int prio, const char *fmt, ...);
  89
  90 /*
  91  * sdb_error_set, sdb_error_append:
  92  * Compose the current error message. The string will be formatted in printf-
  93  * style using the specified format and arguments. No automatic logging will
  94  * be done.
  95  */
  96 int
  97 sdb_error_set(const char *fmt, ...);
  98 int
  99 sdb_error_append(const char *fmt, ...);
 100
 101 /*
 102  * sdb_error_chomp:
 103  * Remove all consecutive newline characters at the end of the error message.
 104  */
 105 int
 106 sdb_error_chomp(void);
 107
 108 /*
 109  * sdb_error_log:
 110  * Log the current error message with the specified priority. See sdb_log for
 111  * more information.
 112  */
 113 int
 114 sdb_error_log(int prio);
 115
 116 /*
 117  * sdb_error_get:
 118  * Get the current error message. The string returned by this function is
 119  * owned by SysDB and might point to static memory -- do not modify or free
 120  * it.
 121  */
 122 const char *
 123 sdb_error_get(void);
 124
 125 /*
 126  * sdb_error_get_prio:
 127  * Get the priority of the last logged error message -- see the SDB_LOG_
 128  * constants for details.
 129  */
 130 int
 131 sdb_error_get_prio(void);
 132
 133 /*
 134  * sdb_strerror:
 135  * This is a wrapper around the system's strerror function which ensures that
 136  * a pointer to the formatted error message is returned.
 137  */
 138 char *
 139 sdb_strerror(int errnum, char *strerrbuf, size_t buflen);
 140
 141 #ifdef __cplusplus
 142 } /* extern "C" */
 143 #endif
 144
 145 #endif /* ! SDB_UTILS_ERROR_H */
 146
 147 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 148