1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program; if not, write to the *
20 * Free Software Foundation, Inc., *
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
22 ***************************************************************************/
28 #include "configuration.h"
29 #include "time_support.h"
43 static FILE* log_output;
44 static log_callback_t *log_callbacks = NULL;
46 static long long last_time;
47 static long long current_time;
49 static long long start;
51 static char *log_strings[5] =
62 /* The log_puts() serves to somewhat different goals:
65 * - feeding low-level info to the user in GDB or Telnet
67 * The latter dictates that strings without newline are not logged, lest there
68 * will be *MANY log lines when sending one char at the time(e.g.
72 static void log_puts(enum log_levels level, const char *file, int line, const char *function, const char *string)
75 if (level == LOG_LVL_OUTPUT)
77 /* do not prepend any headers, just print out what we were given and return */
78 fputs(string, log_output);
83 f = strrchr(file, '/');
87 if (strchr(string, '\n')!=NULL)
89 if (debug_level >= LOG_LVL_DEBUG)
91 /* print with count and time information */
92 int t=(int)(timeval_ms()-start);
97 fprintf(log_output, "%s %d %d %s:%d %s()"
101 ": %s", log_strings[level+1], count, t, file, line, function,
109 /* print human readable output */
110 fprintf(log_output, "%s%s",
111 (level > LOG_LVL_USER)?log_strings[level+1]:"", string);
115 /* only entire lines are logged. Otherwise it's
116 * single chars intended for the log callbacks. */
121 /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
122 if (level <= LOG_LVL_INFO)
124 log_callback_t *cb, *next;
126 /* DANGER!!!! the log callback can remove itself!!!! */
130 cb->fn(cb->priv, file, line, function, string);
136 void log_printf(enum log_levels level, const char *file, int line, const char *function, const char *format, ...)
142 if (level > debug_level)
145 va_start(ap, format);
147 string = alloc_vprintf(format, ap);
150 log_puts(level, file, line, function, string);
157 void log_printf_lf(enum log_levels level, const char *file, int line, const char *function, const char *format, ...)
163 if (level > debug_level)
166 va_start(ap, format);
168 string = alloc_vprintf(format, ap);
171 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
172 log_puts(level, file, line, function, string);
179 /* change the current debug level on the fly
182 * 2: + INFORMATIONAL MSGS
185 int handle_debug_level_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
188 command_print(cmd_ctx, "debug_level: %i", debug_level);
191 debug_level = strtoul(args[0], NULL, 0);
202 int handle_log_output_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
206 FILE* file = fopen(args[0], "w");
217 int log_register_commands(struct command_context_s *cmd_ctx)
219 start = timeval_ms();
220 register_command(cmd_ctx, NULL, "log_output", handle_log_output_command,
221 COMMAND_ANY, "redirect logging to <file> (default: stderr)");
222 register_command(cmd_ctx, NULL, "debug_level", handle_debug_level_command,
223 COMMAND_ANY, "adjust debug level <0-3>");
228 int log_init(struct command_context_s *cmd_ctx)
230 /* set defaults for daemon configuration, if not set by cmdline or cfgfile */
231 if (debug_level == -1)
232 debug_level = LOG_LVL_INFO;
234 if (log_output == NULL)
239 start=last_time=timeval_ms();
244 int set_log_output(struct command_context_s *cmd_ctx, FILE *output)
250 /* add/remove log callback handler */
251 int log_add_callback(log_callback_fn fn, void *priv)
255 /* prevent the same callback to be registered more than once, just for sure */
256 for (cb = log_callbacks; cb; cb = cb->next)
258 if (cb->fn == fn && cb->priv == priv)
259 return ERROR_INVALID_ARGUMENTS;
262 /* alloc memory, it is safe just to return in case of an error, no need for the caller to check this */
263 if ((cb = malloc(sizeof(log_callback_t))) == NULL)
264 return ERROR_BUF_TOO_SMALL;
266 /* add item to the beginning of the linked list */
269 cb->next = log_callbacks;
275 int log_remove_callback(log_callback_fn fn, void *priv)
277 log_callback_t *cb, **p;
279 for (p = &log_callbacks; (cb = *p); p = &(*p)->next)
281 if (cb->fn == fn && cb->priv == priv)
290 return ERROR_INVALID_ARGUMENTS;
293 /* return allocated string w/printf() result */
294 char *alloc_vprintf(const char *fmt, va_list ap)
296 /* no buffer at the beginning, force realloc to do the job */
299 /* start with buffer size suitable for typical messages */
307 string = realloc(string, size);
315 va_copy(ap_copy, ap);
317 ret = vsnprintf(string, size, fmt, ap_copy);
318 /* NB! The result of the vsnprintf() might be an *EMPTY* string! */
319 if ((ret >= 0) && ((ret + 1) < size))
322 /* there was just enough or not enough space, allocate more in the next round */
323 size *= 2; /* double the buffer size */
326 /* the returned buffer is by principle guaranteed to be at least one character longer */
330 char *alloc_printf(const char *format, ...)
334 va_start(ap, format);
335 string = alloc_vprintf(format, ap);
340 /* Code must return to the server loop before 1000ms has returned or invoke
343 * The GDB connection will time out if it spends >2000ms and you'll get nasty
344 * error messages from GDB:
346 * Ignoring packet error, continuing...
347 * Reply contains invalid hex digit 116
349 * While it is possible use "set remotetimeout" to more than the default 2000ms
350 * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
351 * GDB protocol and it is a bug in OpenOCD not to either return to the server
352 * loop or invoke keep_alive() every 1000ms.
354 * This function will send a keep alive packet if >500ms has passed since last time
360 current_time=timeval_ms();
361 if (current_time-last_time>1000)
363 LOG_WARNING("BUG: keep_alive() was not invoked in the 1000ms timelimit. GDB alive packet not sent! (%lld)", current_time-last_time);
364 last_time=current_time;
365 } else if (current_time-last_time>500)
367 /* this will keep the GDB connection alive */
368 LOG_USER_N("%s", "");
369 last_time=current_time;
373 /* reset keep alive timer without sending message */
376 current_time=timeval_ms();
377 last_time=current_time;