Merge branch 'dsp5680xx_cherry' of git://repo.or.cz/openocd/dsp568013 into HEAD
[fw/openocd] / src / helper / log.c
index c6906543b3b56afe29f016cc541989be7651c096..8a8f08a709041201cedd354d52765bb865eadeff 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                                  *
 #include "config.h"
 #endif
 
-#include "log.h"
 #include "time_support.h"
 // @todo the inclusion of server.h here is a layering violation
-#include "server.h"
+#include <server/server.h>
 
 #include <stdarg.h>
 
@@ -78,7 +77,7 @@ struct store_log_forward
 };
 
 /* either forward the log to the listeners or store it for possible forwarding later */
-static void log_forward(const char *file, int line, const char *function, const char *string)
+static void log_forward(const char *file, unsigned line, const char *function, const char *string)
 {
        if (log_forward_count==0)
        {
@@ -115,44 +114,6 @@ static void log_forward(const char *file, int line, const char *function, const
        }
 }
 
-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
@@ -178,7 +139,7 @@ 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 (strlen(string) > 0)
        {
                if (debug_level >= LOG_LVL_DEBUG)
                {
@@ -198,21 +159,16 @@ static void log_puts(enum log_levels level, const char *file, int line, const ch
 #endif
                                        string);
                }
-               else if (server_use_pipes == 0)
+               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. */
+               /* Empty strings are sent to log callbacks to keep e.g. gdbserver alive, here we do nothing. */
        }
 
        fflush(log_output);
@@ -225,7 +181,7 @@ static void log_puts(enum log_levels level, const char *file, int line, const ch
 }
 
 
-void log_printf(enum log_levels level, const char *file, int 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;
@@ -246,7 +202,7 @@ void log_printf(enum log_levels level, const char *file, int line, const char *f
        va_end(ap);
 }
 
-void log_printf_lf(enum log_levels level, const char *file, int 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;
@@ -268,45 +224,32 @@ void log_printf_lf(enum log_levels level, const char *file, int line, const char
        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 (argc == 1)
-       {
-               unsigned new_level;
-               COMMAND_PARSE_NUMBER(uint, args[0], new_level);
-               debug_level = MIN(new_level, LOG_LVL_DEBUG);
-       }
-       else if (argc > 1)
-               return ERROR_COMMAND_SYNTAX_ERROR;
-
-       if (debug_level >= LOG_LVL_DEBUG && server_use_pipes == 1)
+       if (CMD_ARGC == 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)
+               int new_level;
+               COMMAND_PARSE_NUMBER(int, CMD_ARGV[0], new_level);
+               if ((debug_level > LOG_LVL_DEBUG) || (new_level < LOG_LVL_SILENT))
                {
-                       log_output = file;
-                       LOG_WARNING("enabling log output as we are using pipes");
+                       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);
+       command_print(CMD_CTX, "debug_level: %i", debug_level);
 
        return ERROR_OK;
 }
 
 COMMAND_HANDLER(handle_log_output_command)
 {
-       if (argc == 1)
+       if (CMD_ARGC == 1)
        {
-               FILE* file = fopen(args[0], "w");
+               FILE* file = fopen(CMD_ARGV[0], "w");
 
                if (file)
                {
@@ -317,31 +260,55 @@ COMMAND_HANDLER(handle_log_output_command)
        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();
-       register_command(cmd_ctx, NULL, "log_output", handle_log_output_command,
-               COMMAND_ANY, "redirect logging to <file> (default: stderr)");
-       register_command(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;
 
-       if (log_output == NULL)
+       char *debug_env = getenv("OPENOCD_DEBUG_LEVEL");
+       if (NULL != debug_env)
        {
-               log_output = stderr;
+               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;
+               }
        }
 
-       start = last_time = timeval_ms();
+       if (log_output == NULL)
+               log_output = stderr;
 
-       return ERROR_OK;
+       start = last_time = timeval_ms();
 }
 
 int set_log_output(struct command_context *cmd_ctx, FILE *output)
@@ -396,37 +363,26 @@ int log_remove_callback(log_callback_fn fn, void *priv)
 /* return allocated string w/printf() result */
 char *alloc_vprintf(const char *fmt, va_list ap)
 {
-       /* no buffer at the beginning, force realloc to do the job */
-       char *string = NULL;
-
-       /* start with buffer size suitable for typical messages */
-       int size = 128;
-
-       for (;;)
-       {
-               char *t = string;
-               va_list ap_copy;
-               int ret;
-               string = realloc(string, size);
-               if (string == NULL)
-               {
-                       if (t != NULL)
-                               free(t);
-                       return NULL;
-               }
+       va_list ap_copy;
+       int len;
+       char *string;
 
-               va_copy(ap_copy, ap);
+       /* determine the length of the buffer needed */
+       va_copy(ap_copy, ap);
+       len = vsnprintf(NULL, 0, fmt, ap_copy);
+       va_end(ap_copy);
 
-               ret = vsnprintf(string, size, fmt, ap_copy);
-               /* NB! The result of the vsnprintf() might be an *EMPTY* string! */
-               if ((ret >= 0) && ((ret + 1) < size))
-                       break;
+       /* allocate and make room for terminating zero. */
+       /* FIXME: The old version always allocated at least one byte extra and
+        * other code depend on that. They should be probably be fixed, but for
+        * now reserve the extra byte. */
+       string = malloc(len + 2);
+       if (string == NULL)
+               return NULL;
 
-               /* there was just enough or not enough space, allocate more in the next round */
-               size *= 2; /* double the buffer size */
-       }
+       /* do the real work */
+       vsnprintf(string, len + 1, fmt, ap);
 
-       /* the returned buffer is by principle guaranteed to be at least one character longer */
        return string;
 }
 
@@ -505,27 +461,24 @@ void kept_alive()
 }
 
 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittantly */
-void alive_sleep(int ms)
+void alive_sleep(uint64_t ms)
 {
-       int i;
-       int napTime = 10;
-       for (i = 0; i < ms; i += napTime)
+       uint64_t napTime = 10;
+       for (uint64_t i = 0; i < ms; i += napTime)
        {
-               int sleep_a_bit = ms-i;
+               uint64_t sleep_a_bit = ms - i;
                if (sleep_a_bit > napTime)
-               {
                        sleep_a_bit = napTime;
-               }
-               usleep(sleep_a_bit*1000);
+
+               usleep(sleep_a_bit * 1000);
                keep_alive();
        }
 }
 
-void busy_sleep(int ms)
+void busy_sleep(uint64_t ms)
 {
-       long long then;
-       then = timeval_ms();
-       while ((timeval_ms()-then) < ms)
+       uint64_t then = timeval_ms();
+       while (timeval_ms() - then < ms)
        {
                /* busy wait */
        }