#include <stdlib.h>
#include <string.h>
#include <stdarg.h>
+#include <time.h>
int debug_level = -1;
static FILE* log_output;
+static log_callback_t *log_callbacks = NULL;
-static char *log_strings[4] =
+static time_t start;
+
+static char *log_strings[5] =
{
+ "User: ",
"Error: ",
"Warning:",
"Info: ",
- "Debug: ",
+ "Debug: "
};
-void log_printf(enum log_levels level, const char *file, int line, const char *function, const char *format, ...)
-{
- va_list args;
- char buffer[512];
+static int count = 0;
- if (level > debug_level)
+/* 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)
+{
+ if (level == LOG_OUTPUT)
+ {
+ /* do not prepend any headers, just print out what we were given and return */
+ fputs(string, log_output);
+ fflush(log_output);
return;
+ }
- va_start(args, format);
- vsnprintf(buffer, 512, format, args);
+ char *f = strrchr(file, '/');
+ if (f != NULL)
+ file = f + 1;
+
+ if (strchr(string, '\n')!=NULL)
+ {
+ 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
+ {
+ /* only entire lines are logged. Otherwise it's
+ * single chars intended for the log callbacks. */
+ }
- fprintf(log_output, "%s %s:%d %s(): %s\n", log_strings[level], file, line, function, buffer);
fflush(log_output);
- va_end(args);
+ /* Never forward LOG_DEBUG, too verbose and they can be found in the log if need be */
+ if (level <= LOG_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;
+ }
+ }
}
-void short_log_printf(enum log_levels level, const char *format, ...)
+void log_printf(enum log_levels level, const char *file, int line, const char *function, const char *format, ...)
{
- va_list args;
- char buffer[512];
+ char *string;
+ count++;
if (level > debug_level)
return;
- va_start(args, format);
- vsnprintf(buffer, 512, format, args);
+ va_list ap;
+ va_start(ap, format);
- fprintf(log_output, "%s %s\n", log_strings[level], buffer);
- fflush(log_output);
+ 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;
- va_end(args);
+ 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
int log_register_commands(struct command_context_s *cmd_ctx)
{
+ start = time(NULL);
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,
return ERROR_OK;
}
+
+int set_log_output(struct command_context_s *cmd_ctx, FILE *output)
+{
+ log_output = output;
+ return ERROR_OK;
+}
+
+/* add/remove log callback handler */
+int log_add_callback(log_callback_fn fn, void *priv)
+{
+ log_callback_t *cb;
+
+ /* prevent the same callback to be registered more than once, just for sure */
+ for (cb = log_callbacks; cb; cb = cb->next)
+ {
+ if (cb->fn == fn && cb->priv == priv)
+ return ERROR_INVALID_ARGUMENTS;
+ }
+
+ /* 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(log_callback_t))) == NULL)
+ return ERROR_BUF_TOO_SMALL;
+
+ /* add item to the beginning of the linked list */
+ cb->fn = fn;
+ cb->priv = priv;
+ cb->next = log_callbacks;
+ log_callbacks = cb;
+
+ return ERROR_OK;
+}
+
+int log_remove_callback(log_callback_fn fn, void *priv)
+{
+ log_callback_t *cb, **p;
+
+ for (p = &log_callbacks; (cb = *p); p = &(*p)->next)
+ {
+ if (cb->fn == fn && cb->priv == priv)
+ {
+ *p = cb->next;
+ free(cb);
+ return ERROR_OK;
+ }
+ }
+
+ /* no such item */
+ return ERROR_INVALID_ARGUMENTS;
+}
+
+/* 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 with buffer size suitable for typical messages */
+ int size = 128;
+
+ for (;;)
+ {
+ char *t = string;
+ string = realloc(string, size);
+ if (string == NULL)
+ {
+ if (t != NULL)
+ free(t);
+ return NULL;
+ }
+
+ 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;
+}
Code Review / openocd.git / blobdiff