rtos: Rewrite rtos_qsymbol() and fix auto-detect false positive
[fw/openocd] / src / helper / log.c
index b1352a3241ce1983faeea9211578460634a20b42..ff84dbf00514f5b87913273f1a603e8c40e55abc 100644 (file)
@@ -2,7 +2,7 @@
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
- *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
+ *   Copyright (C) 2007-2010 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
  *   Copyright (C) 2008 by Spencer Oliver                                  *
  *   Free Software Foundation, Inc.,                                       *
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
 #include "time_support.h"
-// @todo the inclusion of server.h here is a layering violation
-#include "server.h"
+/* @todo the inclusion of server.h here is a layering violation */
+#include <server/server.h>
 
 #include <stdarg.h>
 
 
 int debug_level = -1;
 
-static FILElog_output;
-static struct log_callback *log_callbacks = NULL;
+static FILE *log_output;
+static struct log_callback *log_callbacks;
 
 static long long last_time;
 static long long current_time;
 
 static long long start;
 
-static char *log_strings[5] =
-{
+static char *log_strings[5] = {
        "User : ",
        "Error: ",
-       "Warn : ",  /* want a space after each colon, all same width, colons aligned */
+       "Warn : ",      /* want a space after each colon, all same width, colons aligned */
        "Info : ",
        "Debug: "
 };
 
+static int count;
 
-static int count = 0;
-
+static struct store_log_forward *log_head;
+static int log_forward_count;
 
-static struct store_log_forward * log_head = NULL;
-static int log_forward_count = 0;
-
-struct store_log_forward
-{
-       struct store_log_forward * next;
-       const char * file;
+struct store_log_forward {
+       struct store_log_forward *next;
+       const char *file;
        int line;
-       const char * function;
-       const char * string;
+       const char *function;
+       const char *string;
 };
 
 /* either forward the log to the listeners or store it for possible forwarding later */
 static void log_forward(const char *file, unsigned line, const char *function, const char *string)
 {
-       if (log_forward_count==0)
-       {
+       if (log_forward_count == 0) {
                struct log_callback *cb, *next;
                cb = log_callbacks;
                /* DANGER!!!! the log callback can remove itself!!!! */
-               while (cb)
-               {
+               while (cb) {
                        next = cb->next;
                        cb->fn(cb->priv, file, line, function, string);
                        cb = next;
                }
-       } else
-       {
-               struct store_log_forward *log = malloc(sizeof (struct store_log_forward));
+       } else {
+               struct store_log_forward *log = malloc(sizeof(struct store_log_forward));
                log->file = strdup(file);
                log->line = line;
                log->function = strdup(function);
                log->string = strdup(string);
                log->next = NULL;
-               if (log_head==NULL)
+               if (log_head == NULL)
                        log_head = log;
-               else
-               {
+               else {
                        /* append to tail */
-                       struct store_log_forward * t;
+                       struct store_log_forward *t;
                        t = log_head;
-                       while (t->next!=NULL)
-                       {
+                       while (t->next != NULL)
                                t = t->next;
-                       }
                        t->next = log;
                }
        }
 }
 
-void log_try(void)
-{
-       log_forward_count++;
-}
-
-void log_catch(void)
-{
-       assert(log_forward_count>0);
-       log_forward_count--;
-}
-
-void log_rethrow(void)
-{
-       log_catch();
-       if (log_forward_count==0)
-       {
-               struct store_log_forward *log;
-
-               log = log_head;
-               while (log != NULL)
-               {
-                       log_forward(log->file, log->line, log->function, log->string);
-
-                       struct store_log_forward *t=log;
-                       log = log->next;
-
-                       free((void *)t->file);
-                       free((void *)t->function);
-                       free((void *)t->string);
-                       free(t);
-
-               }
-
-               log_head = NULL;
-       }
-}
-
-
 /* The log_puts() serves to somewhat different goals:
  *
  * - logging
@@ -162,11 +115,14 @@ void log_rethrow(void)
  * target_request.c).
  *
  */
-static void log_puts(enum log_levels level, const char *file, int line, const char *function, const char *string)
+static void log_puts(enum log_levels level,
+       const char *file,
+       int line,
+       const char *function,
+       const char *string)
 {
        char *f;
-       if (level == LOG_LVL_OUTPUT)
-       {
+       if (level == LOG_LVL_OUTPUT) {
                /* do not prepend any headers, just print out what we were given and return */
                fputs(string, log_output);
                fflush(log_output);
@@ -177,10 +133,8 @@ static void log_puts(enum log_levels level, const char *file, int line, const ch
        if (f != NULL)
                file = f + 1;
 
-       if (strchr(string, '\n') != NULL)
-       {
-               if (debug_level >= LOG_LVL_DEBUG)
-               {
+       if (strlen(string) > 0) {
+               if (debug_level >= LOG_LVL_DEBUG) {
                        /* print with count and time information */
                        int t = (int)(timeval_ms()-start);
 #ifdef _DEBUG_FREE_SPACE_
@@ -189,42 +143,37 @@ static void log_puts(enum log_levels level, const char *file, int line, const ch
 #endif
                        fprintf(log_output, "%s%d %d %s:%d %s()"
 #ifdef _DEBUG_FREE_SPACE_
-                                       " %d"
+                               " %d"
 #endif
-                                       ": %s", log_strings[level + 1], count, t, file, line, function,
+                               ": %s", log_strings[level + 1], count, t, file, line, function,
 #ifdef _DEBUG_FREE_SPACE_
-                                       info.fordblks,
+                               info.fordblks,
 #endif
-                                       string);
-               }
-               else if (server_use_pipes == 0)
-               {
+                               string);
+               } else {
                        /* if we are using gdb through pipes then we do not want any output
                         * to the pipe otherwise we get repeated strings */
-                       if (strcmp(string, "\n") != 0)
-                       {
-                               /* print human readable output - but skip empty lines */
-                               fprintf(log_output, "%s%s",
-                                               (level > LOG_LVL_USER)?log_strings[level + 1]:"", string);
-                       }
+                       fprintf(log_output, "%s%s",
+                               (level > LOG_LVL_USER) ? log_strings[level + 1] : "", string);
                }
-       } else
-       {
-               /* only entire lines are logged. Otherwise it's
-                * single chars intended for the log callbacks. */
+       } else {
+               /* Empty strings are sent to log callbacks to keep e.g. gdbserver alive, here we do
+                *nothing. */
        }
 
        fflush(log_output);
 
        /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
        if (level <= LOG_LVL_INFO)
-       {
                log_forward(file, line, function, string);
-       }
 }
 
-
-void log_printf(enum log_levels level, const char *file, unsigned line, const char *function, const char *format, ...)
+void log_printf(enum log_levels level,
+       const char *file,
+       unsigned line,
+       const char *function,
+       const char *format,
+       ...)
 {
        char *string;
        va_list ap;
@@ -236,8 +185,7 @@ void log_printf(enum log_levels level, const char *file, unsigned line, const ch
        va_start(ap, format);
 
        string = alloc_vprintf(format, ap);
-       if (string != NULL)
-       {
+       if (string != NULL) {
                log_puts(level, file, line, function, string);
                free(string);
        }
@@ -245,7 +193,12 @@ void log_printf(enum log_levels level, const char *file, unsigned line, const ch
        va_end(ap);
 }
 
-void log_printf_lf(enum log_levels level, const char *file, unsigned line, const char *function, const char *format, ...)
+void log_printf_lf(enum log_levels level,
+       const char *file,
+       unsigned line,
+       const char *function,
+       const char *format,
+       ...)
 {
        char *string;
        va_list ap;
@@ -257,9 +210,9 @@ void log_printf_lf(enum log_levels level, const char *file, unsigned line, const
        va_start(ap, format);
 
        string = alloc_vprintf(format, ap);
-       if (string != NULL)
-       {
-               strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
+       if (string != NULL) {
+               strcat(string, "\n");   /* alloc_vprintf guaranteed the buffer to be at least one
+                                        *char longer */
                log_puts(level, file, line, function, string);
                free(string);
        }
@@ -267,34 +220,18 @@ void log_printf_lf(enum log_levels level, const char *file, unsigned line, const
        va_end(ap);
 }
 
-/* change the current debug level on the fly
- * 0: only ERRORS
- * 1: + WARNINGS
- * 2: + INFORMATIONAL MSGS
- * 3: + DEBUG MSGS
- */
 COMMAND_HANDLER(handle_debug_level_command)
 {
-       if (CMD_ARGC == 1)
-       {
-               unsigned new_level;
-               COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], new_level);
-               debug_level = MIN(new_level, LOG_LVL_DEBUG);
-       }
-       else if (CMD_ARGC > 1)
-               return ERROR_COMMAND_SYNTAX_ERROR;
-
-       if (debug_level >= LOG_LVL_DEBUG && server_use_pipes == 1)
-       {
-               /* if we are enabling debug info then we need to write to a log file
-                * otherwise the pipe will get full and cause issues with gdb */
-               FILE* file = fopen("openocd.log", "w");
-               if (file)
-               {
-                       log_output = file;
-                       LOG_WARNING("enabling log output as we are using pipes");
+       if (CMD_ARGC == 1) {
+               int new_level;
+               COMMAND_PARSE_NUMBER(int, CMD_ARGV[0], new_level);
+               if ((new_level > LOG_LVL_DEBUG) || (new_level < LOG_LVL_SILENT)) {
+                       LOG_ERROR("level must be between %d and %d", LOG_LVL_SILENT, LOG_LVL_DEBUG);
+                       return ERROR_COMMAND_SYNTAX_ERROR;
                }
-       }
+               debug_level = new_level;
+       } else if (CMD_ARGC > 1)
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
        command_print(CMD_CTX, "debug_level: %i", debug_level);
 
@@ -303,44 +240,62 @@ COMMAND_HANDLER(handle_debug_level_command)
 
 COMMAND_HANDLER(handle_log_output_command)
 {
-       if (CMD_ARGC == 1)
-       {
-               FILE* file = fopen(CMD_ARGV[0], "w");
+       if (CMD_ARGC == 1) {
+               FILE *file = fopen(CMD_ARGV[0], "w");
 
                if (file)
-               {
                        log_output = file;
-               }
        }
 
        return ERROR_OK;
 }
 
+static struct command_registration log_command_handlers[] = {
+       {
+               .name = "log_output",
+               .handler = handle_log_output_command,
+               .mode = COMMAND_ANY,
+               .help = "redirect logging to a file (default: stderr)",
+               .usage = "file_name",
+       },
+       {
+               .name = "debug_level",
+               .handler = handle_debug_level_command,
+               .mode = COMMAND_ANY,
+               .help = "Sets the verbosity level of debugging output. "
+                       "0 shows errors only; 1 adds warnings; "
+                       "2 (default) adds other info; 3 adds debugging.",
+               .usage = "number",
+       },
+       COMMAND_REGISTRATION_DONE
+};
+
 int log_register_commands(struct command_context *cmd_ctx)
 {
-       start = timeval_ms();
-       COMMAND_REGISTER(cmd_ctx, NULL, "log_output", handle_log_output_command,
-               COMMAND_ANY, "redirect logging to <file> (default: stderr)");
-       COMMAND_REGISTER(cmd_ctx, NULL, "debug_level", handle_debug_level_command,
-               COMMAND_ANY, "adjust debug level <0-3>");
-
-       return ERROR_OK;
+       return register_commands(cmd_ctx, NULL, log_command_handlers);
 }
 
-int log_init(struct command_context *cmd_ctx)
+void log_init(void)
 {
-       /* set defaults for daemon configuration, if not set by cmdline or cfgfile */
+       /* set defaults for daemon configuration,
+        * if not set by cmdline or cfgfile */
        if (debug_level == -1)
                debug_level = LOG_LVL_INFO;
 
+       char *debug_env = getenv("OPENOCD_DEBUG_LEVEL");
+       if (NULL != debug_env) {
+               int value;
+               int retval = parse_int(debug_env, &value);
+               if (ERROR_OK == retval &&
+                               debug_level >= LOG_LVL_SILENT &&
+                               debug_level <= LOG_LVL_DEBUG)
+                               debug_level = value;
+       }
+
        if (log_output == NULL)
-       {
                log_output = stderr;
-       }
 
        start = last_time = timeval_ms();
-
-       return ERROR_OK;
 }
 
 int set_log_output(struct command_context *cmd_ctx, FILE *output)
@@ -355,14 +310,15 @@ int log_add_callback(log_callback_fn fn, void *priv)
        struct log_callback *cb;
 
        /* prevent the same callback to be registered more than once, just for sure */
-       for (cb = log_callbacks; cb; cb = cb->next)
-       {
+       for (cb = log_callbacks; cb; cb = cb->next) {
                if (cb->fn == fn && cb->priv == priv)
-                       return ERROR_INVALID_ARGUMENTS;
+                       return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       /* 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(struct log_callback))) == NULL)
+       /* alloc memory, it is safe just to return in case of an error, no need for the caller to
+        *check this */
+       cb = malloc(sizeof(struct log_callback));
+       if (cb == NULL)
                return ERROR_BUF_TOO_SMALL;
 
        /* add item to the beginning of the linked list */
@@ -378,10 +334,8 @@ int log_remove_callback(log_callback_fn fn, void *priv)
 {
        struct log_callback *cb, **p;
 
-       for (p = &log_callbacks; (cb = *p); p = &(*p)->next)
-       {
-               if (cb->fn == fn && cb->priv == priv)
-               {
+       for (p = &log_callbacks; (cb = *p); p = &(*p)->next) {
+               if (cb->fn == fn && cb->priv == priv) {
                        *p = cb->next;
                        free(cb);
                        return ERROR_OK;
@@ -389,7 +343,7 @@ int log_remove_callback(log_callback_fn fn, void *priv)
        }
 
        /* no such item */
-       return ERROR_INVALID_ARGUMENTS;
+       return ERROR_COMMAND_SYNTAX_ERROR;
 }
 
 /* return allocated string w/printf() result */
@@ -452,8 +406,7 @@ char *alloc_printf(const char *format, ...)
 void keep_alive()
 {
        current_time = timeval_ms();
-       if (current_time-last_time > 1000)
-       {
+       if (current_time-last_time > 1000) {
                extern int gdb_actual_connections;
 
                if (gdb_actual_connections)
@@ -468,8 +421,7 @@ void keep_alive()
                                "trouble with GDB connections.",
                                current_time-last_time);
        }
-       if (current_time-last_time > 500)
-       {
+       if (current_time-last_time > 500) {
                /* this will keep the GDB connection alive */
                LOG_USER_N("%s", "");
 
@@ -496,8 +448,7 @@ void kept_alive()
 void alive_sleep(uint64_t ms)
 {
        uint64_t napTime = 10;
-       for (uint64_t i = 0; i < ms; i += napTime)
-       {
+       for (uint64_t i = 0; i < ms; i += napTime) {
                uint64_t sleep_a_bit = ms - i;
                if (sleep_a_bit > napTime)
                        sleep_a_bit = napTime;
@@ -510,8 +461,9 @@ void alive_sleep(uint64_t ms)
 void busy_sleep(uint64_t ms)
 {
        uint64_t then = timeval_ms();
-       while (timeval_ms() - then < ms)
-       {
-               /* busy wait */
+       while (timeval_ms() - then < ms) {
+               /*
+                * busy wait
+                */
        }
 }