git.sur5r.net Git - 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 "time_support.h"
  32
  33 #include <stdarg.h>
  34
  35 #ifdef _DEBUG_FREE_SPACE_
  36 #ifdef HAVE_MALLOC_H
  37 #include <malloc.h>
  38 #else
  39 #error "malloc.h is required to use --enable-malloc-logging"
  40 #endif
  41 #endif
  42
  43 int debug_level = -1;
  44
  45 static FILE *log_output;
  46 static struct log_callback *log_callbacks;
  47
  48 static int64_t last_time;
  49 static int64_t current_time;
  50
  51 static int64_t start;
  52
  53 static const char * const log_strings[5] = {
  54         "User : ",
  55         "Error: ",
  56         "Warn : ",      /* want a space after each colon, all same width, colons aligned */
  57         "Info : ",
  58         "Debug: "
  59 };
  60
  61 static int count;
  62
  63 static struct store_log_forward *log_head;
  64 static int log_forward_count;
  65
  66 struct store_log_forward {
  67         struct store_log_forward *next;
  68         const char *file;
  69         int line;
  70         const char *function;
  71         const char *string;
  72 };
  73
  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)
  76 {
  77         if (log_forward_count == 0) {
  78                 struct log_callback *cb, *next;
  79                 cb = log_callbacks;
  80                 /* DANGER!!!! the log callback can remove itself!!!! */
  81                 while (cb) {
  82                         next = cb->next;
  83                         cb->fn(cb->priv, file, line, function, string);
  84                         cb = next;
  85                 }
  86         } else {
  87                 struct store_log_forward *log = malloc(sizeof(struct store_log_forward));
  88                 log->file = strdup(file);
  89                 log->line = line;
  90                 log->function = strdup(function);
  91                 log->string = strdup(string);
  92                 log->next = NULL;
  93                 if (log_head == NULL)
  94                         log_head = log;
  95                 else {
  96                         /* append to tail */
  97                         struct store_log_forward *t;
  98                         t = log_head;
  99                         while (t->next != NULL)
 100                                 t = t->next;
 101                         t->next = log;
 102                 }
 103         }
 104 }
 105
 106 /* The log_puts() serves to somewhat different goals:
 107  *
 108  * - logging
 109  * - feeding low-level info to the user in GDB or Telnet
 110  *
 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.
 113  * target_request.c).
 114  *
 115  */
 116 static void log_puts(enum log_levels level,
 117         const char *file,
 118         int line,
 119         const char *function,
 120         const char *string)
 121 {
 122         char *f;
 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);
 126                 fflush(log_output);
 127                 return;
 128         }
 129
 130         f = strrchr(file, '/');
 131         if (f != NULL)
 132                 file = f + 1;
 133
 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;
 140                         info = mallinfo();
 141 #endif
 142                         fprintf(log_output, "%s%d %" PRId64 " %s:%d %s()"
 143 #ifdef _DEBUG_FREE_SPACE_
 144                                 " %d"
 145 #endif
 146                                 ": %s", log_strings[level + 1], count, t, file, line, function,
 147 #ifdef _DEBUG_FREE_SPACE_
 148                                 info.fordblks,
 149 #endif
 150                                 string);
 151                 } else {
 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);
 156                 }
 157         } else {
 158                 /* Empty strings are sent to log callbacks to keep e.g. gdbserver alive, here we do
 159                  *nothing. */
 160         }
 161
 162         fflush(log_output);
 163
 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);
 167 }
 168
 169 void log_printf(enum log_levels level,
 170         const char *file,
 171         unsigned line,
 172         const char *function,
 173         const char *format,
 174         ...)
 175 {
 176         char *string;
 177         va_list ap;
 178
 179         count++;
 180         if (level > debug_level)
 181                 return;
 182
 183         va_start(ap, format);
 184
 185         string = alloc_vprintf(format, ap);
 186         if (string != NULL) {
 187                 log_puts(level, file, line, function, string);
 188                 free(string);
 189         }
 190
 191         va_end(ap);
 192 }
 193
 194 void log_vprintf_lf(enum log_levels level, const char *file, unsigned line,
 195                 const char *function, const char *format, va_list args)
 196 {
 197         char *tmp;
 198
 199         count++;
 200
 201         if (level > debug_level)
 202                 return;
 203
 204         tmp = alloc_vprintf(format, args);
 205
 206         if (!tmp)
 207                 return;
 208
 209         /*
 210          * Note: alloc_vprintf() guarantees that the buffer is at least one
 211          * character longer.
 212          */
 213         strcat(tmp, "\n");
 214         log_puts(level, file, line, function, tmp);
 215         free(tmp);
 216 }
 217
 218 void log_printf_lf(enum log_levels level,
 219         const char *file,
 220         unsigned line,
 221         const char *function,
 222         const char *format,
 223         ...)
 224 {
 225         va_list ap;
 226
 227         va_start(ap, format);
 228         log_vprintf_lf(level, file, line, function, format, ap);
 229         va_end(ap);
 230 }
 231
 232 COMMAND_HANDLER(handle_debug_level_command)
 233 {
 234         if (CMD_ARGC == 1) {
 235                 int new_level;
 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;
 240                 }
 241                 debug_level = new_level;
 242         } else if (CMD_ARGC > 1)
 243                 return ERROR_COMMAND_SYNTAX_ERROR;
 244
 245         command_print(CMD_CTX, "debug_level: %i", debug_level);
 246
 247         return ERROR_OK;
 248 }
 249
 250 COMMAND_HANDLER(handle_log_output_command)
 251 {
 252         if (CMD_ARGC == 1) {
 253                 FILE *file = fopen(CMD_ARGV[0], "w");
 254                 if (file == NULL) {
 255                         LOG_ERROR("failed to open output log '%s'", CMD_ARGV[0]);
 256                         return ERROR_FAIL;
 257                 }
 258                 if (log_output != stderr && log_output != NULL) {
 259                         /* Close previous log file, if it was open and wasn't stderr. */
 260                         fclose(log_output);
 261                 }
 262                 log_output = file;
 263         }
 264
 265         return ERROR_OK;
 266 }
 267
 268 static struct command_registration log_command_handlers[] = {
 269         {
 270                 .name = "log_output",
 271                 .handler = handle_log_output_command,
 272                 .mode = COMMAND_ANY,
 273                 .help = "redirect logging to a file (default: stderr)",
 274                 .usage = "file_name",
 275         },
 276         {
 277                 .name = "debug_level",
 278                 .handler = handle_debug_level_command,
 279                 .mode = COMMAND_ANY,
 280                 .help = "Sets the verbosity level of debugging output. "
 281                         "0 shows errors only; 1 adds warnings; "
 282                         "2 (default) adds other info; 3 adds debugging.",
 283                 .usage = "number",
 284         },
 285         COMMAND_REGISTRATION_DONE
 286 };
 287
 288 int log_register_commands(struct command_context *cmd_ctx)
 289 {
 290         return register_commands(cmd_ctx, NULL, log_command_handlers);
 291 }
 292
 293 void log_init(void)
 294 {
 295         /* set defaults for daemon configuration,
 296          * if not set by cmdline or cfgfile */
 297         if (debug_level == -1)
 298                 debug_level = LOG_LVL_INFO;
 299
 300         char *debug_env = getenv("OPENOCD_DEBUG_LEVEL");
 301         if (NULL != debug_env) {
 302                 int value;
 303                 int retval = parse_int(debug_env, &value);
 304                 if (ERROR_OK == retval &&
 305                                 debug_level >= LOG_LVL_SILENT &&
 306                                 debug_level <= LOG_LVL_DEBUG)
 307                                 debug_level = value;
 308         }
 309
 310         if (log_output == NULL)
 311                 log_output = stderr;
 312
 313         start = last_time = timeval_ms();
 314 }
 315
 316 int set_log_output(struct command_context *cmd_ctx, FILE *output)
 317 {
 318         log_output = output;
 319         return ERROR_OK;
 320 }
 321
 322 /* add/remove log callback handler */
 323 int log_add_callback(log_callback_fn fn, void *priv)
 324 {
 325         struct log_callback *cb;
 326
 327         /* prevent the same callback to be registered more than once, just for sure */
 328         for (cb = log_callbacks; cb; cb = cb->next) {
 329                 if (cb->fn == fn && cb->priv == priv)
 330                         return ERROR_COMMAND_SYNTAX_ERROR;
 331         }
 332
 333         /* alloc memory, it is safe just to return in case of an error, no need for the caller to
 334          *check this */
 335         cb = malloc(sizeof(struct log_callback));
 336         if (cb == NULL)
 337                 return ERROR_BUF_TOO_SMALL;
 338
 339         /* add item to the beginning of the linked list */
 340         cb->fn = fn;
 341         cb->priv = priv;
 342         cb->next = log_callbacks;
 343         log_callbacks = cb;
 344
 345         return ERROR_OK;
 346 }
 347
 348 int log_remove_callback(log_callback_fn fn, void *priv)
 349 {
 350         struct log_callback *cb, **p;
 351
 352         for (p = &log_callbacks; (cb = *p); p = &(*p)->next) {
 353                 if (cb->fn == fn && cb->priv == priv) {
 354                         *p = cb->next;
 355                         free(cb);
 356                         return ERROR_OK;
 357                 }
 358         }
 359
 360         /* no such item */
 361         return ERROR_COMMAND_SYNTAX_ERROR;
 362 }
 363
 364 /* return allocated string w/printf() result */
 365 char *alloc_vprintf(const char *fmt, va_list ap)
 366 {
 367         va_list ap_copy;
 368         int len;
 369         char *string;
 370
 371         /* determine the length of the buffer needed */
 372         va_copy(ap_copy, ap);
 373         len = vsnprintf(NULL, 0, fmt, ap_copy);
 374         va_end(ap_copy);
 375
 376         /* allocate and make room for terminating zero. */
 377         /* FIXME: The old version always allocated at least one byte extra and
 378          * other code depend on that. They should be probably be fixed, but for
 379          * now reserve the extra byte. */
 380         string = malloc(len + 2);
 381         if (string == NULL)
 382                 return NULL;
 383
 384         /* do the real work */
 385         vsnprintf(string, len + 1, fmt, ap);
 386
 387         return string;
 388 }
 389
 390 char *alloc_printf(const char *format, ...)
 391 {
 392         char *string;
 393         va_list ap;
 394         va_start(ap, format);
 395         string = alloc_vprintf(format, ap);
 396         va_end(ap);
 397         return string;
 398 }
 399
 400 /* Code must return to the server loop before 1000ms has returned or invoke
 401  * this function.
 402  *
 403  * The GDB connection will time out if it spends >2000ms and you'll get nasty
 404  * error messages from GDB:
 405  *
 406  * Ignoring packet error, continuing...
 407  * Reply contains invalid hex digit 116
 408  *
 409  * While it is possible use "set remotetimeout" to more than the default 2000ms
 410  * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
 411  * GDB protocol and it is a bug in OpenOCD not to either return to the server
 412  * loop or invoke keep_alive() every 1000ms.
 413  *
 414  * This function will send a keep alive packet if >500ms has passed since last time
 415  * it was invoked.
 416  *
 417  * Note that this function can be invoked often, so it needs to be relatively
 418  * fast when invoked more often than every 500ms.
 419  *
 420  */
 421 void keep_alive()
 422 {
 423         current_time = timeval_ms();
 424         if (current_time-last_time > 1000) {
 425                 extern int gdb_actual_connections;
 426
 427                 if (gdb_actual_connections)
 428                         LOG_WARNING("keep_alive() was not invoked in the "
 429                                 "1000ms timelimit. GDB alive packet not "
 430                                 "sent! (%" PRId64 "). Workaround: increase "
 431                                 "\"set remotetimeout\" in GDB",
 432                                 current_time-last_time);
 433                 else
 434                         LOG_DEBUG("keep_alive() was not invoked in the "
 435                                 "1000ms timelimit (%" PRId64 "). This may cause "
 436                                 "trouble with GDB connections.",
 437                                 current_time-last_time);
 438         }
 439         if (current_time-last_time > 500) {
 440                 /* this will keep the GDB connection alive */
 441                 LOG_USER_N("%s", "");
 442
 443                 /* DANGER!!!! do not add code to invoke e.g. target event processing,
 444                  * jim timer processing, etc. it can cause infinite recursion +
 445                  * jim event callbacks need to happen at a well defined time,
 446                  * not anywhere keep_alive() is invoked.
 447                  *
 448                  * These functions should be invoked at a well defined spot in server.c
 449                  */
 450
 451                 last_time = current_time;
 452         }
 453 }
 454
 455 /* reset keep alive timer without sending message */
 456 void kept_alive()
 457 {
 458         current_time = timeval_ms();
 459         last_time = current_time;
 460 }
 461
 462 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittantly */
 463 void alive_sleep(uint64_t ms)
 464 {
 465         uint64_t napTime = 10;
 466         for (uint64_t i = 0; i < ms; i += napTime) {
 467                 uint64_t sleep_a_bit = ms - i;
 468                 if (sleep_a_bit > napTime)
 469                         sleep_a_bit = napTime;
 470
 471                 usleep(sleep_a_bit * 1000);
 472                 keep_alive();
 473         }
 474 }
 475
 476 void busy_sleep(uint64_t ms)
 477 {
 478         uint64_t then = timeval_ms();
 479         while (timeval_ms() - then < ms) {
 480                 /*
 481                  * busy wait
 482                  */
 483         }
 484 }