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
290 * log file otherwise the pipe will get full and cause issues
293 FILE* file = fopen("openocd.log", "w");
297 LOG_WARNING("enabling logfile output because "
298 "we are using pipes to talk to GDB.");
302 command_print(CMD_CTX, "debug_level: %i", debug_level);
307 COMMAND_HANDLER(handle_log_output_command)
311 FILE* file = fopen(CMD_ARGV[0], "w");
322 static struct command_registration log_command_handlers[] = {
324 .name = "log_output",
325 .handler = handle_log_output_command,
327 .help = "redirect logging to a file (default: stderr)",
328 .usage = "file_name",
331 .name = "debug_level",
332 .handler = handle_debug_level_command,
334 .help = "Sets the verbosity level of debugging output. "
335 "0 shows errors only; 1 adds warnings; "
336 "2 (default) adds other info; 3 adds debugging.",
339 COMMAND_REGISTRATION_DONE
342 int log_register_commands(struct command_context *cmd_ctx)
344 return register_commands(cmd_ctx, NULL, log_command_handlers);
349 /* set defaults for daemon configuration,
350 * if not set by cmdline or cfgfile */
351 if (debug_level == -1)
352 debug_level = LOG_LVL_INFO;
354 char *debug_env = getenv("OPENOCD_DEBUG_LEVEL");
355 if (NULL != debug_env)
358 int retval = parse_int(debug_env, &value);
359 if (ERROR_OK == retval &&
360 debug_level >= LOG_LVL_SILENT &&
361 debug_level <= LOG_LVL_DEBUG)
367 if (log_output == NULL)
370 start = last_time = timeval_ms();
373 int set_log_output(struct command_context *cmd_ctx, FILE *output)
379 /* add/remove log callback handler */
380 int log_add_callback(log_callback_fn fn, void *priv)
382 struct log_callback *cb;
384 /* prevent the same callback to be registered more than once, just for sure */
385 for (cb = log_callbacks; cb; cb = cb->next)
387 if (cb->fn == fn && cb->priv == priv)
388 return ERROR_INVALID_ARGUMENTS;
391 /* alloc memory, it is safe just to return in case of an error, no need for the caller to check this */
392 if ((cb = malloc(sizeof(struct log_callback))) == NULL)
393 return ERROR_BUF_TOO_SMALL;
395 /* add item to the beginning of the linked list */
398 cb->next = log_callbacks;
404 int log_remove_callback(log_callback_fn fn, void *priv)
406 struct log_callback *cb, **p;
408 for (p = &log_callbacks; (cb = *p); p = &(*p)->next)
410 if (cb->fn == fn && cb->priv == priv)
419 return ERROR_INVALID_ARGUMENTS;
422 /* return allocated string w/printf() result */
423 char *alloc_vprintf(const char *fmt, va_list ap)
429 /* determine the length of the buffer needed */
430 va_copy(ap_copy, ap);
431 len = vsnprintf(NULL, 0, fmt, ap_copy);
434 /* allocate and make room for terminating zero. */
435 /* FIXME: The old version always allocated at least one byte extra and
436 * other code depend on that. They should be probably be fixed, but for
437 * now reserve the extra byte. */
438 string = malloc(len + 2);
442 /* do the real work */
443 vsnprintf(string, len + 1, fmt, ap);
448 char *alloc_printf(const char *format, ...)
452 va_start(ap, format);
453 string = alloc_vprintf(format, ap);
458 /* Code must return to the server loop before 1000ms has returned or invoke
461 * The GDB connection will time out if it spends >2000ms and you'll get nasty
462 * error messages from GDB:
464 * Ignoring packet error, continuing...
465 * Reply contains invalid hex digit 116
467 * While it is possible use "set remotetimeout" to more than the default 2000ms
468 * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
469 * GDB protocol and it is a bug in OpenOCD not to either return to the server
470 * loop or invoke keep_alive() every 1000ms.
472 * This function will send a keep alive packet if >500ms has passed since last time
475 * Note that this function can be invoked often, so it needs to be relatively
476 * fast when invoked more often than every 500ms.
481 current_time = timeval_ms();
482 if (current_time-last_time > 1000)
484 extern int gdb_actual_connections;
486 if (gdb_actual_connections)
487 LOG_WARNING("keep_alive() was not invoked in the "
488 "1000ms timelimit. GDB alive packet not "
489 "sent! (%lld). Workaround: increase "
490 "\"set remotetimeout\" in GDB",
491 current_time-last_time);
493 LOG_DEBUG("keep_alive() was not invoked in the "
494 "1000ms timelimit (%lld). This may cause "
495 "trouble with GDB connections.",
496 current_time-last_time);
498 if (current_time-last_time > 500)
500 /* this will keep the GDB connection alive */
501 LOG_USER_N("%s", "");
503 /* DANGER!!!! do not add code to invoke e.g. target event processing,
504 * jim timer processing, etc. it can cause infinite recursion +
505 * jim event callbacks need to happen at a well defined time,
506 * not anywhere keep_alive() is invoked.
508 * These functions should be invoked at a well defined spot in server.c
511 last_time = current_time;
515 /* reset keep alive timer without sending message */
518 current_time = timeval_ms();
519 last_time = current_time;
522 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittantly */
523 void alive_sleep(uint64_t ms)
525 uint64_t napTime = 10;
526 for (uint64_t i = 0; i < ms; i += napTime)
528 uint64_t sleep_a_bit = ms - i;
529 if (sleep_a_bit > napTime)
530 sleep_a_bit = napTime;
532 usleep(sleep_a_bit * 1000);
537 void busy_sleep(uint64_t ms)
539 uint64_t then = timeval_ms();
540 while (timeval_ms() - then < ms)