2 * This file is part of DisOrder.
3 * Copyright (C) 2004-2008 Richard Kettlewell
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 /** @file lib/log.c @brief Errors and logging
22 * All messages are initially emitted by one of the four functions below.
23 * debug() is generally invoked via D() so that mostly you just do a test
24 * rather than a complete subroutine call.
26 * Messages are dispatched via @ref log_default. This defaults to @ref
27 * log_stderr. daemonize() will turn off @ref log_stderr and use @ref
30 * fatal() will call exitfn() with a nonzero status. The default value is
31 * exit(), but it should be set to _exit() anywhere but the 'main line' of the
32 * program, to guarantee that exit() gets called at most once.
35 #define NO_MEMORY_ALLOCATION
36 /* because the memory allocation functions report errors */
48 /** @brief Definition of a log output */
50 /** @brief Function to call */
51 void (*fn
)(int pri
, const char *msg
, void *user
);
52 /** @brief User data */
56 /** @brief Function to call on a fatal error
58 * This is normally @c exit() but in the presence of @c fork() it
59 * sometimes gets set to @c _exit(). */
60 void (*exitfn
)(int) attribute((noreturn
)) = exit
;
62 /** @brief Debug flag */
65 /** @brief Program name */
68 /** @brief Filename for debug messages */
69 const char *debug_filename
;
71 /** @brief Line number for debug messages */
74 /** @brief Pointer to chosen log output structure */
75 struct log_output
*log_default
= &log_stderr
;
77 /** @brief Filename to debug for */
78 static const char *debug_only
;
80 /** @brief Construct log line, encoding special characters
82 * We might be receiving things in any old encoding, or binary rubbish
83 * in no encoding at all, so escape anything we don't like the look
84 * of. We limit the log message to a kilobyte.
86 static void format(char buffer
[], size_t bufsize
, const char *fmt
, va_list ap
) {
92 if(byte_vsnprintf(t
, sizeof t
, fmt
, ap
) < 0) {
93 strcpy(t
, "[byte_vsnprintf failed: ");
94 strncat(t
, fmt
, sizeof t
- strlen(t
) - 1);
97 while((ch
= (unsigned char)*p
++)) {
98 if(ch
>= ' ' && ch
<= 126) {
99 if(n
< bufsize
) buffer
[n
++] = ch
;
101 if(n
< bufsize
) buffer
[n
++] = '\\';
102 if(n
< bufsize
) buffer
[n
++] = '0' + ((ch
>> 6) & 7);
103 if(n
< bufsize
) buffer
[n
++] = '0' + ((ch
>> 3) & 7);
104 if(n
< bufsize
) buffer
[n
++] = '0' + ((ch
>> 0) & 7);
112 /** @brief Log to a file
113 * @param pri Message priority (as per syslog)
114 * @param msg Messagge to log
115 * @param user The @c FILE @c * to log to or NULL for @c stderr
117 static void logfp(int pri
, const char *msg
, void *user
) {
119 FILE *fp
= user ? user
: stderr
;
120 /* ...because stderr is not a constant so we can't initialize log_stderr
125 fprintf(fp
, "%s: ", progname
);
127 fputs("ERROR: ", fp
);
128 else if(pri
< LOG_DEBUG
)
132 if(!(debug_only
= getenv("DISORDER_DEBUG_ONLY")))
135 gettimeofday(&tv
, 0);
137 while(!strncmp(p
, "../", 3)) p
+= 3;
138 if(*debug_only
&& strcmp(p
, debug_only
))
140 fprintf(fp
, "%llu.%06lu: %s:%d: ",
141 (unsigned long long)tv
.tv_sec
, (unsigned long)tv
.tv_usec
,
148 /** @brief Log to syslog */
149 static void logsyslog(int pri
, const char *msg
,
150 void attribute((unused
)) *user
) {
152 syslog(pri
, "%s", msg
);
154 syslog(pri
, "%s:%d: %s", debug_filename
, debug_lineno
, msg
);
157 /** @brief Log output that writes to @c stderr */
158 struct log_output log_stderr
= { logfp
, 0 };
160 /** @brief Log output that sends to syslog */
161 struct log_output log_syslog
= { logsyslog
, 0 };
163 /** @brief Format and log a message */
164 static void vlogger(int pri
, const char *fmt
, va_list ap
) {
167 format(buffer
, sizeof buffer
, fmt
, ap
);
168 log_default
->fn(pri
, buffer
, log_default
->user
);
171 /** @brief Format and log a message */
172 static void logger(int pri
, const char *fmt
, ...) {
176 vlogger(pri
, fmt
, ap
);
180 /** @brief Format and log a message
181 * @param pri Message priority (as per syslog)
182 * @param fmt Format string
183 * @param errno_value Errno value to include as a string, or 0
184 * @param ap Argument list
186 void elog(int pri
, int errno_value
, const char *fmt
, va_list ap
) {
190 vlogger(pri
, fmt
, ap
);
192 memset(buffer
, 0, sizeof buffer
);
193 byte_vsnprintf(buffer
, sizeof buffer
, fmt
, ap
);
194 buffer
[sizeof buffer
- 1] = 0;
195 logger(pri
, "%s: %s", buffer
, strerror(errno_value
));
199 #define disorder_fatal fatal
200 #define disorder_error error
201 #define disorder_info info
203 /* shared implementation of vararg functions */
204 #include "log-impl.h"
206 /** @brief Log a debug message */
207 void debug(const char *msg
, ...) {
211 vlogger(LOG_DEBUG
, msg
, ap
);
215 /** @brief Set the program name from @c argc */
216 void set_progname(char **argv
) {
217 if((progname
= strrchr(argv
[0], '/')))