1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007-2010 Ø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, see <http://www.gnu.org/licenses/>. *
23 ***************************************************************************/
31 #include "time_support.h"
35 #ifdef _DEBUG_FREE_SPACE_
39 #error "malloc.h is required to use --enable-malloc-logging"
45 static FILE *log_output;
46 static struct log_callback *log_callbacks;
48 static int64_t last_time;
49 static int64_t current_time;
53 static const char * const log_strings[5] = {
56 "Warn : ", /* want a space after each colon, all same width, colons aligned */
63 static struct store_log_forward *log_head;
64 static int log_forward_count;
66 struct store_log_forward {
67 struct store_log_forward *next;
74 /* either forward the log to the listeners or store it for possible forwarding later */
75 static void log_forward(const char *file, unsigned line, const char *function, const char *string)
77 if (log_forward_count == 0) {
78 struct log_callback *cb, *next;
80 /* DANGER!!!! the log callback can remove itself!!!! */
83 cb->fn(cb->priv, file, line, function, string);
87 struct store_log_forward *log = malloc(sizeof(struct store_log_forward));
88 log->file = strdup(file);
90 log->function = strdup(function);
91 log->string = strdup(string);
97 struct store_log_forward *t;
99 while (t->next != NULL)
106 /* The log_puts() serves to somewhat different goals:
109 * - feeding low-level info to the user in GDB or Telnet
111 * The latter dictates that strings without newline are not logged, lest there
112 * will be *MANY log lines when sending one char at the time(e.g.
116 static void log_puts(enum log_levels level,
119 const char *function,
123 if (level == LOG_LVL_OUTPUT) {
124 /* do not prepend any headers, just print out what we were given and return */
125 fputs(string, log_output);
130 f = strrchr(file, '/');
134 if (strlen(string) > 0) {
135 if (debug_level >= LOG_LVL_DEBUG) {
136 /* print with count and time information */
137 int64_t t = timeval_ms() - start;
138 #ifdef _DEBUG_FREE_SPACE_
139 struct mallinfo info;
142 fprintf(log_output, "%s%d %" PRId64 " %s:%d %s()"
143 #ifdef _DEBUG_FREE_SPACE_
146 ": %s", log_strings[level + 1], count, t, file, line, function,
147 #ifdef _DEBUG_FREE_SPACE_
152 /* if we are using gdb through pipes then we do not want any output
153 * to the pipe otherwise we get repeated strings */
154 fprintf(log_output, "%s%s",
155 (level > LOG_LVL_USER) ? log_strings[level + 1] : "", string);
158 /* Empty strings are sent to log callbacks to keep e.g. gdbserver alive, here we do
164 /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
165 if (level <= LOG_LVL_INFO)
166 log_forward(file, line, function, string);
169 void log_printf(enum log_levels level,
172 const char *function,
180 if (level > debug_level)
183 va_start(ap, format);
185 string = alloc_vprintf(format, ap);
186 if (string != NULL) {
187 log_puts(level, file, line, function, string);
194 void log_vprintf_lf(enum log_levels level, const char *file, unsigned line,
195 const char *function, const char *format, va_list args)
201 if (level > debug_level)
204 tmp = alloc_vprintf(format, args);
210 * Note: alloc_vprintf() guarantees that the buffer is at least one
214 log_puts(level, file, line, function, tmp);
218 void log_printf_lf(enum log_levels level,
221 const char *function,
227 va_start(ap, format);
228 log_vprintf_lf(level, file, line, function, format, ap);
232 COMMAND_HANDLER(handle_debug_level_command)
236 COMMAND_PARSE_NUMBER(int, CMD_ARGV[0], new_level);
237 if ((new_level > LOG_LVL_DEBUG) || (new_level < LOG_LVL_SILENT)) {
238 LOG_ERROR("level must be between %d and %d", LOG_LVL_SILENT, LOG_LVL_DEBUG);
239 return ERROR_COMMAND_SYNTAX_ERROR;
241 debug_level = new_level;
242 } else if (CMD_ARGC > 1)
243 return ERROR_COMMAND_SYNTAX_ERROR;
245 command_print(CMD_CTX, "debug_level: %i", debug_level);
250 COMMAND_HANDLER(handle_log_output_command)
253 FILE *file = fopen(CMD_ARGV[0], "w");
262 static struct command_registration log_command_handlers[] = {
264 .name = "log_output",
265 .handler = handle_log_output_command,
267 .help = "redirect logging to a file (default: stderr)",
268 .usage = "file_name",
271 .name = "debug_level",
272 .handler = handle_debug_level_command,
274 .help = "Sets the verbosity level of debugging output. "
275 "0 shows errors only; 1 adds warnings; "
276 "2 (default) adds other info; 3 adds debugging.",
279 COMMAND_REGISTRATION_DONE
282 int log_register_commands(struct command_context *cmd_ctx)
284 return register_commands(cmd_ctx, NULL, log_command_handlers);
289 /* set defaults for daemon configuration,
290 * if not set by cmdline or cfgfile */
291 if (debug_level == -1)
292 debug_level = LOG_LVL_INFO;
294 char *debug_env = getenv("OPENOCD_DEBUG_LEVEL");
295 if (NULL != debug_env) {
297 int retval = parse_int(debug_env, &value);
298 if (ERROR_OK == retval &&
299 debug_level >= LOG_LVL_SILENT &&
300 debug_level <= LOG_LVL_DEBUG)
304 if (log_output == NULL)
307 start = last_time = timeval_ms();
310 int set_log_output(struct command_context *cmd_ctx, FILE *output)
316 /* add/remove log callback handler */
317 int log_add_callback(log_callback_fn fn, void *priv)
319 struct log_callback *cb;
321 /* prevent the same callback to be registered more than once, just for sure */
322 for (cb = log_callbacks; cb; cb = cb->next) {
323 if (cb->fn == fn && cb->priv == priv)
324 return ERROR_COMMAND_SYNTAX_ERROR;
327 /* alloc memory, it is safe just to return in case of an error, no need for the caller to
329 cb = malloc(sizeof(struct log_callback));
331 return ERROR_BUF_TOO_SMALL;
333 /* add item to the beginning of the linked list */
336 cb->next = log_callbacks;
342 int log_remove_callback(log_callback_fn fn, void *priv)
344 struct log_callback *cb, **p;
346 for (p = &log_callbacks; (cb = *p); p = &(*p)->next) {
347 if (cb->fn == fn && cb->priv == priv) {
355 return ERROR_COMMAND_SYNTAX_ERROR;
358 /* return allocated string w/printf() result */
359 char *alloc_vprintf(const char *fmt, va_list ap)
365 /* determine the length of the buffer needed */
366 va_copy(ap_copy, ap);
367 len = vsnprintf(NULL, 0, fmt, ap_copy);
370 /* allocate and make room for terminating zero. */
371 /* FIXME: The old version always allocated at least one byte extra and
372 * other code depend on that. They should be probably be fixed, but for
373 * now reserve the extra byte. */
374 string = malloc(len + 2);
378 /* do the real work */
379 vsnprintf(string, len + 1, fmt, ap);
384 char *alloc_printf(const char *format, ...)
388 va_start(ap, format);
389 string = alloc_vprintf(format, ap);
394 /* Code must return to the server loop before 1000ms has returned or invoke
397 * The GDB connection will time out if it spends >2000ms and you'll get nasty
398 * error messages from GDB:
400 * Ignoring packet error, continuing...
401 * Reply contains invalid hex digit 116
403 * While it is possible use "set remotetimeout" to more than the default 2000ms
404 * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
405 * GDB protocol and it is a bug in OpenOCD not to either return to the server
406 * loop or invoke keep_alive() every 1000ms.
408 * This function will send a keep alive packet if >500ms has passed since last time
411 * Note that this function can be invoked often, so it needs to be relatively
412 * fast when invoked more often than every 500ms.
417 current_time = timeval_ms();
418 if (current_time-last_time > 1000) {
419 extern int gdb_actual_connections;
421 if (gdb_actual_connections)
422 LOG_WARNING("keep_alive() was not invoked in the "
423 "1000ms timelimit. GDB alive packet not "
424 "sent! (%" PRId64 "). Workaround: increase "
425 "\"set remotetimeout\" in GDB",
426 current_time-last_time);
428 LOG_DEBUG("keep_alive() was not invoked in the "
429 "1000ms timelimit (%" PRId64 "). This may cause "
430 "trouble with GDB connections.",
431 current_time-last_time);
433 if (current_time-last_time > 500) {
434 /* this will keep the GDB connection alive */
435 LOG_USER_N("%s", "");
437 /* DANGER!!!! do not add code to invoke e.g. target event processing,
438 * jim timer processing, etc. it can cause infinite recursion +
439 * jim event callbacks need to happen at a well defined time,
440 * not anywhere keep_alive() is invoked.
442 * These functions should be invoked at a well defined spot in server.c
445 last_time = current_time;
449 /* reset keep alive timer without sending message */
452 current_time = timeval_ms();
453 last_time = current_time;
456 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittantly */
457 void alive_sleep(uint64_t ms)
459 uint64_t napTime = 10;
460 for (uint64_t i = 0; i < ms; i += napTime) {
461 uint64_t sleep_a_bit = ms - i;
462 if (sleep_a_bit > napTime)
463 sleep_a_bit = napTime;
465 usleep(sleep_a_bit * 1000);
470 void busy_sleep(uint64_t ms)
472 uint64_t then = timeval_ms();
473 while (timeval_ms() - then < ms) {