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 ***************************************************************************/
30 #include "time_support.h"
31 // @todo the inclusion of server.h here is a layering violation
32 #include <server/server.h>
36 #ifdef _DEBUG_FREE_SPACE_
40 #error "malloc.h is required to use --enable-malloc-logging"
46 static FILE* log_output
;
47 static struct log_callback
*log_callbacks
= NULL
;
49 static long long last_time
;
50 static long long current_time
;
52 static long long start
;
54 static char *log_strings
[5] =
58 "Warn : ", /* want a space after each colon, all same width, colons aligned */
67 static struct store_log_forward
* log_head
= NULL
;
68 static int log_forward_count
= 0;
70 struct store_log_forward
72 struct store_log_forward
* next
;
75 const char * function
;
79 /* either forward the log to the listeners or store it for possible forwarding later */
80 static void log_forward(const char *file
, unsigned line
, const char *function
, const char *string
)
82 if (log_forward_count
==0)
84 struct log_callback
*cb
, *next
;
86 /* DANGER!!!! the log callback can remove itself!!!! */
90 cb
->fn(cb
->priv
, file
, line
, function
, string
);
95 struct store_log_forward
*log
= malloc(sizeof (struct store_log_forward
));
96 log
->file
= strdup(file
);
98 log
->function
= strdup(function
);
99 log
->string
= strdup(string
);
106 struct store_log_forward
* t
;
108 while (t
->next
!=NULL
)
124 assert(log_forward_count
>0);
128 void log_rethrow(void)
131 if (log_forward_count
==0)
133 struct store_log_forward
*log
;
138 log_forward(log
->file
, log
->line
, log
->function
, log
->string
);
140 struct store_log_forward
*t
=log
;
143 free((void *)t
->file
);
144 free((void *)t
->function
);
145 free((void *)t
->string
);
155 /* The log_puts() serves to somewhat different goals:
158 * - feeding low-level info to the user in GDB or Telnet
160 * The latter dictates that strings without newline are not logged, lest there
161 * will be *MANY log lines when sending one char at the time(e.g.
165 static void log_puts(enum log_levels level
, const char *file
, int line
, const char *function
, const char *string
)
168 if (level
== LOG_LVL_OUTPUT
)
170 /* do not prepend any headers, just print out what we were given and return */
171 fputs(string
, log_output
);
176 f
= strrchr(file
, '/');
180 if (strchr(string
, '\n') != NULL
)
182 if (debug_level
>= LOG_LVL_DEBUG
)
184 /* print with count and time information */
185 int t
= (int)(timeval_ms()-start
);
186 #ifdef _DEBUG_FREE_SPACE_
187 struct mallinfo info
;
190 fprintf(log_output
, "%s%d %d %s:%d %s()"
191 #ifdef _DEBUG_FREE_SPACE_
194 ": %s", log_strings
[level
+ 1], count
, t
, file
, line
, function
,
195 #ifdef _DEBUG_FREE_SPACE_
200 else if (server_use_pipes
== 0)
202 /* if we are using gdb through pipes then we do not want any output
203 * to the pipe otherwise we get repeated strings */
204 if (strcmp(string
, "\n") != 0)
206 /* print human readable output - but skip empty lines */
207 fprintf(log_output
, "%s%s",
208 (level
> LOG_LVL_USER
)?log_strings
[level
+ 1]:"", string
);
213 /* only entire lines are logged. Otherwise it's
214 * single chars intended for the log callbacks. */
219 /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
220 if (level
<= LOG_LVL_INFO
)
222 log_forward(file
, line
, function
, string
);
227 void log_printf(enum log_levels level
, const char *file
, unsigned line
, const char *function
, const char *format
, ...)
233 if (level
> debug_level
)
236 va_start(ap
, format
);
238 string
= alloc_vprintf(format
, ap
);
241 log_puts(level
, file
, line
, function
, string
);
248 void log_printf_lf(enum log_levels level
, const char *file
, unsigned line
, const char *function
, const char *format
, ...)
254 if (level
> debug_level
)
257 va_start(ap
, format
);
259 string
= alloc_vprintf(format
, ap
);
262 strcat(string
, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
263 log_puts(level
, file
, line
, function
, string
);
270 /* change the current debug level on the fly
273 * 2: + INFORMATIONAL MSGS
276 COMMAND_HANDLER(handle_debug_level_command
)
281 COMMAND_PARSE_NUMBER(uint
, CMD_ARGV
[0], new_level
);
282 debug_level
= MIN(new_level
, LOG_LVL_DEBUG
);
284 else if (CMD_ARGC
> 1)
285 return ERROR_COMMAND_SYNTAX_ERROR
;
287 if (debug_level
>= LOG_LVL_DEBUG
&& server_use_pipes
== 1)
289 /* if we are enabling debug info then we need to write to a log file
290 * otherwise the pipe will get full and cause issues with gdb */
291 FILE* file
= fopen("openocd.log", "w");
295 LOG_WARNING("enabling log output as we are using pipes");
299 command_print(CMD_CTX
, "debug_level: %i", debug_level
);
304 COMMAND_HANDLER(handle_log_output_command
)
308 FILE* file
= fopen(CMD_ARGV
[0], "w");
319 static struct command_registration log_command_handlers
[] = {
321 .name
= "log_output",
322 .handler
= &handle_log_output_command
,
324 .help
= "redirect logging to a file (default: stderr)",
325 .usage
= "<file_name>",
328 .name
= "debug_level",
329 .handler
= &handle_debug_level_command
,
331 .help
= "sets the verbosity level of debugging output",
332 .usage
= "<level:0-3>",
334 COMMAND_REGISTRATION_DONE
337 int log_register_commands(struct command_context
*cmd_ctx
)
339 return register_commands(cmd_ctx
, NULL
, log_command_handlers
);
344 /* set defaults for daemon configuration,
345 * if not set by cmdline or cfgfile */
346 if (debug_level
== -1)
347 debug_level
= LOG_LVL_INFO
;
349 char *debug_env
= getenv("OPENOCD_DEBUG_LEVEL");
350 if (NULL
!= debug_env
)
353 int retval
= parse_int(debug_env
, &value
);
354 if (ERROR_OK
== retval
&&
355 debug_level
>= LOG_LVL_SILENT
&&
356 debug_level
<= LOG_LVL_DEBUG
)
362 if (log_output
== NULL
)
365 start
= last_time
= timeval_ms();
368 int set_log_output(struct command_context
*cmd_ctx
, FILE *output
)
374 /* add/remove log callback handler */
375 int log_add_callback(log_callback_fn fn
, void *priv
)
377 struct log_callback
*cb
;
379 /* prevent the same callback to be registered more than once, just for sure */
380 for (cb
= log_callbacks
; cb
; cb
= cb
->next
)
382 if (cb
->fn
== fn
&& cb
->priv
== priv
)
383 return ERROR_INVALID_ARGUMENTS
;
386 /* alloc memory, it is safe just to return in case of an error, no need for the caller to check this */
387 if ((cb
= malloc(sizeof(struct log_callback
))) == NULL
)
388 return ERROR_BUF_TOO_SMALL
;
390 /* add item to the beginning of the linked list */
393 cb
->next
= log_callbacks
;
399 int log_remove_callback(log_callback_fn fn
, void *priv
)
401 struct log_callback
*cb
, **p
;
403 for (p
= &log_callbacks
; (cb
= *p
); p
= &(*p
)->next
)
405 if (cb
->fn
== fn
&& cb
->priv
== priv
)
414 return ERROR_INVALID_ARGUMENTS
;
417 /* return allocated string w/printf() result */
418 char *alloc_vprintf(const char *fmt
, va_list ap
)
424 /* determine the length of the buffer needed */
425 va_copy(ap_copy
, ap
);
426 len
= vsnprintf(NULL
, 0, fmt
, ap_copy
);
429 /* allocate and make room for terminating zero. */
430 /* FIXME: The old version always allocated at least one byte extra and
431 * other code depend on that. They should be probably be fixed, but for
432 * now reserve the extra byte. */
433 string
= malloc(len
+ 2);
437 /* do the real work */
438 vsnprintf(string
, len
+ 1, fmt
, ap
);
443 char *alloc_printf(const char *format
, ...)
447 va_start(ap
, format
);
448 string
= alloc_vprintf(format
, ap
);
453 /* Code must return to the server loop before 1000ms has returned or invoke
456 * The GDB connection will time out if it spends >2000ms and you'll get nasty
457 * error messages from GDB:
459 * Ignoring packet error, continuing...
460 * Reply contains invalid hex digit 116
462 * While it is possible use "set remotetimeout" to more than the default 2000ms
463 * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
464 * GDB protocol and it is a bug in OpenOCD not to either return to the server
465 * loop or invoke keep_alive() every 1000ms.
467 * This function will send a keep alive packet if >500ms has passed since last time
470 * Note that this function can be invoked often, so it needs to be relatively
471 * fast when invoked more often than every 500ms.
476 current_time
= timeval_ms();
477 if (current_time
-last_time
> 1000)
479 extern int gdb_actual_connections
;
481 if (gdb_actual_connections
)
482 LOG_WARNING("keep_alive() was not invoked in the "
483 "1000ms timelimit. GDB alive packet not "
484 "sent! (%lld). Workaround: increase "
485 "\"set remotetimeout\" in GDB",
486 current_time
-last_time
);
488 LOG_DEBUG("keep_alive() was not invoked in the "
489 "1000ms timelimit (%lld). This may cause "
490 "trouble with GDB connections.",
491 current_time
-last_time
);
493 if (current_time
-last_time
> 500)
495 /* this will keep the GDB connection alive */
496 LOG_USER_N("%s", "");
498 /* DANGER!!!! do not add code to invoke e.g. target event processing,
499 * jim timer processing, etc. it can cause infinite recursion +
500 * jim event callbacks need to happen at a well defined time,
501 * not anywhere keep_alive() is invoked.
503 * These functions should be invoked at a well defined spot in server.c
506 last_time
= current_time
;
510 /* reset keep alive timer without sending message */
513 current_time
= timeval_ms();
514 last_time
= current_time
;
517 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittantly */
518 void alive_sleep(uint64_t ms
)
520 uint64_t napTime
= 10;
521 for (uint64_t i
= 0; i
< ms
; i
+= napTime
)
523 uint64_t sleep_a_bit
= ms
- i
;
524 if (sleep_a_bit
> napTime
)
525 sleep_a_bit
= napTime
;
527 usleep(sleep_a_bit
* 1000);
532 void busy_sleep(uint64_t ms
)
534 uint64_t then
= timeval_ms();
535 while (timeval_ms() - then
< ms
)