1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
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, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU 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 *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
25 #include "configuration.h"
35 static FILE* log_output;
36 static log_callback_t *log_callbacks = NULL;
40 static char *log_strings[5] =
51 /* The log_puts() serves to somewhat different goals:
54 * - feeding low-level info to the user in GDB or Telnet
56 * The latter dictates that strings without newline are not logged, lest there
57 * will be *MANY log lines when sending one char at the time(e.g.
61 static void log_puts(enum log_levels level, const char *file, int line, const char *function, const char *string)
63 if (level == LOG_OUTPUT)
65 /* do not prepend any headers, just print out what we were given and return */
66 fputs(string, log_output);
71 char *f = strrchr(file, '/');
75 if (strchr(string, '\n')!=NULL)
77 if (debug_level >= LOG_DEBUG)
79 /* print with count and time information */
80 int t=(int)(time(NULL)-start);
81 fprintf(log_output, "%s %d %d %s:%d %s(): %s", log_strings[level+1], count, t, file, line, function, string);
85 /* do not print count and time */
86 fprintf(log_output, "%s %s:%d %s(): %s", log_strings[level+1], file, line, function, string);
90 /* only entire lines are logged. Otherwise it's
91 * single chars intended for the log callbacks. */
96 /* Never forward LOG_DEBUG, too verbose and they can be found in the log if need be */
97 if (level <= LOG_INFO)
99 log_callback_t *cb, *next;
101 /* DANGER!!!! the log callback can remove itself!!!! */
105 cb->fn(cb->priv, file, line, function, string);
111 void log_printf(enum log_levels level, const char *file, int line, const char *function, const char *format, ...)
116 if (level > debug_level)
120 va_start(ap, format);
122 string = alloc_printf(format, ap);
125 log_puts(level, file, line, function, string);
132 void log_printf_lf(enum log_levels level, const char *file, int line, const char *function, const char *format, ...)
137 if (level > debug_level)
141 va_start(ap, format);
143 string = alloc_printf(format, ap);
146 strcat(string, "\n"); /* alloc_printf guaranteed the buffer to be at least one char longer */
147 log_puts(level, file, line, function, string);
154 /* change the current debug level on the fly
157 * 2: + INFORMATIONAL MSGS
160 int handle_debug_level_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
163 command_print(cmd_ctx, "debug_level: %i", debug_level);
166 debug_level = strtoul(args[0], NULL, 0);
177 int handle_log_output_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
181 FILE* file = fopen(args[0], "w");
192 int log_register_commands(struct command_context_s *cmd_ctx)
195 register_command(cmd_ctx, NULL, "log_output", handle_log_output_command,
196 COMMAND_ANY, "redirect logging to <file> (default: stderr)");
197 register_command(cmd_ctx, NULL, "debug_level", handle_debug_level_command,
198 COMMAND_ANY, "adjust debug level <0-3>");
203 int log_init(struct command_context_s *cmd_ctx)
205 /* set defaults for daemon configuration, if not set by cmdline or cfgfile */
206 if (debug_level == -1)
207 debug_level = LOG_INFO;
209 if (log_output == NULL)
217 int set_log_output(struct command_context_s *cmd_ctx, FILE *output)
223 /* add/remove log callback handler */
224 int log_add_callback(log_callback_fn fn, void *priv)
228 /* prevent the same callback to be registered more than once, just for sure */
229 for (cb = log_callbacks; cb; cb = cb->next)
231 if (cb->fn == fn && cb->priv == priv)
232 return ERROR_INVALID_ARGUMENTS;
235 /* alloc memory, it is safe just to return in case of an error, no need for the caller to check this */
236 if ((cb = malloc(sizeof(log_callback_t))) == NULL)
237 return ERROR_BUF_TOO_SMALL;
239 /* add item to the beginning of the linked list */
242 cb->next = log_callbacks;
248 int log_remove_callback(log_callback_fn fn, void *priv)
250 log_callback_t *cb, **p;
252 for (p = &log_callbacks; (cb = *p); p = &(*p)->next)
254 if (cb->fn == fn && cb->priv == priv)
263 return ERROR_INVALID_ARGUMENTS;
266 /* return allocated string w/printf() result */
267 char *alloc_printf(const char *fmt, va_list ap)
269 /* no buffer at the beginning, force realloc to do the job */
272 /* start with minimal length to exercise all the code paths */
277 size *= 2; /* double the buffer size */
280 string = realloc(string, size);
289 va_copy(ap_copy, ap);
292 ret = vsnprintf(string, size, fmt, ap_copy);
293 /* NB! The result of the vsnprintf() might be an *EMPTY* string! */
294 if ((ret >= 0) && ((ret + 1) < size))
297 /* there was just enough or not enough space, allocate more in the next round */
300 /* the returned buffer is by principle guaranteed to be at least one character longer */