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"
44 static FILE* log_output;
45 static log_callback_t *log_callbacks = NULL;
47 static long long last_time;
48 static long long current_time;
50 static long long start;
52 static char *log_strings[5] =
63 /* The log_puts() serves to somewhat different goals:
66 * - feeding low-level info to the user in GDB or Telnet
68 * The latter dictates that strings without newline are not logged, lest there
69 * will be *MANY log lines when sending one char at the time(e.g.
73 static void log_puts(enum log_levels level, const char *file, int line, const char *function, const char *string)
76 if (level == LOG_LVL_OUTPUT)
78 /* do not prepend any headers, just print out what we were given and return */
79 fputs(string, log_output);
84 f = strrchr(file, '/');
88 if (strchr(string, '\n')!=NULL)
90 if (debug_level >= LOG_LVL_DEBUG)
92 /* print with count and time information */
93 int t=(int)(timeval_ms()-start);
98 fprintf(log_output, "%s %d %d %s:%d %s()"
102 ": %s", log_strings[level+1], count, t, file, line, function,
110 if (strcmp(string, "\n")!=0)
112 /* print human readable output - but skip empty lines */
113 fprintf(log_output, "%s%s",
114 (level > LOG_LVL_USER)?log_strings[level+1]:"", string);
119 /* only entire lines are logged. Otherwise it's
120 * single chars intended for the log callbacks. */
125 /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
126 if (level <= LOG_LVL_INFO)
128 log_callback_t *cb, *next;
130 /* DANGER!!!! the log callback can remove itself!!!! */
134 cb->fn(cb->priv, file, line, function, string);
140 void log_printf(enum log_levels level, const char *file, int line, const char *function, const char *format, ...)
146 if (level > debug_level)
149 va_start(ap, format);
151 string = alloc_vprintf(format, ap);
154 log_puts(level, file, line, function, string);
161 void log_printf_lf(enum log_levels level, const char *file, int line, const char *function, const char *format, ...)
167 if (level > debug_level)
170 va_start(ap, format);
172 string = alloc_vprintf(format, ap);
175 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
176 log_puts(level, file, line, function, string);
183 /* change the current debug level on the fly
186 * 2: + INFORMATIONAL MSGS
189 int handle_debug_level_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
192 command_print(cmd_ctx, "debug_level: %i", debug_level);
195 debug_level = strtoul(args[0], NULL, 0);
206 int handle_log_output_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
210 FILE* file = fopen(args[0], "w");
221 int log_register_commands(struct command_context_s *cmd_ctx)
223 start = timeval_ms();
224 register_command(cmd_ctx, NULL, "log_output", handle_log_output_command,
225 COMMAND_ANY, "redirect logging to <file> (default: stderr)");
226 register_command(cmd_ctx, NULL, "debug_level", handle_debug_level_command,
227 COMMAND_ANY, "adjust debug level <0-3>");
232 int log_init(struct command_context_s *cmd_ctx)
234 /* set defaults for daemon configuration, if not set by cmdline or cfgfile */
235 if (debug_level == -1)
236 debug_level = LOG_LVL_INFO;
238 if (log_output == NULL)
243 start=last_time=timeval_ms();
248 int set_log_output(struct command_context_s *cmd_ctx, FILE *output)
254 /* add/remove log callback handler */
255 int log_add_callback(log_callback_fn fn, void *priv)
259 /* prevent the same callback to be registered more than once, just for sure */
260 for (cb = log_callbacks; cb; cb = cb->next)
262 if (cb->fn == fn && cb->priv == priv)
263 return ERROR_INVALID_ARGUMENTS;
266 /* alloc memory, it is safe just to return in case of an error, no need for the caller to check this */
267 if ((cb = malloc(sizeof(log_callback_t))) == NULL)
268 return ERROR_BUF_TOO_SMALL;
270 /* add item to the beginning of the linked list */
273 cb->next = log_callbacks;
279 int log_remove_callback(log_callback_fn fn, void *priv)
281 log_callback_t *cb, **p;
283 for (p = &log_callbacks; (cb = *p); p = &(*p)->next)
285 if (cb->fn == fn && cb->priv == priv)
294 return ERROR_INVALID_ARGUMENTS;
297 /* return allocated string w/printf() result */
298 char *alloc_vprintf(const char *fmt, va_list ap)
300 /* no buffer at the beginning, force realloc to do the job */
303 /* start with buffer size suitable for typical messages */
311 string = realloc(string, size);
319 va_copy(ap_copy, ap);
321 ret = vsnprintf(string, size, fmt, ap_copy);
322 /* NB! The result of the vsnprintf() might be an *EMPTY* string! */
323 if ((ret >= 0) && ((ret + 1) < size))
326 /* there was just enough or not enough space, allocate more in the next round */
327 size *= 2; /* double the buffer size */
330 /* the returned buffer is by principle guaranteed to be at least one character longer */
334 char *alloc_printf(const char *format, ...)
338 va_start(ap, format);
339 string = alloc_vprintf(format, ap);
344 /* Code must return to the server loop before 1000ms has returned or invoke
347 * The GDB connection will time out if it spends >2000ms and you'll get nasty
348 * error messages from GDB:
350 * Ignoring packet error, continuing...
351 * Reply contains invalid hex digit 116
353 * While it is possible use "set remotetimeout" to more than the default 2000ms
354 * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
355 * GDB protocol and it is a bug in OpenOCD not to either return to the server
356 * loop or invoke keep_alive() every 1000ms.
358 * This function will send a keep alive packet if >500ms has passed since last time
361 * Note that this function can be invoked often, so it needs to be relatively
362 * fast when invoked more often than every 500ms.
367 current_time=timeval_ms();
368 if (current_time-last_time>1000)
370 LOG_WARNING("BUG: keep_alive() was not invoked in the 1000ms timelimit. GDB alive packet not sent! (%lld)", current_time-last_time);
372 if (current_time-last_time>500)
374 /* this will keep the GDB connection alive */
375 LOG_USER_N("%s", "");
377 /* DANGER!!!! do not add code to invoke e.g. target event processing,
378 * jim timer processing, etc. it can cause infinite recursion +
379 * jim event callbacks need to happen at a well defined time,
380 * not anywhere keep_alive() is invoked.
382 * These functions should be invoked at a well defined spot in server.c
385 last_time=current_time;
389 /* reset keep alive timer without sending message */
392 current_time=timeval_ms();
393 last_time=current_time;
396 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittantly */
397 void alive_sleep(int ms)
400 for (i=0; i<ms; i+=500)
402 int sleep_a_bit=ms-i;
408 usleep(sleep_a_bit*1000);