X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fhelper%2Flog.c;h=de74f9d05c5069b6315cce3bd15b23ed0d7be03f;hp=7b7c914431c7543d826cd4b7fa30ed47efc68e0a;hb=0a749feb8e05d41b22a75e5545233b3e400463f8;hpb=958f845f4b64448d72688c31f0c299de569961e6 diff --git a/src/helper/log.c b/src/helper/log.c index 7b7c914431..de74f9d05c 100644 --- a/src/helper/log.c +++ b/src/helper/log.c @@ -1,198 +1,297 @@ -/*************************************************************************** - * Copyright (C) 2005 by Dominic Rath * - * Dominic.Rath@gmx.de * - * * - * This program is free software; you can redistribute it and/or modify * - * it under the terms of the GNU General Public License as published by * - * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * - * * - * This program is distributed in the hope that it will be useful, * - * but WITHOUT ANY WARRANTY; without even the implied warranty of * - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * - * GNU General Public License for more details. * - * * - * You should have received a copy of the GNU General Public License * - * along with this program; if not, write to the * - * Free Software Foundation, Inc., * - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * - ***************************************************************************/ -#ifdef HAVE_CONFIG_H -#include "config.h" -#endif - -#include "log.h" -#include "configuration.h" - -#include -#include -#include -#include -#include - -int debug_level = -1; - -static FILE* log_output; - -static void *privData; -static logCallback callback; - -void log_setCallback(logCallback c, void *p) -{ - callback = c; - privData = p; -} - -static char *log_strings[5] = -{ - "User: ", - "Error: ", - "Warning:", - "Info: ", - "Debug: " -}; - -void log_printf(enum log_levels level, const char *file, int line, const char *function, const char *format, ...) -{ - static int count = 0; - count++; - va_list args; - char buffer[512]; - - if (level > debug_level) - return; - - va_start(args, format); - vsnprintf(buffer, 512, format, args); - - char *f = strrchr(file, '/'); - if (f != NULL) - file = f + 1; - - if (debug_level >= LOG_DEBUG) - { - /* print with count and time information */ - fprintf(log_output, "%s %d %ld %s:%d %s(): %s\n", log_strings[level+1], count, time(NULL), file, line, function, buffer); - } - else - { - /* do not print count and time */ - fprintf(log_output, "%s %s:%d %s(): %s\n", log_strings[level+1], file, line, function, buffer); - } - - fflush(log_output); - - va_end(args); - - /* Never forward LOG_DEBUG, too verbose and they can be found in the log if need be */ - if (callback && (level <= LOG_INFO)) - { - va_start(args, format); - callback(privData, file, line, function, format, args); - va_end(args); - } -} - -/* change the current debug level on the fly - * 0: only ERRORS - * 1: + WARNINGS - * 2: + INFORMATIONAL MSGS - * 3: + DEBUG MSGS - */ -int handle_debug_level_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) -{ - if (argc == 0) - command_print(cmd_ctx, "debug_level: %i", debug_level); - - if (argc > 0) - debug_level = strtoul(args[0], NULL, 0); - - if (debug_level < 0) - debug_level = 0; - - if (debug_level > 3) - debug_level = 3; - - return ERROR_OK; -} - -int handle_log_output_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) -{ - if (argc == 1) - { - FILE* file = fopen(args[0], "w"); - - if (file) - { - log_output = file; - } - } - - return ERROR_OK; -} - -int log_register_commands(struct command_context_s *cmd_ctx) -{ - register_command(cmd_ctx, NULL, "log_output", handle_log_output_command, - COMMAND_ANY, "redirect logging to (default: stderr)"); - register_command(cmd_ctx, NULL, "debug_level", handle_debug_level_command, - COMMAND_ANY, "adjust debug level <0-3>"); - - return ERROR_OK; -} - -int log_init(struct command_context_s *cmd_ctx) -{ - /* set defaults for daemon configuration, if not set by cmdline or cfgfile */ - if (debug_level == -1) - debug_level = LOG_INFO; - - if (log_output == NULL) - { - log_output = stderr; - } - - return ERROR_OK; -} - -int set_log_output(struct command_context_s *cmd_ctx, FILE *output) -{ - log_output = output; - return ERROR_OK; -} - -/* return allocated string w/printf() result */ -char *allocPrintf(const char *fmt, va_list ap) -{ - char *string = NULL; - - /* start by 0 to exercise all the code paths. Need minimum 2 bytes to - * fit 1 char and 0 terminator. */ - int size = 0; - int first = 1; - for (;;) - { - if ((string == NULL) || (!first)) - { - size = size * 2 + 2; - char *t = string; - string = realloc(string, size); - if (string == NULL) - { - if (t != NULL) - free(t); - return NULL; - } - } - - int ret; - ret = vsnprintf(string, size, fmt, ap); - /* NB! The result of the vsnprintf() might be an *EMPTY* string! */ - if ((ret >= 0) && ((ret + 1) < size)) - { - return string; - } - /* there was just enough or not enough space, allocate more. */ - first = 0; - } -} +/*************************************************************************** + * Copyright (C) 2005 by Dominic Rath * + * Dominic.Rath@gmx.de * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + +#include "log.h" +#include "configuration.h" + +#include +#include +#include +#include +#include + +int debug_level = -1; + +static FILE* log_output; +static log_callback_t *log_callbacks = NULL; + +static time_t start; + +static char *log_strings[5] = +{ + "User: ", + "Error: ", + "Warning:", + "Info: ", + "Debug: " +}; + +static int count = 0; + +/* The log_printfv() serves to somewhat different goals: + * + * - logging + * - feeding low-level info to the user in GDB or Telnet + * + * The latter dictates that strings without newline are not logged, lest there + * will be *MANY log lines when sending one char at the time(e.g. + * target_request.c). + * + */ +static void log_puts(enum log_levels level, const char *file, int line, const char *function, const char *string) +{ + log_callback_t *cb; + + if (level == LOG_OUTPUT) + { + /* do not prepend any headers, just print out what we were given and return */ + fputs(string, log_output); + fflush(log_output); + return; + } + + char *f = strrchr(file, '/'); + if (f != NULL) + file = f + 1; + + if (strchr(buffer, '\n')!=NULL) + { + if (debug_level >= LOG_DEBUG) + { + /* print with count and time information */ + int t=(int)(time(NULL)-start); + fprintf(log_output, "%s %d %d %s:%d %s(): %s", log_strings[level+1], count, t, file, line, function, string); + } + else + { + /* do not print count and time */ + fprintf(log_output, "%s %s:%d %s(): %s", log_strings[level+1], file, line, function, string); + } + } else + { + /* only entire lines are logged. Otherwise it's + * single chars intended for the log callbacks. */ + } + + fflush(log_output); + + /* Never forward LOG_DEBUG, too verbose and they can be found in the log if need be */ + if (level <= LOG_INFO) + { + log_callback_t *cb; + for (cb = log_callbacks; cb; cb = cb->next) + { + cb->fn(cb->priv, file, line, function, string); + } + } +} + +void log_printf(enum log_levels level, const char *file, int line, const char *function, const char *format, ...) +{ + char *string; + + count++; + if (level > debug_level) + return; + + va_list ap; + va_start(ap, format); + + string = alloc_printf(format, ap); + if (string != NULL) + { + log_puts(level, file, line, function, string); + free(string); + } + + va_end(ap); +} + +void log_printf_lf(enum log_levels level, const char *file, int line, const char *function, const char *format, ...) +{ + char *string; + + count++; + if (level > debug_level) + return; + + va_list ap; + va_start(ap, format); + + string = alloc_printf(format, ap); + if (string != NULL) + { + strcat(string, "\n"); /* alloc_printf guaranteed the buffer to be at least one char longer */ + log_puts(level, file, line, function, string); + free(string); + } + + va_end(ap); +} + +/* change the current debug level on the fly + * 0: only ERRORS + * 1: + WARNINGS + * 2: + INFORMATIONAL MSGS + * 3: + DEBUG MSGS + */ +int handle_debug_level_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +{ + if (argc == 0) + command_print(cmd_ctx, "debug_level: %i", debug_level); + + if (argc > 0) + debug_level = strtoul(args[0], NULL, 0); + + if (debug_level < 0) + debug_level = 0; + + if (debug_level > 3) + debug_level = 3; + + return ERROR_OK; +} + +int handle_log_output_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +{ + if (argc == 1) + { + FILE* file = fopen(args[0], "w"); + + if (file) + { + log_output = file; + } + } + + return ERROR_OK; +} + +int log_register_commands(struct command_context_s *cmd_ctx) +{ + start = time(NULL); + register_command(cmd_ctx, NULL, "log_output", handle_log_output_command, + COMMAND_ANY, "redirect logging to (default: stderr)"); + register_command(cmd_ctx, NULL, "debug_level", handle_debug_level_command, + COMMAND_ANY, "adjust debug level <0-3>"); + + return ERROR_OK; +} + +int log_init(struct command_context_s *cmd_ctx) +{ + /* set defaults for daemon configuration, if not set by cmdline or cfgfile */ + if (debug_level == -1) + debug_level = LOG_INFO; + + if (log_output == NULL) + { + log_output = stderr; + } + + return ERROR_OK; +} + +int set_log_output(struct command_context_s *cmd_ctx, FILE *output) +{ + log_output = output; + return ERROR_OK; +} + +/* add/remove log callback handler */ +int log_add_callback(log_callback_fn fn, void *priv) +{ + log_callback_t *cb; + + /* prevent the same callback to be registered more than once, just for sure */ + for (cb = log_callbacks; cb; cb = cb->next) + { + if (cb->fn == fn && cb->priv == priv) + return ERROR_INVALID_ARGUMENTS; + } + + /* alloc memory, it is safe just to return in case of an error, no need for the caller to check this */ + if ((cb = malloc(sizeof(log_callback_t))) == NULL) + return ERROR_BUF_TOO_SMALL; + + /* add item to the beginning of the linked list */ + cb->fn = fn; + cb->priv = priv; + cb->next = log_callbacks; + log_callbacks = cb; + + return ERROR_OK; +} + +int log_remove_callback(log_callback_fn fn, void *priv) +{ + log_callback_t *cb, **p; + + for (p = &log_callbacks; (cb = *p); p = &(*p)->next) + { + if (cb->fn == fn && cb->priv == priv) + { + *p = cb->next; + free(cb); + return ERROR_OK; + } + } + + /* no such item */ + return ERROR_INVALID_ARGUMENTS; +} + +/* return allocated string w/printf() result */ +char *alloc_printf(const char *fmt, va_list ap) +{ + /* no buffer at the beginning, force realloc to do the job */ + char *string = NULL; + + /* start with minimal length to exercise all the code paths */ + int size = 1; + + for (;;) + { + size *= 2; /* double the buffer size */ + + char *t = string; + string = realloc(string, size); + if (string == NULL) + { + if (t != NULL) + free(t); + return NULL; + } + + int ret; + ret = vsnprintf(string, size, fmt, ap); + /* NB! The result of the vsnprintf() might be an *EMPTY* string! */ + if ((ret >= 0) && ((ret + 1) < size)) + break; + + /* there was just enough or not enough space, allocate more in the next round */ + } + + /* the returned buffer is by principle guaranteed to be at least one character longer */ + return string; +}