Pavel Chromy: va_copy should always be paired with va_end.
[openocd.git] / src / helper / log.c
index a5432aa9c53756d889240aa783ad9808ccb911c0..694e8a8b2126aa98b181f8bcd8e3c5d1051ebf47 100644 (file)
@@ -46,25 +46,24 @@ static char *log_strings[5] =
        "Debug:  "
 };
 
-void log_printf(enum log_levels level, const char *file, int line, const char *function, const char *format, ...)
+static int count = 0;
+
+/* The log_puts() 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)
 {
-       static int count = 0;
-       count++;
-       va_list args;
-       char buffer[512];
-       log_callback_t *cb;
-
-       if (level > debug_level)
-               return;
-
-       va_start(args, format);
-       vsnprintf(buffer, 512, format, args);
-       va_end(args);
-
        if (level == LOG_OUTPUT)
        {
                /* do not prepend any headers, just print out what we were given and return */
-               fputs(buffer, log_output);
+               fputs(string, log_output);
                fflush(log_output);
                return;
        }
@@ -73,16 +72,23 @@ void log_printf(enum log_levels level, const char *file, int line, const char *f
        if (f != NULL)
                file = f + 1;
 
-       if (debug_level >= LOG_DEBUG)
+       if (strchr(string, '\n')!=NULL)
        {
-               /* print with count and time information */
-               time_t t=time(NULL)-start;
-               fprintf(log_output, "%s %d %ld %s:%d %s(): %s\n", log_strings[level+1], count, t, file, line, function, buffer);
-       }
-       else
+               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
        {
-               /* do not print count and time */
-               fprintf(log_output, "%s %s:%d %s(): %s\n", log_strings[level+1], file, line, function, buffer);
+               /* only entire lines are logged. Otherwise it's 
+                * single chars intended for the log callbacks. */
        }
 
        fflush(log_output);
@@ -90,15 +96,61 @@ void log_printf(enum log_levels level, const char *file, int line, const char *f
        /* Never forward LOG_DEBUG, too verbose and they can be found in the log if need be */
        if (level <= LOG_INFO)
        {
-               for (cb = log_callbacks; cb; cb = cb->next)
+               log_callback_t *cb, *next;
+               cb = log_callbacks;
+               /* DANGER!!!! the log callback can remove itself!!!! */
+               while (cb)
                {
-                       va_start(args, format);
-                       cb->fn(cb->priv, file, line, function, format, args);
-                       va_end(args);
+                       next=cb->next;
+                       cb->fn(cb->priv, file, line, function, string);
+                       cb=next;
                }
        }
 }
 
+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
@@ -199,9 +251,9 @@ int log_remove_callback(log_callback_fn fn, void *priv)
 
        for (p = &log_callbacks; (cb = *p); p = &(*p)->next)
        {
-           if (cb->fn == fn && cb->priv == priv)
-           {
-               *p = cb->next;
+               if (cb->fn == fn && cb->priv == priv)
+               {
+                       *p = cb->next;
                        free(cb);
                        return ERROR_OK;
                }
@@ -214,35 +266,39 @@ int log_remove_callback(log_callback_fn fn, void *priv)
 /* 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 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;
+       /* start with buffer size suitable for typical messages */
+       int size = 128;
+
        for (;;)
        {
-               if ((string == NULL) || (!first))
+               char *t = string;
+               string = realloc(string, size);
+               if (string == NULL)
                {
-                       size = size * 2 + 2;
-                       char *t = string;
-                       string = realloc(string, size);
-                       if (string == NULL)
-                       {
-                               if (t != NULL)
-                                       free(t);
-                               return 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;
+
+               va_list ap_copy;
+               va_copy(ap_copy, ap);
+
+               int ret;
+               ret = vsnprintf(string, size, fmt, ap_copy);
+               
+               va_end(ap_copy);
+               
+               /* 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 */
+               size *= 2; /* double the buffer size */
        }
+       
+       /* the returned buffer is by principle guaranteed to be at least one character longer */
+       return string;
 }

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)