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"
43 int debug_level = LOG_LVL_INFO;
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[6] = {
56 "Warn : ", /* want a space after each colon, all same width, colons aligned */
64 /* forward the log to the listeners */
65 static void log_forward(const char *file, unsigned line, const char *function, const char *string)
67 struct log_callback *cb, *next;
69 /* DANGER!!!! the log callback can remove itself!!!! */
72 cb->fn(cb->priv, file, line, function, string);
77 /* The log_puts() serves two somewhat different goals:
80 * - feeding low-level info to the user in GDB or Telnet
82 * The latter dictates that strings without newline are not logged, lest there
83 * will be *MANY log lines when sending one char at the time(e.g.
87 static void log_puts(enum log_levels level,
96 /* log_init() not called yet; print on stderr */
97 fputs(string, stderr);
102 if (level == LOG_LVL_OUTPUT) {
103 /* do not prepend any headers, just print out what we were given and return */
104 fputs(string, log_output);
109 f = strrchr(file, '/');
113 if (strlen(string) > 0) {
114 if (debug_level >= LOG_LVL_DEBUG) {
115 /* print with count and time information */
116 int64_t t = timeval_ms() - start;
117 #ifdef _DEBUG_FREE_SPACE_
118 struct mallinfo info;
121 fprintf(log_output, "%s%d %" PRId64 " %s:%d %s()"
122 #ifdef _DEBUG_FREE_SPACE_
125 ": %s", log_strings[level + 1], count, t, file, line, function,
126 #ifdef _DEBUG_FREE_SPACE_
131 /* if we are using gdb through pipes then we do not want any output
132 * to the pipe otherwise we get repeated strings */
133 fprintf(log_output, "%s%s",
134 (level > LOG_LVL_USER) ? log_strings[level + 1] : "", string);
137 /* Empty strings are sent to log callbacks to keep e.g. gdbserver alive, here we do
143 /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
144 if (level <= LOG_LVL_INFO)
145 log_forward(file, line, function, string);
148 void log_printf(enum log_levels level,
151 const char *function,
159 if (level > debug_level)
162 va_start(ap, format);
164 string = alloc_vprintf(format, ap);
165 if (string != NULL) {
166 log_puts(level, file, line, function, string);
173 void log_vprintf_lf(enum log_levels level, const char *file, unsigned line,
174 const char *function, const char *format, va_list args)
180 if (level > debug_level)
183 tmp = alloc_vprintf(format, args);
189 * Note: alloc_vprintf() guarantees that the buffer is at least one
193 log_puts(level, file, line, function, tmp);
197 void log_printf_lf(enum log_levels level,
200 const char *function,
206 va_start(ap, format);
207 log_vprintf_lf(level, file, line, function, format, ap);
211 COMMAND_HANDLER(handle_debug_level_command)
215 COMMAND_PARSE_NUMBER(int, CMD_ARGV[0], new_level);
216 if ((new_level > LOG_LVL_DEBUG_IO) || (new_level < LOG_LVL_SILENT)) {
217 LOG_ERROR("level must be between %d and %d", LOG_LVL_SILENT, LOG_LVL_DEBUG_IO);
218 return ERROR_COMMAND_SYNTAX_ERROR;
220 debug_level = new_level;
221 } else if (CMD_ARGC > 1)
222 return ERROR_COMMAND_SYNTAX_ERROR;
224 command_print(CMD, "debug_level: %i", debug_level);
229 COMMAND_HANDLER(handle_log_output_command)
231 if (CMD_ARGC == 0 || (CMD_ARGC == 1 && strcmp(CMD_ARGV[0], "default") == 0)) {
232 if (log_output != stderr && log_output != NULL) {
233 /* Close previous log file, if it was open and wasn't stderr. */
237 LOG_DEBUG("set log_output to default");
241 FILE *file = fopen(CMD_ARGV[0], "w");
243 LOG_ERROR("failed to open output log '%s'", CMD_ARGV[0]);
246 if (log_output != stderr && log_output != NULL) {
247 /* Close previous log file, if it was open and wasn't stderr. */
251 LOG_DEBUG("set log_output to \"%s\"", CMD_ARGV[0]);
255 return ERROR_COMMAND_SYNTAX_ERROR;
258 static const struct command_registration log_command_handlers[] = {
260 .name = "log_output",
261 .handler = handle_log_output_command,
263 .help = "redirect logging to a file (default: stderr)",
264 .usage = "[file_name | \"default\"]",
267 .name = "debug_level",
268 .handler = handle_debug_level_command,
270 .help = "Sets the verbosity level of debugging output. "
271 "0 shows errors only; 1 adds warnings; "
272 "2 (default) adds other info; 3 adds debugging; "
273 "4 adds extra verbose debugging.",
276 COMMAND_REGISTRATION_DONE
279 int log_register_commands(struct command_context *cmd_ctx)
281 return register_commands(cmd_ctx, NULL, log_command_handlers);
286 /* set defaults for daemon configuration,
287 * if not set by cmdline or cfgfile */
288 char *debug_env = getenv("OPENOCD_DEBUG_LEVEL");
289 if (NULL != debug_env) {
291 int retval = parse_int(debug_env, &value);
292 if (ERROR_OK == retval &&
293 debug_level >= LOG_LVL_SILENT &&
294 debug_level <= LOG_LVL_DEBUG_IO)
298 if (log_output == NULL)
301 start = last_time = timeval_ms();
304 int set_log_output(struct command_context *cmd_ctx, FILE *output)
310 /* add/remove log callback handler */
311 int log_add_callback(log_callback_fn fn, void *priv)
313 struct log_callback *cb;
315 /* prevent the same callback to be registered more than once, just for sure */
316 for (cb = log_callbacks; cb; cb = cb->next) {
317 if (cb->fn == fn && cb->priv == priv)
318 return ERROR_COMMAND_SYNTAX_ERROR;
321 /* alloc memory, it is safe just to return in case of an error, no need for the caller to
323 cb = malloc(sizeof(struct log_callback));
325 return ERROR_BUF_TOO_SMALL;
327 /* add item to the beginning of the linked list */
330 cb->next = log_callbacks;
336 int log_remove_callback(log_callback_fn fn, void *priv)
338 struct log_callback *cb, **p;
340 for (p = &log_callbacks; (cb = *p); p = &(*p)->next) {
341 if (cb->fn == fn && cb->priv == priv) {
349 return ERROR_COMMAND_SYNTAX_ERROR;
352 /* return allocated string w/printf() result */
353 char *alloc_vprintf(const char *fmt, va_list ap)
359 /* determine the length of the buffer needed */
360 va_copy(ap_copy, ap);
361 len = vsnprintf(NULL, 0, fmt, ap_copy);
364 /* allocate and make room for terminating zero. */
365 /* FIXME: The old version always allocated at least one byte extra and
366 * other code depend on that. They should be probably be fixed, but for
367 * now reserve the extra byte. */
368 string = malloc(len + 2);
372 /* do the real work */
373 vsnprintf(string, len + 1, fmt, ap);
378 char *alloc_printf(const char *format, ...)
382 va_start(ap, format);
383 string = alloc_vprintf(format, ap);
388 /* Code must return to the server loop before 1000ms has returned or invoke
391 * The GDB connection will time out if it spends >2000ms and you'll get nasty
392 * error messages from GDB:
394 * Ignoring packet error, continuing...
395 * Reply contains invalid hex digit 116
397 * While it is possible use "set remotetimeout" to more than the default 2000ms
398 * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
399 * GDB protocol and it is a bug in OpenOCD not to either return to the server
400 * loop or invoke keep_alive() every 1000ms.
402 * This function will send a keep alive packet if >500ms has passed since last time
405 * Note that this function can be invoked often, so it needs to be relatively
406 * fast when invoked more often than every 500ms.
409 #define KEEP_ALIVE_KICK_TIME_MS 500
410 #define KEEP_ALIVE_TIMEOUT_MS 1000
412 static void gdb_timeout_warning(int64_t delta_time)
414 extern int gdb_actual_connections;
416 if (gdb_actual_connections)
417 LOG_WARNING("keep_alive() was not invoked in the "
418 "%d ms timelimit. GDB alive packet not "
419 "sent! (%" PRId64 " ms). Workaround: increase "
420 "\"set remotetimeout\" in GDB",
421 KEEP_ALIVE_TIMEOUT_MS,
424 LOG_DEBUG("keep_alive() was not invoked in the "
425 "%d ms timelimit (%" PRId64 " ms). This may cause "
426 "trouble with GDB connections.",
427 KEEP_ALIVE_TIMEOUT_MS,
431 void keep_alive(void)
433 current_time = timeval_ms();
435 int64_t delta_time = current_time - last_time;
437 if (delta_time > KEEP_ALIVE_TIMEOUT_MS) {
438 last_time = current_time;
440 gdb_timeout_warning(delta_time);
443 if (delta_time > KEEP_ALIVE_KICK_TIME_MS) {
444 last_time = current_time;
446 /* this will keep the GDB connection alive */
447 LOG_USER_N("%s", "");
449 /* DANGER!!!! do not add code to invoke e.g. target event processing,
450 * jim timer processing, etc. it can cause infinite recursion +
451 * jim event callbacks need to happen at a well defined time,
452 * not anywhere keep_alive() is invoked.
454 * These functions should be invoked at a well defined spot in server.c
459 /* reset keep alive timer without sending message */
460 void kept_alive(void)
462 current_time = timeval_ms();
464 int64_t delta_time = current_time - last_time;
466 last_time = current_time;
468 if (delta_time > KEEP_ALIVE_TIMEOUT_MS)
469 gdb_timeout_warning(delta_time);
472 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittently */
473 void alive_sleep(uint64_t ms)
475 uint64_t napTime = 10;
476 for (uint64_t i = 0; i < ms; i += napTime) {
477 uint64_t sleep_a_bit = ms - i;
478 if (sleep_a_bit > napTime)
479 sleep_a_bit = napTime;
481 usleep(sleep_a_bit * 1000);
486 void busy_sleep(uint64_t ms)
488 uint64_t then = timeval_ms();
489 while (timeval_ms() - then < ms) {
496 /* Maximum size of socket error message retrieved from operation system */
497 #define MAX_SOCKET_ERR_MSG_LENGTH 256
499 /* Provide log message for the last socket error.
500 Uses errno on *nix and WSAGetLastError() on Windows */
501 void log_socket_error(const char *socket_desc)
505 error_code = WSAGetLastError();
506 char error_message[MAX_SOCKET_ERR_MSG_LENGTH];
507 error_message[0] = '\0';
508 DWORD retval = FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM, NULL, error_code, 0,
509 error_message, MAX_SOCKET_ERR_MSG_LENGTH, NULL);
510 error_message[MAX_SOCKET_ERR_MSG_LENGTH - 1] = '\0';
511 const bool have_message = (retval != 0) && (error_message[0] != '\0');
512 LOG_ERROR("Error on socket '%s': WSAGetLastError==%d%s%s.", socket_desc, error_code,
513 (have_message ? ", message: " : ""),
514 (have_message ? error_message : ""));
517 LOG_ERROR("Error on socket '%s': errno==%d, message: %s.", socket_desc, error_code, strerror(error_code));