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,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 COMMAND_HANDLER(handle_debug_level_command)
 278 {
 279         if (argc == 1)
 280         {
 281                 unsigned new_level;
 282                 COMMAND_PARSE_NUMBER(uint, args[0], new_level);
 283                 debug_level = MIN(new_level, LOG_LVL_DEBUG);
 284         }
 285         else if (argc > 1)
 286                 return ERROR_COMMAND_SYNTAX_ERROR;
 287
 288         if (debug_level >= LOG_LVL_DEBUG && server_use_pipes == 1)
 289         {
 290                 /* if we are enabling debug info then we need to write to a log file
 291                  * otherwise the pipe will get full and cause issues with gdb */
 292                 FILE* file = fopen("openocd.log", "w");
 293                 if (file)
 294                 {
 295                         log_output = file;
 296                         LOG_WARNING("enabling log output as we are using pipes");
 297                 }
 298         }
 299
 300         command_print(cmd_ctx, "debug_level: %i", debug_level);
 301
 302         return ERROR_OK;
 303 }
 304
 305 COMMAND_HANDLER(handle_log_output_command)
 306 {
 307         if (argc == 1)
 308         {
 309                 FILE* file = fopen(args[0], "w");
 310
 311                 if (file)
 312                 {
 313                         log_output = file;
 314                 }
 315         }
 316
 317         return ERROR_OK;
 318 }
 319
 320 int log_register_commands(struct command_context_s *cmd_ctx)
 321 {
 322         start = timeval_ms();
 323         register_command(cmd_ctx, NULL, "log_output", handle_log_output_command,
 324                 COMMAND_ANY, "redirect logging to <file> (default: stderr)");
 325         register_command(cmd_ctx, NULL, "debug_level", handle_debug_level_command,
 326                 COMMAND_ANY, "adjust debug level <0-3>");
 327
 328         return ERROR_OK;
 329 }
 330
 331 int log_init(struct command_context_s *cmd_ctx)
 332 {
 333         /* set defaults for daemon configuration, if not set by cmdline or cfgfile */
 334         if (debug_level == -1)
 335                 debug_level = LOG_LVL_INFO;
 336
 337         if (log_output == NULL)
 338         {
 339                 log_output = stderr;
 340         }
 341
 342         start = last_time = timeval_ms();
 343
 344         return ERROR_OK;
 345 }
 346
 347 int set_log_output(struct command_context_s *cmd_ctx, FILE *output)
 348 {
 349         log_output = output;
 350         return ERROR_OK;
 351 }
 352
 353 /* add/remove log callback handler */
 354 int log_add_callback(log_callback_fn fn, void *priv)
 355 {
 356         log_callback_t *cb;
 357
 358         /* prevent the same callback to be registered more than once, just for sure */
 359         for (cb = log_callbacks; cb; cb = cb->next)
 360         {
 361                 if (cb->fn == fn && cb->priv == priv)
 362                         return ERROR_INVALID_ARGUMENTS;
 363         }
 364
 365         /* alloc memory, it is safe just to return in case of an error, no need for the caller to check this */
 366         if ((cb = malloc(sizeof(log_callback_t))) == NULL)
 367                 return ERROR_BUF_TOO_SMALL;
 368
 369         /* add item to the beginning of the linked list */
 370         cb->fn = fn;
 371         cb->priv = priv;
 372         cb->next = log_callbacks;
 373         log_callbacks = cb;
 374
 375         return ERROR_OK;
 376 }
 377
 378 int log_remove_callback(log_callback_fn fn, void *priv)
 379 {
 380         log_callback_t *cb, **p;
 381
 382         for (p = &log_callbacks; (cb = *p); p = &(*p)->next)
 383         {
 384                 if (cb->fn == fn && cb->priv == priv)
 385                 {
 386                         *p = cb->next;
 387                         free(cb);
 388                         return ERROR_OK;
 389                 }
 390         }
 391
 392         /* no such item */
 393         return ERROR_INVALID_ARGUMENTS;
 394 }
 395
 396 /* return allocated string w/printf() result */
 397 char *alloc_vprintf(const char *fmt, va_list ap)
 398 {
 399         /* no buffer at the beginning, force realloc to do the job */
 400         char *string = NULL;
 401
 402         /* start with buffer size suitable for typical messages */
 403         int size = 128;
 404
 405         for (;;)
 406         {
 407                 char *t = string;
 408                 va_list ap_copy;
 409                 int ret;
 410                 string = realloc(string, size);
 411                 if (string == NULL)
 412                 {
 413                         if (t != NULL)
 414                                 free(t);
 415                         return NULL;
 416                 }
 417
 418                 va_copy(ap_copy, ap);
 419
 420                 ret = vsnprintf(string, size, fmt, ap_copy);
 421                 /* NB! The result of the vsnprintf() might be an *EMPTY* string! */
 422                 if ((ret >= 0) && ((ret + 1) < size))
 423                         break;
 424
 425                 /* there was just enough or not enough space, allocate more in the next round */
 426                 size *= 2; /* double the buffer size */
 427         }
 428
 429         /* the returned buffer is by principle guaranteed to be at least one character longer */
 430         return string;
 431 }
 432
 433 char *alloc_printf(const char *format, ...)
 434 {
 435         char *string;
 436         va_list ap;
 437         va_start(ap, format);
 438         string = alloc_vprintf(format, ap);
 439         va_end(ap);
 440         return string;
 441 }
 442
 443 /* Code must return to the server loop before 1000ms has returned or invoke
 444  * this function.
 445  *
 446  * The GDB connection will time out if it spends >2000ms and you'll get nasty
 447  * error messages from GDB:
 448  *
 449  * Ignoring packet error, continuing...
 450  * Reply contains invalid hex digit 116
 451  *
 452  * While it is possible use "set remotetimeout" to more than the default 2000ms
 453  * in GDB, OpenOCD guarantees that it sends keep-alive packages on the
 454  * GDB protocol and it is a bug in OpenOCD not to either return to the server
 455  * loop or invoke keep_alive() every 1000ms.
 456  *
 457  * This function will send a keep alive packet if >500ms has passed since last time
 458  * it was invoked.
 459  *
 460  * Note that this function can be invoked often, so it needs to be relatively
 461  * fast when invoked more often than every 500ms.
 462  *
 463  */
 464 void keep_alive()
 465 {
 466         current_time = timeval_ms();
 467         if (current_time-last_time > 1000)
 468         {
 469                 extern int gdb_actual_connections;
 470
 471                 if (gdb_actual_connections)
 472                         LOG_WARNING("keep_alive() was not invoked in the "
 473                                 "1000ms timelimit. GDB alive packet not "
 474                                 "sent! (%lld). Workaround: increase "
 475                                 "\"set remotetimeout\" in GDB",
 476                                 current_time-last_time);
 477                 else
 478                         LOG_DEBUG("keep_alive() was not invoked in the "
 479                                 "1000ms timelimit (%lld). This may cause "
 480                                 "trouble with GDB connections.",
 481                                 current_time-last_time);
 482         }
 483         if (current_time-last_time > 500)
 484         {
 485                 /* this will keep the GDB connection alive */
 486                 LOG_USER_N("%s", "");
 487
 488                 /* DANGER!!!! do not add code to invoke e.g. target event processing,
 489                  * jim timer processing, etc. it can cause infinite recursion +
 490                  * jim event callbacks need to happen at a well defined time,
 491                  * not anywhere keep_alive() is invoked.
 492                  *
 493                  * These functions should be invoked at a well defined spot in server.c
 494                  */
 495
 496                 last_time = current_time;
 497         }
 498 }
 499
 500 /* reset keep alive timer without sending message */
 501 void kept_alive()
 502 {
 503         current_time = timeval_ms();
 504         last_time = current_time;
 505 }
 506
 507 /* if we sleep for extended periods of time, we must invoke keep_alive() intermittantly */
 508 void alive_sleep(int ms)
 509 {
 510         int i;
 511         int napTime = 10;
 512         for (i = 0; i < ms; i += napTime)
 513         {
 514                 int sleep_a_bit = ms-i;
 515                 if (sleep_a_bit > napTime)
 516                 {
 517                         sleep_a_bit = napTime;
 518                 }
 519                 usleep(sleep_a_bit*1000);
 520                 keep_alive();
 521         }
 522 }
 523
 524 void busy_sleep(int ms)
 525 {
 526         long long then;
 527         then = timeval_ms();
 528         while ((timeval_ms()-then) < ms)
 529         {
 530                 /* busy wait */
 531         }
 532 }