src/core/error.c

   1 /*
   2  * SysDB - src/core/error.c
   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 #include "core/error.h"
  29 #include "core/plugin.h"
  30 #include "utils/strbuf.h"
  31
  32 #include <pthread.h>
  33
  34 #include <stdarg.h>
  35 #include <stdio.h>
  36 #include <string.h>
  37
  38 #include <stdlib.h>
  39
  40 /*
  41  * private data types
  42  */
  43
  44 typedef struct {
  45         int   prio;
  46         sdb_strbuf_t *msg;
  47         _Bool logged;
  48 } sdb_error_ctx_t;
  49 #define SDB_ERROR_INIT { -1, NULL, 1 }
  50
  51 /*
  52  * private variables
  53  */
  54
  55 static sdb_error_ctx_t default_error_ctx = SDB_ERROR_INIT;
  56
  57 static pthread_key_t error_ctx_key;
  58 static _Bool         error_ctx_key_initialized = 0;
  59
  60 /*
  61  * private helper functions
  62  */
  63
  64 static void
  65 sdb_error_ctx_destructor(void *p)
  66 {
  67         sdb_error_ctx_t *ctx = p;
  68
  69         if (! ctx)
  70                 return;
  71
  72         sdb_strbuf_destroy(ctx->msg);
  73         free(ctx);
  74 } /* sdb_error_ctx_destructor */
  75
  76 static void
  77 sdb_error_ctx_init(void)
  78 {
  79         if (error_ctx_key_initialized)
  80                 return;
  81
  82         pthread_key_create(&error_ctx_key, sdb_error_ctx_destructor);
  83         error_ctx_key_initialized = 1;
  84 } /* sdb_error_init */
  85
  86 static sdb_error_ctx_t *
  87 sdb_error_ctx_create(void)
  88 {
  89         sdb_error_ctx_t *ctx;
  90
  91         ctx = malloc(sizeof(*ctx));
  92         if (! ctx)
  93                 return NULL;
  94
  95         *ctx = default_error_ctx;
  96         ctx->msg = sdb_strbuf_create(64);
  97         if (! ctx->msg) {
  98                 free(ctx);
  99                 return NULL;
 100         }
 101
 102         if (! error_ctx_key_initialized)
 103                 sdb_error_ctx_init();
 104         pthread_setspecific(error_ctx_key, ctx);
 105         return ctx;
 106 } /* sdb_error_ctx_create */
 107
 108 static sdb_error_ctx_t *
 109 sdb_error_get_ctx(void)
 110 {
 111         sdb_error_ctx_t *ctx;
 112
 113         if (! error_ctx_key_initialized)
 114                 sdb_error_ctx_init();
 115         ctx = pthread_getspecific(error_ctx_key);
 116
 117         if (! ctx)
 118                 ctx = sdb_error_ctx_create();
 119         if (! ctx)
 120                 return NULL;
 121         return ctx;
 122 } /* sdb_error_get_ctx */
 123
 124 static int
 125 sdb_error_vprintf(const char *fmt, va_list ap)
 126 {
 127         sdb_error_ctx_t *ctx;
 128
 129         ctx = sdb_error_get_ctx();
 130         if (! ctx)
 131                 return -1;
 132
 133         ctx->logged = 0;
 134         return (int)sdb_strbuf_vsprintf(ctx->msg, fmt, ap);
 135 } /* sdb_error_vprintf */
 136
 137 static int
 138 sdb_error_vappend(const char *fmt, va_list ap)
 139 {
 140         sdb_error_ctx_t *ctx;
 141
 142         ctx = sdb_error_get_ctx();
 143         if (! ctx)
 144                 return -1;
 145
 146         ctx->logged = 0;
 147         return (int)sdb_strbuf_vappend(ctx->msg, fmt, ap);
 148 } /* sdb_error_vappend */
 149
 150 static int
 151 sdb_do_log(int prio)
 152 {
 153         sdb_error_ctx_t *ctx;
 154         int ret;
 155
 156         ctx = sdb_error_get_ctx();
 157         if (! ctx)
 158                 return -1;
 159
 160         if (prio >= 0)
 161                 ctx->prio = prio;
 162
 163         if (ctx->logged)
 164                 return 0;
 165
 166         ret = sdb_plugin_log(prio, sdb_strbuf_string(ctx->msg));
 167         ctx->logged = 1;
 168         return ret;
 169 } /* sdb_do_log */
 170
 171 /*
 172  * public API
 173  */
 174
 175 int
 176 sdb_log(int prio, const char *fmt, ...)
 177 {
 178         va_list ap;
 179         int ret;
 180
 181         va_start(ap, fmt);
 182         ret = sdb_error_vprintf(fmt, ap);
 183         va_end(ap);
 184
 185         if (ret > 0)
 186                 sdb_do_log(prio);
 187         return ret;
 188 } /* sdb_log */
 189
 190 int
 191 sdb_error_set(const char *fmt, ...)
 192 {
 193         va_list ap;
 194         int ret;
 195
 196         va_start(ap, fmt);
 197         ret = sdb_error_vprintf(fmt, ap);
 198         va_end(ap);
 199
 200         return ret;
 201 } /* sdb_error_set */
 202
 203 int
 204 sdb_error_append(const char *fmt, ...)
 205 {
 206         va_list ap;
 207         int ret;
 208
 209         va_start(ap, fmt);
 210         ret = sdb_error_vappend(fmt, ap);
 211         va_end(ap);
 212
 213         return ret;
 214 } /* sdb_error_append */
 215
 216 int
 217 sdb_error_chomp(void)
 218 {
 219         sdb_error_ctx_t *ctx;
 220
 221         ctx = sdb_error_get_ctx();
 222         if (! ctx)
 223                 return -1;
 224
 225         sdb_strbuf_chomp(ctx->msg);
 226         return 0;
 227 } /* sdb_error_chomp */
 228
 229 int
 230 sdb_error_log(int prio)
 231 {
 232         return sdb_do_log(prio);
 233 } /* sdb_error_log */
 234
 235 const char *
 236 sdb_error_get(void)
 237 {
 238         sdb_error_ctx_t *ctx;
 239
 240         ctx = sdb_error_get_ctx();
 241         if (! ctx)
 242                 return "success";
 243         return sdb_strbuf_string(ctx->msg);
 244 } /* sdb_error_get */
 245
 246 int
 247 sdb_error_get_prio(void)
 248 {
 249         sdb_error_ctx_t *ctx;
 250
 251         ctx = sdb_error_get_ctx();
 252         if (! ctx)
 253                 return -1;
 254         return ctx->prio;
 255 } /* sdb_error_get_prio */
 256
 257 char *
 258 sdb_strerror(int errnum, char *strerrbuf, size_t buflen)
 259 {
 260 #if STRERROR_R_CHAR_P
 261         {
 262                 char *tmp = strerror_r(errnum, strerrbuf, buflen);
 263                 if (*strerrbuf = '\0') {
 264                         if (tmp && (tmp != strerrbuf) && (*tmp != '\0'))
 265                                 strncpy(strerrbuf, tmp, buflen);
 266                         else
 267                                 snprintf(strerrbuf, buflen, "unknown error #%i "
 268                                                 "(strerror_r(3) did not return an error message)",
 269                                                 errnum);
 270                 }
 271         }
 272 #else
 273         if (strerror_r(errnum, strerrbuf, buflen))
 274                 snprintf(strerrbuf, buflen, "unknown error #%i "
 275                                 "(strerror_r(3) failed)", errnum);
 276 #endif
 277
 278         strerrbuf[buflen - 1] = '\0';
 279         return strerrbuf;
 280 } /* sdb_strerror */
 281
 282 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 283