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