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 "time_support.h"
32 // @todo the inclusion of server.h here is a layering violation
37 #ifdef _DEBUG_FREE_SPACE_
41 #error "malloc.h is required to use --enable-malloc-logging"
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] =
59 "Warn : ", /* want a space after each colon, all same width, colons aligned */
67 /* The log_puts() serves to somewhat different goals:
70 * - feeding low-level info to the user in GDB or Telnet
72 * The latter dictates that strings without newline are not logged, lest there
73 * will be *MANY log lines when sending one char at the time(e.g.
77 static void log_puts(enum log_levels level
, const char *file
, int line
, const char *function
, const char *string
)
80 if (level
== LOG_LVL_OUTPUT
)
82 /* do not prepend any headers, just print out what we were given and return */
83 fputs(string
, log_output
);
88 f
= strrchr(file
, '/');
92 if (strchr(string
, '\n') != NULL
)
94 if (debug_level
>= LOG_LVL_DEBUG
)
96 /* print with count and time information */
97 int t
= (int)(timeval_ms()-start
);
98 #ifdef _DEBUG_FREE_SPACE_
102 fprintf(log_output
, "%s%d %d %s:%d %s()"
103 #ifdef _DEBUG_FREE_SPACE_
106 ": %s", log_strings
[level
+ 1], count
, t
, file
, line
, function
,
107 #ifdef _DEBUG_FREE_SPACE_
112 else if (server_use_pipes
== 0)
114 /* if we are using gdb through pipes then we do not want any output
115 * to the pipe otherwise we get repeated strings */
116 if (strcmp(string
, "\n") != 0)
118 /* print human readable output - but skip empty lines */
119 fprintf(log_output
, "%s%s",
120 (level
> LOG_LVL_USER
)?log_strings
[level
+ 1]:"", string
);
125 /* only entire lines are logged. Otherwise it's
126 * single chars intended for the log callbacks. */
131 /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
132 if (level
<= LOG_LVL_INFO
)
134 log_callback_t
*cb
, *next
;
136 /* DANGER!!!! the log callback can remove itself!!!! */
140 cb
->fn(cb
->priv
, file
, line
, function
, string
);
146 void log_printf(enum log_levels level
, const char *file
, int line
, const char *function
, const char *format
, ...)
152 if (level
> debug_level
)
155 va_start(ap
, format
);
157 string
= alloc_vprintf(format
, ap
);
160 log_puts(level
, file
, line
, function
, string
);
167 void log_printf_lf(enum log_levels level
, const char *file
, int line
, const char *function
, const char *format
, ...)
173 if (level
> debug_level
)
176 va_start(ap
, format
);
178 string
= alloc_vprintf(format
, ap
);
181 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
182 log_puts(level
, file
, line
, function
, string
);
189 /* change the current debug level on the fly
192 * 2: + INFORMATIONAL MSGS
195 int handle_debug_level_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
200 int retval
= parse_uint(args
[0], &new_level
);
201 if (ERROR_OK
!= retval
)
203 debug_level
= MIN(new_level
, LOG_LVL_DEBUG
);
206 return ERROR_COMMAND_SYNTAX_ERROR
;
208 if (debug_level
>= LOG_LVL_DEBUG
&& server_use_pipes
== 1)
210 /* if we are enabling debug info then we need to write to a log file
211 * otherwise the pipe will get full and cause issues with gdb */
212 FILE* file
= fopen("openocd.log", "w");
216 LOG_WARNING("enabling log output as we are using pipes");
220 command_print(cmd_ctx
, "debug_level: %i", debug_level
);
225 int handle_log_output_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
229 FILE* file
= fopen(args
[0], "w");
240 int log_register_commands(struct command_context_s
*cmd_ctx
)
242 start
= timeval_ms();
243 register_command(cmd_ctx
, NULL
, "log_output", handle_log_output_command
,
244 COMMAND_ANY
, "redirect logging to <file> (default: stderr)");
245 register_command(cmd_ctx
, NULL
, "debug_level", handle_debug_level_command
,
246 COMMAND_ANY
, "adjust debug level <0-3>");
251 int log_init(struct command_context_s
*cmd_ctx
)
253 /* set defaults for daemon configuration, if not set by cmdline or cfgfile */
254 if (debug_level
== -1)
255 debug_level
= LOG_LVL_INFO
;
257 if (log_output
== NULL
)
262 start
= last_time
= timeval_ms();
267 int set_log_output(struct command_context_s
*cmd_ctx
, FILE *output
)
273 /* add/remove log callback handler */
274 int log_add_callback(log_callback_fn fn
, void *priv
)
278 /* prevent the same callback to be registered more than once, just for sure */
279 for (cb
= log_callbacks
; cb
; cb
= cb
->next
)
281 if (cb
->fn
== fn
&& cb
->priv
== priv
)
282 return ERROR_INVALID_ARGUMENTS
;
285 /* alloc memory, it is safe just to return in case of an error, no need for the caller to check this */
286 if ((cb
= malloc(sizeof(log_callback_t
))) == NULL
)
287 return ERROR_BUF_TOO_SMALL
;
289 /* add item to the beginning of the linked list */
292 cb
->next
= log_callbacks
;
298 int log_remove_callback(log_callback_fn fn
, void *priv
)
300 log_callback_t
*cb
, **p
;
302 for (p
= &log_callbacks
; (cb
= *p
); p
= &(*p
)->next
)
304 if (cb
->fn
== fn
&& cb
->priv
== priv
)
313 return ERROR_INVALID_ARGUMENTS
;
316 /* return allocated string w/printf() result */
317 char *alloc_vprintf(const char *fmt
, va_list ap
)
319 /* no buffer at the beginning, force realloc to do the job */
322 /* start with buffer size suitable for typical messages */
330 string
= realloc(string
, size
);
338 va_copy(ap_copy
, ap
);
340 ret
= vsnprintf(string
, size
, fmt
, ap_copy
);
341 /* NB! The result of the vsnprintf() might be an *EMPTY* string! */
342 if ((ret
>= 0) && ((ret
+ 1) < size
))
345 /* there was just enough or not enough space, allocate more in the next round */
346 size
*= 2; /* double the buffer size */
349 /* the returned buffer is by principle guaranteed to be at least one character longer */
353 char *alloc_printf(const char *format
, ...)
357 va_start(ap
, format
);
358 string
= alloc_vprintf(format
, ap
);
363 /* Code must return to the server loop before 1000ms has returned or invoke
366 * The GDB connection will time out if it spends >2000ms and you'll get nasty
367 * error messages from GDB:
369 * Ignoring packet error, continuing...
370 * Reply contains invalid hex digit 116
372 * While it is possible use "set remotetimeout" to more than the default 2000ms
373 * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
374 * GDB protocol and it is a bug in OpenOCD not to either return to the server
375 * loop or invoke keep_alive() every 1000ms.
377 * This function will send a keep alive packet if >500ms has passed since last time
380 * Note that this function can be invoked often, so it needs to be relatively
381 * fast when invoked more often than every 500ms.
386 current_time
= timeval_ms();
387 if (current_time
-last_time
> 1000)
389 extern int gdb_actual_connections
;
391 if (gdb_actual_connections
)
392 LOG_WARNING("keep_alive() was not invoked in the "
393 "1000ms timelimit. GDB alive packet not "
394 "sent! (%lld). Workaround: increase "
395 "\"set remotetimeout\" in GDB",
396 current_time
-last_time
);
398 LOG_DEBUG("keep_alive() was not invoked in the "
399 "1000ms timelimit (%lld). This may cause "
400 "trouble with GDB connections.",
401 current_time
-last_time
);
403 if (current_time
-last_time
> 500)
405 /* this will keep the GDB connection alive */
406 LOG_USER_N("%s", "");
408 /* DANGER!!!! do not add code to invoke e.g. target event processing,
409 * jim timer processing, etc. it can cause infinite recursion +
410 * jim event callbacks need to happen at a well defined time,
411 * not anywhere keep_alive() is invoked.
413 * These functions should be invoked at a well defined spot in server.c
416 last_time
= current_time
;
420 /* reset keep alive timer without sending message */
423 current_time
= timeval_ms();
424 last_time
= current_time
;
427 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittantly */
428 void alive_sleep(int ms
)
432 for (i
= 0; i
< ms
; i
+= napTime
)
434 int sleep_a_bit
= ms
-i
;
435 if (sleep_a_bit
> napTime
)
437 sleep_a_bit
= napTime
;
439 usleep(sleep_a_bit
*1000);
444 void busy_sleep(int ms
)
448 while ((timeval_ms()-then
) < ms
)