Code

utils error: Added module for error reporting.
[sysdb.git] / src / utils / error.c
1 /*
2  * SysDB - src/utils/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  */
28 #include "utils/error.h"
30 #include <pthread.h>
32 #include <stdarg.h>
33 #include <stdio.h>
34 #include <string.h>
36 /*
37  * private data types
38  */
40 typedef struct {
41         int   prio;
42         char  msg[SDB_MAX_ERROR];
43         _Bool finalized;
44 } sdb_error_ctx_t;
45 #define SDB_ERROR_INIT { -1, "", 1 }
47 /*
48  * private variables
49  */
51 static sdb_error_ctx_t default_error_ctx = SDB_ERROR_INIT;
53 static pthread_key_t error_ctx_key;
54 static _Bool         error_ctx_key_initialized = 0;
56 /*
57  * private helper functions
58  */
60 static void
61 sdb_error_ctx_init(void)
62 {
63         if (error_ctx_key_initialized)
64                 return;
66         pthread_key_create(&error_ctx_key, NULL);
67         error_ctx_key_initialized = 1;
68 } /* sdb_error_init */
70 static sdb_error_ctx_t *
71 sdb_error_ctx_create(void)
72 {
73         sdb_error_ctx_t *ctx;
75         ctx = malloc(sizeof(*ctx));
76         if (! ctx)
77                 return NULL;
79         *ctx = default_error_ctx;
81         if (! error_ctx_key_initialized)
82                 sdb_error_ctx_init();
83         pthread_setspecific(error_ctx_key, ctx);
84         return ctx;
85 } /* sdb_error_ctx_create */
87 static sdb_error_ctx_t *
88 sdb_error_get_ctx(void)
89 {
90         sdb_error_ctx_t *ctx;
92         if (! error_ctx_key_initialized)
93                 sdb_error_ctx_init();
94         ctx = pthread_getspecific(error_ctx_key);
96         if (! ctx)
97                 ctx = sdb_error_ctx_create();
98         if (! ctx)
99                 return NULL;
100         return ctx;
101 } /* sdb_error_get_ctx */
103 static int
104 sdb_error_clear(void)
106         sdb_error_ctx_t *ctx;
108         ctx = sdb_error_get_ctx();
109         if (! ctx)
110                 return -1;
112         ctx->prio = -1;
113         ctx->msg[0] = '\0';
114         ctx->finalized = 1;
115         return 0;
116 } /* sdb_error_clear */
118 static int
119 sdb_error_vappend(int prio, const char *fmt, va_list ap)
121         sdb_error_ctx_t *ctx;
122         size_t len;
124         ctx = sdb_error_get_ctx();
125         if (! ctx)
126                 return -1;
128         len = strlen(ctx->msg);
129         if (len >= sizeof(ctx->msg))
130                 return 0; /* nothing written */
132         if (prio >= 0)
133                 ctx->prio = prio;
135         ctx->finalized = 0;
136         return vsnprintf(ctx->msg + len, sizeof(ctx->msg) - len, fmt, ap);
137 } /* sdb_error_vappend */
139 static int
140 sdb_error_log(void)
142         sdb_error_ctx_t *ctx;
143         int ret;
145         ctx = sdb_error_get_ctx();
146         if (! ctx)
147                 return -1;
149         if (ctx->finalized)
150                 return 0;
152         ret = fprintf(stderr, "[%s] %s\n",
153                         SDB_LOG_PRIO_TO_STRING(ctx->prio), ctx->msg);
154         ctx->finalized = 1;
155         return ret;
156 } /* sdb_error_log */
158 /*
159  * public API
160  */
162 int
163 sdb_error_set(int prio, const char *fmt, ...)
165         va_list ap;
166         int ret;
168         if (sdb_error_clear())
169                 return -1;
171         va_start(ap, fmt);
172         ret = sdb_error_vappend(prio, fmt, ap);
173         va_end(ap);
175         sdb_error_log();
176         return ret;
177 } /* sdb_error_set */
179 int
180 sdb_error_start(int prio, const char *fmt, ...)
182         va_list ap;
183         int ret;
185         if (sdb_error_clear())
186                 return -1;
188         va_start(ap, fmt);
189         ret = sdb_error_vappend(prio, fmt, ap);
190         va_end(ap);
192         return ret;
193 } /* sdb_error_start */
195 int
196 sdb_error_append(const char *fmt, ...)
198         va_list ap;
199         int ret;
201         va_start(ap, fmt);
202         ret = sdb_error_vappend(/* dont change prio */ -1, fmt, ap);
203         va_end(ap);
205         return ret;
206 } /* sdb_error_append */
208 int
209 sdb_error_finish(void)
211         return sdb_error_log();
212 } /* sdb_error_finish */
214 const char *
215 sdb_error_get(void)
217         sdb_error_ctx_t *ctx;
219         ctx = sdb_error_get_ctx();
220         if (! ctx)
221                 return "success";
222         return ctx->msg;
223 } /* sdb_error_get */
225 int
226 sdb_error_get_prio(void)
228         sdb_error_ctx_t *ctx;
230         ctx = sdb_error_get_ctx();
231         if (! ctx)
232                 return -1;
233         return ctx->prio;
234 } /* sdb_error_get_prio */
236 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */