src/util/common_logging.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2006, 2008, 2009 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 2, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file util/common_logging.c
  23  * @brief error handling API
  24  *
  25  * @author Christian Grothoff
  26  */
  27 #include "platform.h"
  28 #include "gnunet_common.h"
  29 #include "gnunet_crypto_lib.h"
  30 #include "gnunet_strings_lib.h"
  31 #include "gnunet_time_lib.h"
  32
  33 /**
  34  * After how many seconds do we always print
  35  * that "message X was repeated N times"?  Use 12h.
  36  */
  37 #define BULK_DELAY_THRESHOLD (12 * 60 * 60 * 1000)
  38
  39 /**
  40  * After how many repetitions do we always print
  41  * that "message X was repeated N times"? (even if
  42  * we have not yet reached the delay threshold)
  43  */
  44 #define BULK_REPEAT_THRESHOLD 1000
  45
  46 /**
  47  * How many characters do we use for matching of
  48  * bulk messages?
  49  */
  50 #define BULK_TRACK_SIZE 256
  51
  52 /**
  53  * How many characters can a date/time string
  54  * be at most?
  55  */
  56 #define DATE_STR_SIZE 64
  57
  58 /**
  59  * Linked list of active loggers.
  60  */
  61 struct CustomLogger
  62 {
  63   /**
  64    * This is a linked list.
  65    */
  66   struct CustomLogger *next;
  67
  68   /**
  69    * Log function.
  70    */
  71   GNUNET_Logger logger;
  72
  73   /**
  74    * Closure for logger.
  75    */
  76   void *logger_cls;
  77 };
  78
  79 /**
  80  * The last "bulk" error message that we have been logging.
  81  * Note that this message maybe truncated to the first BULK_TRACK_SIZE
  82  * characters, in which case it is NOT 0-terminated!
  83  */
  84 static char last_bulk[BULK_TRACK_SIZE];
  85
  86 /**
  87  * Type of the last bulk message.
  88  */
  89 static enum GNUNET_ErrorType last_bulk_kind;
  90
  91 /**
  92  * Time of the last bulk error message (0 for none)
  93  */
  94 static struct GNUNET_TIME_Absolute last_bulk_time;
  95
  96 /**
  97  * Number of times that bulk message has been repeated since.
  98  */
  99 static unsigned int last_bulk_repeat;
 100
 101 /**
 102  * Component when the last bulk was logged.
 103  */
 104 static const char *last_bulk_comp;
 105
 106 /**
 107  * Running component.
 108  */
 109 static const char *component;
 110
 111 /**
 112  * Minimum log level.
 113  */
 114 static enum GNUNET_ErrorType min_level;
 115
 116 /**
 117  * Linked list of our custom loggres.
 118  */
 119 static struct CustomLogger *loggers;
 120
 121 /**
 122  * Number of log calls to ignore.
 123  */
 124 static unsigned int skip_log;
 125
 126 /**
 127  * File descriptor to use for "stderr", or NULL for none.
 128  */
 129 static FILE *GNUNET_stderr;
 130
 131 /**
 132  * Convert a textual description of a loglevel
 133  * to the respective GNUNET_GE_KIND.
 134  *
 135  * @param log loglevel to parse
 136  * @return GNUNET_GE_INVALID if log does not parse
 137  */
 138 static enum GNUNET_ErrorType
 139 get_type (const char *log)
 140 {
 141   if (0 == strcasecmp (log, _("DEBUG")))
 142     return GNUNET_ERROR_TYPE_DEBUG;
 143   if (0 == strcasecmp (log, _("INFO")))
 144     return GNUNET_ERROR_TYPE_INFO;
 145   if (0 == strcasecmp (log, _("WARNING")))
 146     return GNUNET_ERROR_TYPE_WARNING;
 147   if (0 == strcasecmp (log, _("ERROR")))
 148     return GNUNET_ERROR_TYPE_ERROR;
 149   return GNUNET_ERROR_TYPE_INVALID;
 150 }
 151
 152
 153 /**
 154  * Setup logging.
 155  *
 156  * @param comp default component to use
 157  * @param loglevel what types of messages should be logged
 158  * @param logfile which file to write log messages to (can be NULL)
 159  * @return GNUNET_OK on success
 160  */
 161 int
 162 GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile)
 163 {
 164   FILE *altlog;
 165
 166   component = comp;
 167   min_level = get_type (loglevel);
 168   if (logfile == NULL)
 169     return GNUNET_OK;
 170   altlog = fopen (logfile, "a");
 171   if (altlog == NULL)
 172     {
 173       GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", logfile);
 174       return GNUNET_SYSERR;
 175     }
 176   if (GNUNET_stderr != NULL)
 177     fclose (GNUNET_stderr);
 178   GNUNET_stderr = altlog;
 179   return GNUNET_OK;
 180 }
 181
 182 /**
 183  * Add a custom logger.
 184  *
 185  * @param logger log function
 186  * @param logger_cls closure for logger
 187  */
 188 void
 189 GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls)
 190 {
 191   struct CustomLogger *entry;
 192
 193   entry = GNUNET_malloc (sizeof (struct CustomLogger));
 194   entry->logger = logger;
 195   entry->logger_cls = logger_cls;
 196   entry->next = loggers;
 197   loggers = entry;
 198 }
 199
 200 /**
 201  * Remove a custom logger.
 202  *
 203  * @param logger log function
 204  * @param logger_cls closure for logger
 205  */
 206 void
 207 GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls)
 208 {
 209   struct CustomLogger *pos;
 210   struct CustomLogger *prev;
 211
 212   prev = NULL;
 213   pos = loggers;
 214   while ((pos != NULL) &&
 215          ((pos->logger != logger) || (pos->logger_cls != logger_cls)))
 216     {
 217       prev = pos;
 218       pos = pos->next;
 219     }
 220   GNUNET_assert (pos != NULL);
 221   if (prev == NULL)
 222     loggers = pos->next;
 223   else
 224     prev->next = pos->next;
 225   GNUNET_free (pos);
 226 }
 227
 228
 229 /**
 230  * Actually output the log message.
 231  *
 232  * @param kind how severe was the issue
 233  * @param comp component responsible
 234  * @param datestr current date/time
 235  * @param msg the actual message
 236  */
 237 static void
 238 output_message (enum GNUNET_ErrorType kind,
 239                 const char *comp, const char *datestr, const char *msg)
 240 {
 241   struct CustomLogger *pos;
 242   if (GNUNET_stderr != NULL)
 243     fprintf (GNUNET_stderr, "%s %s %s %s", datestr, comp,
 244              GNUNET_error_type_to_string (kind), msg);
 245   pos = loggers;
 246   while (pos != NULL)
 247     {
 248       pos->logger (pos->logger_cls, kind, comp, datestr, msg);
 249       pos = pos->next;
 250     }
 251 }
 252
 253
 254 /**
 255  * Flush an existing bulk report to the output.
 256  *
 257  * @param datastr our current timestamp
 258  */
 259 static void
 260 flush_bulk (const char *datestr)
 261 {
 262   char msg[DATE_STR_SIZE + BULK_TRACK_SIZE + 256];
 263   int rev;
 264   char *last;
 265   char *ft;
 266
 267   if ((last_bulk_time.value == 0) || (last_bulk_repeat == 0))
 268     return;
 269   rev = 0;
 270   last = memchr (last_bulk, '\0', BULK_TRACK_SIZE);
 271   if (last == NULL)
 272     last = &last_bulk[BULK_TRACK_SIZE - 1];
 273   else if (last != last_bulk)
 274     last--;
 275   if (last[0] == '\n')
 276     {
 277       rev = 1;
 278       last[0] = '\0';
 279     }
 280   ft =
 281     GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration
 282                                             (last_bulk_time));
 283   snprintf (msg, sizeof (msg),
 284             _("Message `%.*s' repeated %u times in the last %s\n"),
 285             BULK_TRACK_SIZE, last_bulk, last_bulk_repeat, ft);
 286   GNUNET_free (ft);
 287   if (rev == 1)
 288     last[0] = '\n';
 289   output_message (last_bulk_kind, last_bulk_comp, datestr, msg);
 290   last_bulk_time = GNUNET_TIME_absolute_get ();
 291   last_bulk_repeat = 0;
 292 }
 293
 294
 295 /**
 296  * Ignore the next n calls to the log function.
 297  *
 298  * @param n number of log calls to ignore
 299  * @param check_reset GNUNET_YES to assert that the log skip counter is currently zero
 300  */
 301 void
 302 GNUNET_log_skip (unsigned int n, int check_reset)
 303 {
 304   if (n == 0)
 305     {
 306       int ok;
 307
 308       ok = (0 == skip_log);
 309       skip_log = 0;
 310       if (check_reset)
 311         GNUNET_assert (ok);
 312     }
 313   else
 314     skip_log += n;
 315 }
 316
 317
 318 /**
 319  * Output a log message using the default mechanism.
 320  *
 321  * @param kind how severe was the issue
 322  * @param comp component responsible
 323  * @param message the actual message
 324  * @param va arguments to the format string "message"
 325  */
 326 static void
 327 mylog (enum GNUNET_ErrorType kind,
 328        const char *comp, const char *message, va_list va)
 329 {
 330   char date[DATE_STR_SIZE];
 331   time_t timetmp;
 332   struct tm *tmptr;
 333   size_t size;
 334   char *buf;
 335   va_list vacp;
 336
 337   if (skip_log > 0)
 338     {
 339       skip_log--;
 340       return;
 341     }
 342   if ((kind & (~GNUNET_ERROR_TYPE_BULK)) > min_level)
 343     return;
 344   va_copy (vacp, va);
 345   size = VSNPRINTF (NULL, 0, message, vacp) + 1;
 346   va_end (vacp);
 347   buf = malloc (size);
 348   if (buf == NULL)
 349     return;                     /* oops */
 350   VSNPRINTF (buf, size, message, va);
 351   time (&timetmp);
 352   memset (date, 0, DATE_STR_SIZE);
 353   tmptr = localtime (&timetmp);
 354   strftime (date, DATE_STR_SIZE, "%b %d %H:%M:%S", tmptr);
 355   if ((0 != (kind & GNUNET_ERROR_TYPE_BULK)) &&
 356       (last_bulk_time.value != 0) &&
 357       (0 == strncmp (buf, last_bulk, sizeof (last_bulk))))
 358     {
 359       last_bulk_repeat++;
 360       if ((GNUNET_TIME_absolute_get_duration (last_bulk_time).value >
 361            BULK_DELAY_THRESHOLD)
 362           || (last_bulk_repeat > BULK_REPEAT_THRESHOLD))
 363         flush_bulk (date);
 364       free (buf);
 365       return;
 366     }
 367   flush_bulk (date);
 368   strncpy (last_bulk, buf, sizeof (last_bulk));
 369   last_bulk_repeat = 0;
 370   last_bulk_kind = kind;
 371   last_bulk_time = GNUNET_TIME_absolute_get ();
 372   last_bulk_comp = comp;
 373   output_message (kind, comp, date, buf);
 374   free (buf);
 375 }
 376
 377
 378 /**
 379  * Main log function.
 380  *
 381  * @param kind how serious is the error?
 382  * @param message what is the message (format string)
 383  * @param ... arguments for format string
 384  */
 385 void
 386 GNUNET_log (enum GNUNET_ErrorType kind, const char *message, ...)
 387 {
 388   va_list va;
 389   va_start (va, message);
 390   mylog (kind, component, message, va);
 391   va_end (va);
 392 }
 393
 394
 395 /**
 396  * Log function that specifies an alternative component.
 397  * This function should be used by plugins.
 398  *
 399  * @param kind how serious is the error?
 400  * @param comp component responsible for generating the message
 401  * @param message what is the message (format string)
 402  * @param ... arguments for format string
 403  */
 404 void
 405 GNUNET_log_from (enum GNUNET_ErrorType kind,
 406                  const char *comp, const char *message, ...)
 407 {
 408   va_list va;
 409   va_start (va, message);
 410   mylog (kind, comp, message, va);
 411   va_end (va);
 412 }
 413
 414
 415 /**
 416  * Convert error type to string.
 417  *
 418  * @param kind type to convert
 419  * @return string corresponding to the type
 420  */
 421 const char *
 422 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind)
 423 {
 424   if ((kind & GNUNET_ERROR_TYPE_ERROR) > 0)
 425     return _("ERROR");
 426   if ((kind & GNUNET_ERROR_TYPE_WARNING) > 0)
 427     return _("WARNING");
 428   if ((kind & GNUNET_ERROR_TYPE_INFO) > 0)
 429     return _("INFO");
 430   if ((kind & GNUNET_ERROR_TYPE_DEBUG) > 0)
 431     return _("DEBUG");
 432   return _("INVALID");
 433 }
 434
 435
 436 /**
 437  * Convert a hash to a string (for printing debug messages).
 438  * This is one of the very few calls in the entire API that is
 439  * NOT reentrant!
 440  *
 441  * @param pid the peer identity
 442  * @return string form; will be overwritten by next call to GNUNET_h2s.
 443  */
 444 const char *
 445 GNUNET_h2s (const GNUNET_HashCode *pid)
 446 {
 447   static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
 448   GNUNET_CRYPTO_hash_to_enc (pid, &ret);
 449   ret.encoding[8] = '\0';
 450   return (const char *) ret.encoding;
 451 }
 452
 453
 454 /**
 455  * Convert a peer identity to a string (for printing debug messages).
 456  * This is one of the very few calls in the entire API that is
 457  * NOT reentrant!
 458  *
 459  * @param pid the peer identity
 460  * @return string form of the pid; will be overwritten by next
 461  *         call to GNUNET_i2s.
 462  */
 463 const char *
 464 GNUNET_i2s (const struct GNUNET_PeerIdentity *pid)
 465 {
 466   static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
 467   GNUNET_CRYPTO_hash_to_enc (&pid->hashPubKey, &ret);
 468   ret.encoding[4] = '\0';
 469   return (const char *) ret.encoding;
 470 }
 471
 472
 473
 474 /**
 475  * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
 476  * (for printing debug messages).  This is one of the very few calls
 477  * in the entire API that is NOT reentrant!
 478  *
 479  * @param addr the address
 480  * @param addrlen the length of the address
 481  * @return nicely formatted string for the address
 482  *  will be overwritten by next call to GNUNET_a2s.
 483  */
 484 const char *GNUNET_a2s (const struct sockaddr *addr,
 485                         socklen_t addrlen)
 486 {
 487   static char buf[INET6_ADDRSTRLEN+8];
 488   static char b2[6];
 489   const struct sockaddr_in * v4;
 490   const struct sockaddr_in6 *v6;
 491
 492   if (addr == NULL)
 493     return _("unknown address");
 494   switch (addr->sa_family)
 495     {
 496     case AF_INET:
 497       v4 = (const struct sockaddr_in*)addr;
 498       inet_ntop(AF_INET, &v4->sin_addr, buf, INET_ADDRSTRLEN);
 499       if (0 == ntohs(v4->sin_port))
 500         return buf;
 501       strcat (buf, ":");
 502       sprintf (b2, "%u", ntohs(v4->sin_port));
 503       strcat (buf, b2);
 504       return buf;
 505     case AF_INET6:
 506       v6 = (const struct sockaddr_in6*)addr;
 507       buf[0] = '[';
 508       inet_ntop(AF_INET6, &v6->sin6_addr, &buf[1], INET6_ADDRSTRLEN);
 509       if (0 == ntohs(v6->sin6_port))
 510         return &buf[1];
 511       strcat (buf, "]:");
 512       sprintf (b2, "%u", ntohs(v6->sin6_port));
 513       strcat (buf, b2);
 514       return buf;
 515     default:
 516       return _("invalid address");
 517     }
 518 }
 519
 520
 521 /**
 522  * Initializer
 523  */
 524 void __attribute__ ((constructor))
 525 GNUNET_util_cl_init()
 526 {
 527   GNUNET_stderr = stderr;
 528 }
 529
 530 /* end of common_logging.c */