git.gag.com Git - fw/openocd/blob - src/helper/log.c

   1 /***************************************************************************
   2  *   Copyright (C) 2005 by Dominic Rath                                    *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007-2010 Øyvind Harboe                                 *
   6  *   oyvind.harboe@zylin.com                                               *
   7  *                                                                         *
   8  *   Copyright (C) 2008 by Spencer Oliver                                  *
   9  *   spen@spen-soft.co.uk                                                  *
  10  *                                                                         *
  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.                                   *
  15  *                                                                         *
  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.                          *
  20  *                                                                         *
  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  ***************************************************************************/
  24
  25 #ifdef HAVE_CONFIG_H
  26 #include "config.h"
  27 #endif
  28
  29 #include "log.h"
  30 #include "command.h"
  31 #include "replacements.h"
  32 #include "time_support.h"
  33 #include <server/server.h>
  34
  35 #include <stdarg.h>
  36
  37 #ifdef _DEBUG_FREE_SPACE_
  38 #ifdef HAVE_MALLOC_H
  39 #include <malloc.h>
  40 #else
  41 #error "malloc.h is required to use --enable-malloc-logging"
  42 #endif
  43 #endif
  44
  45 int debug_level = LOG_LVL_INFO;
  46
  47 static FILE *log_output;
  48 static struct log_callback *log_callbacks;
  49
  50 static int64_t last_time;
  51
  52 static int64_t start;
  53
  54 static const char * const log_strings[6] = {
  55         "User : ",
  56         "Error: ",
  57         "Warn : ",      /* want a space after each colon, all same width, colons aligned */
  58         "Info : ",
  59         "Debug: ",
  60         "Debug: "
  61 };
  62
  63 static int count;
  64
  65 /* forward the log to the listeners */
  66 static void log_forward(const char *file, unsigned line, const char *function, const char *string)
  67 {
  68         struct log_callback *cb, *next;
  69         cb = log_callbacks;
  70         /* DANGER!!!! the log callback can remove itself!!!! */
  71         while (cb) {
  72                 next = cb->next;
  73                 cb->fn(cb->priv, file, line, function, string);
  74                 cb = next;
  75         }
  76 }
  77
  78 /* The log_puts() serves two somewhat different goals:
  79  *
  80  * - logging
  81  * - feeding low-level info to the user in GDB or Telnet
  82  *
  83  * The latter dictates that strings without newline are not logged, lest there
  84  * will be *MANY log lines when sending one char at the time(e.g.
  85  * target_request.c).
  86  *
  87  */
  88 static void log_puts(enum log_levels level,
  89         const char *file,
  90         int line,
  91         const char *function,
  92         const char *string)
  93 {
  94         char *f;
  95
  96         if (!log_output) {
  97                 /* log_init() not called yet; print on stderr */
  98                 fputs(string, stderr);
  99                 fflush(stderr);
 100                 return;
 101         }
 102
 103         if (level == LOG_LVL_OUTPUT) {
 104                 /* do not prepend any headers, just print out what we were given and return */
 105                 fputs(string, log_output);
 106                 fflush(log_output);
 107                 return;
 108         }
 109
 110         f = strrchr(file, '/');
 111         if (f)
 112                 file = f + 1;
 113
 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;
 119                 info = mallinfo();
 120 #endif
 121                 fprintf(log_output, "%s%d %" PRId64 " %s:%d %s()"
 122 #ifdef _DEBUG_FREE_SPACE_
 123                         " %d"
 124 #endif
 125                         ": %s", log_strings[level + 1], count, t, file, line, function,
 126 #ifdef _DEBUG_FREE_SPACE_
 127                         info.fordblks,
 128 #endif
 129                         string);
 130         } else {
 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);
 135         }
 136
 137         fflush(log_output);
 138
 139         /* Never forward LOG_LVL_DEBUG, too verbose and they can be found in the log if need be */
 140         if (level <= LOG_LVL_INFO)
 141                 log_forward(file, line, function, string);
 142 }
 143
 144 void log_printf(enum log_levels level,
 145         const char *file,
 146         unsigned line,
 147         const char *function,
 148         const char *format,
 149         ...)
 150 {
 151         char *string;
 152         va_list ap;
 153
 154         count++;
 155         if (level > debug_level)
 156                 return;
 157
 158         va_start(ap, format);
 159
 160         string = alloc_vprintf(format, ap);
 161         if (string) {
 162                 log_puts(level, file, line, function, string);
 163                 free(string);
 164         }
 165
 166         va_end(ap);
 167 }
 168
 169 void log_vprintf_lf(enum log_levels level, const char *file, unsigned line,
 170                 const char *function, const char *format, va_list args)
 171 {
 172         char *tmp;
 173
 174         count++;
 175
 176         if (level > debug_level)
 177                 return;
 178
 179         tmp = alloc_vprintf(format, args);
 180
 181         if (!tmp)
 182                 return;
 183
 184         /*
 185          * Note: alloc_vprintf() guarantees that the buffer is at least one
 186          * character longer.
 187          */
 188         strcat(tmp, "\n");
 189         log_puts(level, file, line, function, tmp);
 190         free(tmp);
 191 }
 192
 193 void log_printf_lf(enum log_levels level,
 194         const char *file,
 195         unsigned line,
 196         const char *function,
 197         const char *format,
 198         ...)
 199 {
 200         va_list ap;
 201
 202         va_start(ap, format);
 203         log_vprintf_lf(level, file, line, function, format, ap);
 204         va_end(ap);
 205 }
 206
 207 COMMAND_HANDLER(handle_debug_level_command)
 208 {
 209         if (CMD_ARGC == 1) {
 210                 int new_level;
 211                 COMMAND_PARSE_NUMBER(int, CMD_ARGV[0], new_level);
 212                 if ((new_level > LOG_LVL_DEBUG_IO) || (new_level < LOG_LVL_SILENT)) {
 213                         LOG_ERROR("level must be between %d and %d", LOG_LVL_SILENT, LOG_LVL_DEBUG_IO);
 214                         return ERROR_COMMAND_SYNTAX_ERROR;
 215                 }
 216                 debug_level = new_level;
 217         } else if (CMD_ARGC > 1)
 218                 return ERROR_COMMAND_SYNTAX_ERROR;
 219
 220         command_print(CMD, "debug_level: %i", debug_level);
 221
 222         return ERROR_OK;
 223 }
 224
 225 COMMAND_HANDLER(handle_log_output_command)
 226 {
 227         if (CMD_ARGC == 0 || (CMD_ARGC == 1 && strcmp(CMD_ARGV[0], "default") == 0)) {
 228                 if (log_output != stderr && log_output) {
 229                         /* Close previous log file, if it was open and wasn't stderr. */
 230                         fclose(log_output);
 231                 }
 232                 log_output = stderr;
 233                 LOG_DEBUG("set log_output to default");
 234                 return ERROR_OK;
 235         }
 236         if (CMD_ARGC == 1) {
 237                 FILE *file = fopen(CMD_ARGV[0], "w");
 238                 if (!file) {
 239                         LOG_ERROR("failed to open output log '%s'", CMD_ARGV[0]);
 240                         return ERROR_FAIL;
 241                 }
 242                 if (log_output != stderr && log_output) {
 243                         /* Close previous log file, if it was open and wasn't stderr. */
 244                         fclose(log_output);
 245                 }
 246                 log_output = file;
 247                 LOG_DEBUG("set log_output to \"%s\"", CMD_ARGV[0]);
 248                 return ERROR_OK;
 249         }
 250
 251         return ERROR_COMMAND_SYNTAX_ERROR;
 252 }
 253
 254 static const struct command_registration log_command_handlers[] = {
 255         {
 256                 .name = "log_output",
 257                 .handler = handle_log_output_command,
 258                 .mode = COMMAND_ANY,
 259                 .help = "redirect logging to a file (default: stderr)",
 260                 .usage = "[file_name | \"default\"]",
 261         },
 262         {
 263                 .name = "debug_level",
 264                 .handler = handle_debug_level_command,
 265                 .mode = COMMAND_ANY,
 266                 .help = "Sets the verbosity level of debugging output. "
 267                         "0 shows errors only; 1 adds warnings; "
 268                         "2 (default) adds other info; 3 adds debugging; "
 269                         "4 adds extra verbose debugging.",
 270                 .usage = "number",
 271         },
 272         COMMAND_REGISTRATION_DONE
 273 };
 274
 275 int log_register_commands(struct command_context *cmd_ctx)
 276 {
 277         return register_commands(cmd_ctx, NULL, log_command_handlers);
 278 }
 279
 280 void log_init(void)
 281 {
 282         /* set defaults for daemon configuration,
 283          * if not set by cmdline or cfgfile */
 284         char *debug_env = getenv("OPENOCD_DEBUG_LEVEL");
 285         if (debug_env) {
 286                 int value;
 287                 int retval = parse_int(debug_env, &value);
 288                 if (retval == ERROR_OK &&
 289                                 debug_level >= LOG_LVL_SILENT &&
 290                                 debug_level <= LOG_LVL_DEBUG_IO)
 291                                 debug_level = value;
 292         }
 293
 294         if (!log_output)
 295                 log_output = stderr;
 296
 297         start = last_time = timeval_ms();
 298 }
 299
 300 void log_exit(void)
 301 {
 302         if (log_output && log_output != stderr) {
 303                 /* Close log file, if it was open and wasn't stderr. */
 304                 fclose(log_output);
 305         }
 306         log_output = NULL;
 307 }
 308
 309 int set_log_output(struct command_context *cmd_ctx, FILE *output)
 310 {
 311         log_output = output;
 312         return ERROR_OK;
 313 }
 314
 315 /* add/remove log callback handler */
 316 int log_add_callback(log_callback_fn fn, void *priv)
 317 {
 318         struct log_callback *cb;
 319
 320         /* prevent the same callback to be registered more than once, just for sure */
 321         for (cb = log_callbacks; cb; cb = cb->next) {
 322                 if (cb->fn == fn && cb->priv == priv)
 323                         return ERROR_COMMAND_SYNTAX_ERROR;
 324         }
 325
 326         /* alloc memory, it is safe just to return in case of an error, no need for the caller to
 327          *check this */
 328         cb = malloc(sizeof(struct log_callback));
 329         if (!cb)
 330                 return ERROR_BUF_TOO_SMALL;
 331
 332         /* add item to the beginning of the linked list */
 333         cb->fn = fn;
 334         cb->priv = priv;
 335         cb->next = log_callbacks;
 336         log_callbacks = cb;
 337
 338         return ERROR_OK;
 339 }
 340
 341 int log_remove_callback(log_callback_fn fn, void *priv)
 342 {
 343         struct log_callback *cb, **p;
 344
 345         for (p = &log_callbacks; (cb = *p); p = &(*p)->next) {
 346                 if (cb->fn == fn && cb->priv == priv) {
 347                         *p = cb->next;
 348                         free(cb);
 349                         return ERROR_OK;
 350                 }
 351         }
 352
 353         /* no such item */
 354         return ERROR_COMMAND_SYNTAX_ERROR;
 355 }
 356
 357 /* return allocated string w/printf() result */
 358 char *alloc_vprintf(const char *fmt, va_list ap)
 359 {
 360         va_list ap_copy;
 361         int len;
 362         char *string;
 363
 364         /* determine the length of the buffer needed */
 365         va_copy(ap_copy, ap);
 366         len = vsnprintf(NULL, 0, fmt, ap_copy);
 367         va_end(ap_copy);
 368
 369         /* allocate and make room for terminating zero. */
 370         /* FIXME: The old version always allocated at least one byte extra and
 371          * other code depend on that. They should be probably be fixed, but for
 372          * now reserve the extra byte. */
 373         string = malloc(len + 2);
 374         if (!string)
 375                 return NULL;
 376
 377         /* do the real work */
 378         vsnprintf(string, len + 1, fmt, ap);
 379
 380         return string;
 381 }
 382
 383 char *alloc_printf(const char *format, ...)
 384 {
 385         char *string;
 386         va_list ap;
 387         va_start(ap, format);
 388         string = alloc_vprintf(format, ap);
 389         va_end(ap);
 390         return string;
 391 }
 392
 393 /* Code must return to the server loop before 1000ms has returned or invoke
 394  * this function.
 395  *
 396  * The GDB connection will time out if it spends >2000ms and you'll get nasty
 397  * error messages from GDB:
 398  *
 399  * Ignoring packet error, continuing...
 400  * Reply contains invalid hex digit 116
 401  *
 402  * While it is possible use "set remotetimeout" to more than the default 2000ms
 403  * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
 404  * GDB protocol and it is a bug in OpenOCD not to either return to the server
 405  * loop or invoke keep_alive() every 1000ms.
 406  *
 407  * This function will send a keep alive packet if >500ms has passed since last time
 408  * it was invoked.
 409  *
 410  * Note that this function can be invoked often, so it needs to be relatively
 411  * fast when invoked more often than every 500ms.
 412  *
 413  */
 414 #define KEEP_ALIVE_KICK_TIME_MS  500
 415 #define KEEP_ALIVE_TIMEOUT_MS   1000
 416
 417 static void gdb_timeout_warning(int64_t delta_time)
 418 {
 419         extern int gdb_actual_connections;
 420
 421         if (gdb_actual_connections)
 422                 LOG_WARNING("keep_alive() was not invoked in the "
 423                         "%d ms timelimit. GDB alive packet not "
 424                         "sent! (%" PRId64 " ms). Workaround: increase "
 425                         "\"set remotetimeout\" in GDB",
 426                         KEEP_ALIVE_TIMEOUT_MS,
 427                         delta_time);
 428         else
 429                 LOG_DEBUG("keep_alive() was not invoked in the "
 430                         "%d ms timelimit (%" PRId64 " ms). This may cause "
 431                         "trouble with GDB connections.",
 432                         KEEP_ALIVE_TIMEOUT_MS,
 433                         delta_time);
 434 }
 435
 436 void keep_alive(void)
 437 {
 438         int64_t current_time = timeval_ms();
 439         int64_t delta_time = current_time - last_time;
 440
 441         if (delta_time > KEEP_ALIVE_TIMEOUT_MS) {
 442                 last_time = current_time;
 443
 444                 gdb_timeout_warning(delta_time);
 445         }
 446
 447         if (delta_time > KEEP_ALIVE_KICK_TIME_MS) {
 448                 last_time = current_time;
 449
 450                 /* this will keep the GDB connection alive */
 451                 server_keep_clients_alive();
 452
 453                 /* DANGER!!!! do not add code to invoke e.g. target event processing,
 454                  * jim timer processing, etc. it can cause infinite recursion +
 455                  * jim event callbacks need to happen at a well defined time,
 456                  * not anywhere keep_alive() is invoked.
 457                  *
 458                  * These functions should be invoked at a well defined spot in server.c
 459                  */
 460         }
 461 }
 462
 463 /* reset keep alive timer without sending message */
 464 void kept_alive(void)
 465 {
 466         int64_t current_time = timeval_ms();
 467
 468         int64_t delta_time = current_time - last_time;
 469
 470         last_time = current_time;
 471
 472         if (delta_time > KEEP_ALIVE_TIMEOUT_MS)
 473                 gdb_timeout_warning(delta_time);
 474 }
 475
 476 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittently */
 477 void alive_sleep(uint64_t ms)
 478 {
 479         uint64_t nap_time = 10;
 480         for (uint64_t i = 0; i < ms; i += nap_time) {
 481                 uint64_t sleep_a_bit = ms - i;
 482                 if (sleep_a_bit > nap_time)
 483                         sleep_a_bit = nap_time;
 484
 485                 usleep(sleep_a_bit * 1000);
 486                 keep_alive();
 487         }
 488 }
 489
 490 void busy_sleep(uint64_t ms)
 491 {
 492         uint64_t then = timeval_ms();
 493         while (timeval_ms() - then < ms) {
 494                 /*
 495                  * busy wait
 496                  */
 497         }
 498 }
 499
 500 /* Maximum size of socket error message retrieved from operation system */
 501 #define MAX_SOCKET_ERR_MSG_LENGTH 256
 502
 503 /* Provide log message for the last socket error.
 504    Uses errno on *nix and WSAGetLastError() on Windows */
 505 void log_socket_error(const char *socket_desc)
 506 {
 507         int error_code;
 508 #ifdef _WIN32
 509         error_code = WSAGetLastError();
 510         char error_message[MAX_SOCKET_ERR_MSG_LENGTH];
 511         error_message[0] = '\0';
 512         DWORD retval = FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM, NULL, error_code, 0,
 513                 error_message, MAX_SOCKET_ERR_MSG_LENGTH, NULL);
 514         error_message[MAX_SOCKET_ERR_MSG_LENGTH - 1] = '\0';
 515         const bool have_message = (retval != 0) && (error_message[0] != '\0');
 516         LOG_ERROR("Error on socket '%s': WSAGetLastError==%d%s%s.", socket_desc, error_code,
 517                 (have_message ? ", message: " : ""),
 518                 (have_message ? error_message : ""));
 519 #else
 520         error_code = errno;
 521         LOG_ERROR("Error on socket '%s': errno==%d, message: %s.", socket_desc, error_code, strerror(error_code));
 522 #endif
 523 }
 524
 525 /**
 526  * Find the first non-printable character in the char buffer, return a pointer to it.
 527  * If no such character exists, return NULL.
 528  */
 529 char *find_nonprint_char(char *buf, unsigned buf_len)
 530 {
 531         for (unsigned int i = 0; i < buf_len; i++) {
 532                 if (!isprint(buf[i]))
 533                         return buf + i;
 534         }
 535         return NULL;
 536 }