src/helper/log.c

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