use COMMAND_HANDLER macro to define all commands
[fw/openocd] / src / helper / log.c
index f7b2fc9698173778cfb8c60370eb70aea6fac5ae..ccc0c01bdb655d4808cd30b274d388cd7853dc7b 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,2008 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
  *   Copyright (C) 2008 by Spencer Oliver                                  *
 #endif
 
 #include "log.h"
-#include "configuration.h"
 #include "time_support.h"
-#include "command.h"
+// @todo the inclusion of server.h here is a layering violation
+#include "server.h"
 
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
 #include <stdarg.h>
 
-#define PRINT_MEM() 0
-#if PRINT_MEM()
+#ifdef _DEBUG_FREE_SPACE_
+#ifdef HAVE_MALLOC_H
 #include <malloc.h>
+#else
+#error "malloc.h is required to use --enable-malloc-logging"
+#endif
 #endif
 
 int debug_level = -1;
@@ -54,15 +54,105 @@ static long long start;
 
 static char *log_strings[5] =
 {
-       "User:   ",
-       "Error:  ",
-       "Warning:",
-       "Info:   ",
-       "Debug:  "
+       "User : ",
+       "Error: ",
+       "Warn : ",  /* want a space after each colon, all same width, colons aligned */
+       "Info : ",
+       "Debug: "
 };
 
+
 static int count = 0;
 
+
+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;
+       int line;
+       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, int line, const char *function, const char *string)
+{
+       if (log_forward_count==0)
+       {
+               log_callback_t *cb, *next;
+               cb = log_callbacks;
+               /* DANGER!!!! the log callback can remove itself!!!! */
+               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));
+               log->file = strdup(file);
+               log->line = line;
+               log->function = strdup(function);
+               log->string = strdup(string);
+               log->next = NULL;
+               if (log_head==NULL)
+                       log_head = log;
+               else
+               {
+                       /* append to tail */
+                       struct store_log_forward * t;
+                       t = log_head;
+                       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
@@ -88,33 +178,35 @@ 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 (strchr(string, '\n') != NULL)
        {
                if (debug_level >= LOG_LVL_DEBUG)
                {
                        /* print with count and time information */
-                       int t=(int)(timeval_ms()-start);
-#if PRINT_MEM()
+                       int t = (int)(timeval_ms()-start);
+#ifdef _DEBUG_FREE_SPACE_
                        struct mallinfo info;
                        info = mallinfo();
 #endif
-                       fprintf(log_output, "%s %d %d %s:%d %s()"
-#if PRINT_MEM()
+                       fprintf(log_output, "%s%d %d %s:%d %s()"
+#ifdef _DEBUG_FREE_SPACE_
                                        " %d"
 #endif
-                                       ": %s", log_strings[level+1], count, t, file, line, function,
-#if PRINT_MEM()
+                                       ": %s", log_strings[level + 1], count, t, file, line, function,
+#ifdef _DEBUG_FREE_SPACE_
                                        info.fordblks,
 #endif
                                        string);
                }
-               else
+               else if (server_use_pipes == 0)
                {
-                       if (strcmp(string, "\n")!=0)
+                       /* 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);
+                                               (level > LOG_LVL_USER)?log_strings[level + 1]:"", string);
                        }
                }
        } else
@@ -128,18 +220,11 @@ static void log_puts(enum log_levels level, const char *file, int line, const ch
        /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
        if (level <= LOG_LVL_INFO)
        {
-               log_callback_t *cb, *next;
-               cb = log_callbacks;
-               /* DANGER!!!! the log callback can remove itself!!!! */
-               while (cb)
-               {
-                       next=cb->next;
-                       cb->fn(cb->priv, file, line, function, string);
-                       cb=next;
-               }
+               log_forward(file, line, function, string);
        }
 }
 
+
 void log_printf(enum log_levels level, const char *file, int line, const char *function, const char *format, ...)
 {
        char *string;
@@ -189,24 +274,35 @@ void log_printf_lf(enum log_levels level, const char *file, int line, const char
  * 2: + INFORMATIONAL MSGS
  * 3: + DEBUG MSGS
  */
-int handle_debug_level_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_debug_level_command)
 {
-       if (argc == 0)
-               command_print(cmd_ctx, "debug_level: %i", debug_level);
-
-       if (argc > 0)
-               debug_level = strtoul(args[0], NULL, 0);
+       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 < 0)
-               debug_level = 0;
+       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 (debug_level > 3)
-               debug_level = 3;
+       command_print(cmd_ctx, "debug_level: %i", debug_level);
 
        return ERROR_OK;
 }
 
-int handle_log_output_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_log_output_command)
 {
        if (argc == 1)
        {
@@ -243,7 +339,7 @@ int log_init(struct command_context_s *cmd_ctx)
                log_output = stderr;
        }
 
-       start=last_time=timeval_ms();
+       start = last_time = timeval_ms();
 
        return ERROR_OK;
 }
@@ -367,12 +463,24 @@ char *alloc_printf(const char *format, ...)
  */
 void keep_alive()
 {
-       current_time=timeval_ms();
-       if (current_time-last_time>1000)
+       current_time = timeval_ms();
+       if (current_time-last_time > 1000)
        {
-               LOG_WARNING("BUG: keep_alive() was not invoked in the 1000ms timelimit. GDB alive packet not sent! (%lld)", current_time-last_time);
+               extern int gdb_actual_connections;
+
+               if (gdb_actual_connections)
+                       LOG_WARNING("keep_alive() was not invoked in the "
+                               "1000ms timelimit. GDB alive packet not "
+                               "sent! (%lld). Workaround: increase "
+                               "\"set remotetimeout\" in GDB",
+                               current_time-last_time);
+               else
+                       LOG_DEBUG("keep_alive() was not invoked in the "
+                               "1000ms timelimit (%lld). This may cause "
+                               "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", "");
@@ -385,40 +493,39 @@ void keep_alive()
                 * These functions should be invoked at a well defined spot in server.c
                 */
 
-               last_time=current_time;
+               last_time = current_time;
        }
 }
 
 /* reset keep alive timer without sending message */
 void kept_alive()
 {
-       current_time=timeval_ms();
-       last_time=current_time;
+       current_time = timeval_ms();
+       last_time = current_time;
 }
 
 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittantly */
 void alive_sleep(int ms)
 {
        int i;
-       for (i=0; i<ms; i+=500)
+       int napTime = 10;
+       for (i = 0; i < ms; i += napTime)
        {
-               int sleep_a_bit=ms-i;
-               if (sleep_a_bit>500)
+               int sleep_a_bit = ms-i;
+               if (sleep_a_bit > napTime)
                {
-                       sleep_a_bit=500;
+                       sleep_a_bit = napTime;
                }
-               keep_alive();
                usleep(sleep_a_bit*1000);
                keep_alive();
        }
 }
 
-
 void busy_sleep(int ms)
 {
        long long then;
-       then=timeval_ms();
-       while ((timeval_ms()-then)<ms)
+       then = timeval_ms();
+       while ((timeval_ms()-then) < ms)
        {
                /* busy wait */
        }