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