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 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
31 #include "configuration.h"
32 #include "time_support.h"
47 static FILE* log_output;
48 static log_callback_t *log_callbacks = NULL;
50 static long long last_time;
51 static long long current_time;
53 static long long start;
55 static char *log_strings[5] =
66 /* The log_puts() serves to somewhat different goals:
69 * - feeding low-level info to the user in GDB or Telnet
71 * The latter dictates that strings without newline are not logged, lest there
72 * will be *MANY log lines when sending one char at the time(e.g.
76 static void log_puts(enum log_levels level, const char *file, int line, const char *function, const char *string)
79 if (level == LOG_LVL_OUTPUT)
81 /* do not prepend any headers, just print out what we were given and return */
82 fputs(string, log_output);
87 f = strrchr(file, '/');
91 if (strchr(string, '\n')!=NULL)
93 if (debug_level >= LOG_LVL_DEBUG)
95 /* print with count and time information */
96 int t=(int)(timeval_ms()-start);
101 fprintf(log_output, "%s %d %d %s:%d %s()"
105 ": %s", log_strings[level+1], count, t, file, line, function,
113 if (strcmp(string, "\n")!=0)
115 /* print human readable output - but skip empty lines */
116 fprintf(log_output, "%s%s",
117 (level > LOG_LVL_USER)?log_strings[level+1]:"", string);
122 /* only entire lines are logged. Otherwise it's
123 * single chars intended for the log callbacks. */
128 /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
129 if (level <= LOG_LVL_INFO)
131 log_callback_t *cb, *next;
133 /* DANGER!!!! the log callback can remove itself!!!! */
137 cb->fn(cb->priv, file, line, function, string);
143 void log_printf(enum log_levels level, const char *file, int line, const char *function, const char *format, ...)
149 if (level > debug_level)
152 va_start(ap, format);
154 string = alloc_vprintf(format, ap);
157 log_puts(level, file, line, function, string);
164 void log_printf_lf(enum log_levels level, const char *file, int line, const char *function, const char *format, ...)
170 if (level > debug_level)
173 va_start(ap, format);
175 string = alloc_vprintf(format, ap);
178 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
179 log_puts(level, file, line, function, string);
186 /* change the current debug level on the fly
189 * 2: + INFORMATIONAL MSGS
192 int handle_debug_level_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
195 command_print(cmd_ctx, "debug_level: %i", debug_level);
198 debug_level = strtoul(args[0], NULL, 0);
209 int handle_log_output_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
213 FILE* file = fopen(args[0], "w");
224 int log_register_commands(struct command_context_s *cmd_ctx)
226 start = timeval_ms();
227 register_command(cmd_ctx, NULL, "log_output", handle_log_output_command,
228 COMMAND_ANY, "redirect logging to <file> (default: stderr)");
229 register_command(cmd_ctx, NULL, "debug_level", handle_debug_level_command,
230 COMMAND_ANY, "adjust debug level <0-3>");
235 int log_init(struct command_context_s *cmd_ctx)
237 /* set defaults for daemon configuration, if not set by cmdline or cfgfile */
238 if (debug_level == -1)
239 debug_level = LOG_LVL_INFO;
241 if (log_output == NULL)
246 start=last_time=timeval_ms();
251 int set_log_output(struct command_context_s *cmd_ctx, FILE *output)
257 /* add/remove log callback handler */
258 int log_add_callback(log_callback_fn fn, void *priv)
262 /* prevent the same callback to be registered more than once, just for sure */
263 for (cb = log_callbacks; cb; cb = cb->next)
265 if (cb->fn == fn && cb->priv == priv)
266 return ERROR_INVALID_ARGUMENTS;
269 /* alloc memory, it is safe just to return in case of an error, no need for the caller to check this */
270 if ((cb = malloc(sizeof(log_callback_t))) == NULL)
271 return ERROR_BUF_TOO_SMALL;
273 /* add item to the beginning of the linked list */
276 cb->next = log_callbacks;
282 int log_remove_callback(log_callback_fn fn, void *priv)
284 log_callback_t *cb, **p;
286 for (p = &log_callbacks; (cb = *p); p = &(*p)->next)
288 if (cb->fn == fn && cb->priv == priv)
297 return ERROR_INVALID_ARGUMENTS;
300 /* return allocated string w/printf() result */
301 char *alloc_vprintf(const char *fmt, va_list ap)
303 /* no buffer at the beginning, force realloc to do the job */
306 /* start with buffer size suitable for typical messages */
314 string = realloc(string, size);
322 va_copy(ap_copy, ap);
324 ret = vsnprintf(string, size, fmt, ap_copy);
325 /* NB! The result of the vsnprintf() might be an *EMPTY* string! */
326 if ((ret >= 0) && ((ret + 1) < size))
329 /* there was just enough or not enough space, allocate more in the next round */
330 size *= 2; /* double the buffer size */
333 /* the returned buffer is by principle guaranteed to be at least one character longer */
337 char *alloc_printf(const char *format, ...)
341 va_start(ap, format);
342 string = alloc_vprintf(format, ap);
347 /* Code must return to the server loop before 1000ms has returned or invoke
350 * The GDB connection will time out if it spends >2000ms and you'll get nasty
351 * error messages from GDB:
353 * Ignoring packet error, continuing...
354 * Reply contains invalid hex digit 116
356 * While it is possible use "set remotetimeout" to more than the default 2000ms
357 * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
358 * GDB protocol and it is a bug in OpenOCD not to either return to the server
359 * loop or invoke keep_alive() every 1000ms.
361 * This function will send a keep alive packet if >500ms has passed since last time
364 * Note that this function can be invoked often, so it needs to be relatively
365 * fast when invoked more often than every 500ms.
370 current_time=timeval_ms();
371 if (current_time-last_time>1000)
373 LOG_WARNING("BUG: keep_alive() was not invoked in the 1000ms timelimit. GDB alive packet not sent! (%lld)", current_time-last_time);
375 if (current_time-last_time>500)
377 /* this will keep the GDB connection alive */
378 LOG_USER_N("%s", "");
380 /* DANGER!!!! do not add code to invoke e.g. target event processing,
381 * jim timer processing, etc. it can cause infinite recursion +
382 * jim event callbacks need to happen at a well defined time,
383 * not anywhere keep_alive() is invoked.
385 * These functions should be invoked at a well defined spot in server.c
388 last_time=current_time;
392 /* reset keep alive timer without sending message */
395 current_time=timeval_ms();
396 last_time=current_time;
399 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittantly */
400 void alive_sleep(int ms)
404 for (i=0; i<ms; i+=napTime)
406 int sleep_a_bit=ms-i;
407 if (sleep_a_bit>napTime)
411 usleep(sleep_a_bit*1000);
416 void busy_sleep(int ms)
420 while ((timeval_ms()-then)<ms)