- Fixes '=' whitespace
[openocd.git] / src / helper / log.c
index 1a0f677d06695127a2188ff1d14a4582d967edd4..68b29a203b5cda1f27f2e4d9287551db332731b0 100644 (file)
@@ -2,9 +2,12 @@
  *   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                                  *
+ *   spen@spen-soft.co.uk                                                  *
+ *                                                                         *
  *   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     *
 #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;
@@ -51,13 +54,14 @@ 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;
 
 /* The log_puts() serves to somewhat different goals:
@@ -85,29 +89,31 @@ 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()
+#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",
@@ -130,9 +136,9 @@ static void log_puts(enum log_levels level, const char *file, int line, const ch
                /* DANGER!!!! the log callback can remove itself!!!! */
                while (cb)
                {
-                       next=cb->next;
+                       next = cb->next;
                        cb->fn(cb->priv, file, line, function, string);
-                       cb=next;
+                       cb = next;
                }
        }
 }
@@ -188,17 +194,30 @@ void log_printf_lf(enum log_levels level, const char *file, int line, const char
  */
 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 (argc == 1)
+       {
+               unsigned new_level;
+               int retval = parse_uint(args[0], &new_level);
+               if (ERROR_OK != retval)
+                       return retval;
+               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;
 }
@@ -240,7 +259,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;
 }
@@ -364,10 +383,22 @@ char *alloc_printf(const char *format, ...)
  */
 void keep_alive()
 {
-       current_time=timeval_ms();
+       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)
        {
@@ -382,30 +413,40 @@ 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)
+       {
+               /* busy wait */
+       }
+}

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)