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 milliseconds 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  * Running component (without pid).
 119  */
 120 static char *component_nopid;
 121
 122 /**
 123  * Minimum log level.
 124  */
 125 static enum GNUNET_ErrorType min_level;
 126
 127 /**
 128  * Linked list of our custom loggres.
 129  */
 130 static struct CustomLogger *loggers;
 131
 132 /**
 133  * Number of log calls to ignore.
 134  */
 135 unsigned int skip_log;
 136
 137 /**
 138  * File descriptor to use for "stderr", or NULL for none.
 139  */
 140 static FILE *GNUNET_stderr;
 141
 142 /**
 143  * Represents a single logging definition
 144  */
 145 struct LogDef
 146 {
 147   /**
 148    * Component name. NULL means that this definition matches any component
 149    */
 150   char *component;
 151
 152   /**
 153    * File name. NULL means that this definition matches any file
 154    */
 155   char *file;
 156
 157   /**
 158    * Stores strlen(file)
 159    */
 160   int strlen_file;
 161
 162   /**
 163    * Function name. NULL means that this definition matches any function
 164    */
 165   char *function;
 166
 167   /**
 168    * Lowest line at which this definition matches.
 169    * Defaults to 0. Must be <= to_line.
 170    */
 171   int from_line;
 172
 173   /**
 174    * Highest line at which this definition matches.
 175    * Defaults to INT_MAX. Must be >= from_line.
 176    */
 177   int to_line;
 178
 179   /**
 180    * Maximal log level allowed for calls that match this definition.
 181    * Calls with higher log level will be disabled.
 182    * Must be >= 0
 183    */
 184   int level;
 185
 186   /**
 187    * 1 if this definition comes from GNUNET_FORCE_LOG, which means that it
 188    * overrides any configuration options. 0 otherwise.
 189    */
 190   int force;
 191 };
 192
 193 /**
 194  * Dynamic array of logging definitions
 195  */
 196 struct LogDef *logdefs = NULL;
 197
 198 /**
 199  * Allocated size of logdefs array (in units)
 200  */
 201 int logdefs_size = 0;
 202
 203 /**
 204  * The number of units used in logdefs array.
 205  */
 206 int logdefs_len = 0;
 207
 208 /**
 209  * GNUNET_YES if GNUNET_LOG environment variable is already parsed.
 210  */
 211 int gnunet_log_parsed = GNUNET_NO;
 212
 213 /**
 214  * GNUNET_YES if GNUNET_FORCE_LOG environment variable is already parsed.
 215  */
 216 int gnunet_force_log_parsed = GNUNET_NO;
 217
 218 /**
 219  * GNUNET_YES if at least one definition with forced == 1 is available.
 220  */
 221 int gnunet_force_log_present = GNUNET_NO;
 222
 223 #ifdef WINDOWS
 224 /**
 225  * Contains the number of performance counts per second.
 226  */
 227 LARGE_INTEGER performance_frequency;
 228 #endif
 229
 230 /**
 231  * Convert a textual description of a loglevel
 232  * to the respective GNUNET_GE_KIND.
 233  *
 234  * @param log loglevel to parse
 235  * @return GNUNET_GE_INVALID if log does not parse
 236  */
 237 static enum GNUNET_ErrorType
 238 get_type (const char *log)
 239 {
 240   if (log == NULL)
 241     return GNUNET_ERROR_TYPE_UNSPECIFIED;
 242   if (0 == strcasecmp (log, _("DEBUG")))
 243     return GNUNET_ERROR_TYPE_DEBUG;
 244   if (0 == strcasecmp (log, _("INFO")))
 245     return GNUNET_ERROR_TYPE_INFO;
 246   if (0 == strcasecmp (log, _("WARNING")))
 247     return GNUNET_ERROR_TYPE_WARNING;
 248   if (0 == strcasecmp (log, _("ERROR")))
 249     return GNUNET_ERROR_TYPE_ERROR;
 250   if (0 == strcasecmp (log, _("NONE")))
 251     return GNUNET_ERROR_TYPE_NONE;
 252   return GNUNET_ERROR_TYPE_INVALID;
 253 }
 254 #if !defined(GNUNET_CULL_LOGGING)
 255 /**
 256  * Utility function - reallocates logdefs array to be twice as large.
 257  */
 258 static void
 259 resize_logdefs ()
 260 {
 261   logdefs_size  = (logdefs_size + 1) * 2;
 262   logdefs = GNUNET_realloc (logdefs, logdefs_size * sizeof (struct LogDef));
 263 }
 264
 265 /**
 266  * Utility function - adds a parsed definition to logdefs array.
 267  *
 268  * @param component see struct LogDef, can't be NULL
 269  * @param file see struct LogDef, can't be NULL
 270  * @param function see struct LogDef, can't be NULL
 271  * @param from_line see struct LogDef
 272  * @param to_line see struct LogDef
 273  * @param level see struct LogDef, must be >= 0
 274  * @param force see struct LogDef
 275  */
 276 static void
 277 add_definition (char *component, char *file, char *function, int from_line, int to_line, int level, int force)
 278 {
 279   if (logdefs_size == logdefs_len)
 280     resize_logdefs ();
 281   struct LogDef n;
 282   memset (&n, 0, sizeof (n));
 283   if (strlen (component) > 0 && component[0] != '*')
 284     n.component = strdup (component);
 285   if (strlen (file) > 0 && file[0] != '*')
 286   {
 287     n.file = strdup (file);
 288     n.strlen_file = strlen (file);
 289   }
 290   if (strlen (function) > 0 && function[0] != '*')
 291     n.function = strdup (function);
 292   n.from_line = from_line;
 293   n.to_line = to_line;
 294   n.level = level;
 295   n.force = force;
 296   logdefs[logdefs_len++] = n;
 297 }
 298
 299
 300 /**
 301  * Decides whether a particular logging call should or should not be allowed
 302  * to be made. Used internally by GNUNET_log*()
 303  *
 304  * @param caller_level loglevel the caller wants to use
 305  * @param comp component name the caller uses (NULL means that global
 306  *   component name is used)
 307  * @param file file name containing the logging call, usually __FILE__
 308  * @param function function which tries to make a logging call,
 309  *   usually __FUNCTION__
 310  * @param line line at which the call is made, usually __LINE__
 311  * @return 0 to disallow the call, 1 to allow it
 312  */
 313 int
 314 GNUNET_get_log_call_status (int caller_level, const char *comp, const char *file, const char *function, int line)
 315 {
 316   struct LogDef *ld;
 317   int i;
 318   int force_only;
 319   size_t strlen_file;
 320   int matches = 0;
 321
 322   if (comp == NULL)
 323     /* Use default component */
 324     comp = component_nopid;
 325
 326   /* We have no definitions to override globally configured log level,
 327    * so just use it right away.
 328    */
 329   if (min_level >= 0 && gnunet_force_log_present == GNUNET_NO)
 330     return caller_level <= min_level;
 331
 332   /* Only look for forced definitions? */
 333   force_only = min_level >= 0;
 334   strlen_file = strlen (file);
 335   for (i = 0; i < logdefs_len; i++)
 336   {
 337     ld = &logdefs[i];
 338     if ((!force_only || ld->force) &&
 339         (line >= ld->from_line && line <= ld->to_line) &&
 340         (ld->component == NULL || strcmp (comp, ld->component) == 0) &&
 341         (ld->file == NULL ||
 342          (ld->strlen_file <= strlen_file &&
 343           strcmp (&file[strlen_file - ld->strlen_file], ld->file) == 0)) &&
 344         (ld->function == NULL || strcmp (function, ld->function) == 0)
 345        )
 346     {
 347       /* This definition matched! */
 348       matches += 1;
 349       /* And if it allows the call to be made, then we're finished */
 350       if (caller_level <= ld->level)
 351         return 1;
 352     }
 353   }
 354   /* If some definitions did match, but had too low loglevel to allow logging,
 355    * don't check any further.
 356    */
 357   if (matches > 0)
 358     return 0;
 359   /* Otherwise use global level, if defined */
 360   if (min_level >= 0)
 361     return caller_level <= min_level;
 362   /* All programs/services previously defaulted to WARNING.
 363    * Now WE default to WARNING, and THEY default to NULL.
 364    */
 365   return caller_level <= GNUNET_ERROR_TYPE_WARNING;
 366 }
 367
 368
 369 /**
 370  * Utility function - parses a definition
 371  *
 372  * Definition format:
 373  * component;file;function;from_line-to_line;level[/component...]
 374  * All entries are mandatory, but may be empty.
 375  * Empty entries for component, file and function are treated as
 376  * "matches anything".
 377  * Empty line entry is treated as "from 0 to INT_MAX"
 378  * Line entry with only one line is treated as "this line only"
 379  * Entry for level MUST NOT be empty.
 380  * Entries for component, file and function that consist of a
 381  * single character "*" are treated (at the moment) the same way
 382  * empty entries are treated (wildcard matching is not implemented (yet?)).
 383  * file entry is matched to the end of __FILE__. That is, it might be
 384  * a base name, or a base name with leading directory names (some compilers
 385  * define __FILE__ to absolute file path).
 386  *
 387  * @param constname name of the environment variable from which to get the
 388  *   string to be parsed
 389  * @param force 1 if definitions found in @constname are to be forced
 390  * @return number of added definitions
 391  */
 392 static int
 393 parse_definitions (const char *constname, int force)
 394 {
 395   char *def;
 396   const char *tmp;
 397   char *comp = NULL;
 398   char *file = NULL;
 399   char *function = NULL;
 400   char *p;
 401   char *start;
 402   char *t;
 403   short state;
 404   int level;
 405   int from_line, to_line;
 406   int counter = 0;
 407   int keep_looking = 1;
 408   tmp = getenv (constname);
 409   if (tmp == NULL)
 410     return 0;
 411   def = strdup (tmp);
 412   level = -1;
 413   from_line = 0;
 414   to_line = INT_MAX;
 415   for (p = def, state = 0, start = def; keep_looking; p++)
 416   {
 417     switch (p[0])
 418     {
 419     case ';': /* found a field separator */
 420       p[0] = '\0';
 421       switch (state)
 422       {
 423       case 0: /* within a component name */
 424         comp = start;
 425         break;
 426       case 1: /* within a file name */
 427         file = start;
 428         break;
 429       case 2: /* within a function name */
 430         /* after a file name there must be a function name */
 431         function = start;
 432         break;
 433       case 3: /* within a from-to line range */
 434         if (strlen (start) > 0)
 435         {
 436           errno = 0;
 437           from_line = strtol (start, &t, 10);
 438           if (errno != 0 || from_line < 0)
 439           {
 440             free (def);
 441             return counter;
 442           }
 443           if (t < p && t[0] == '-')
 444           {
 445             errno = 0;
 446             start = t + 1;
 447             to_line = strtol (start, &t, 10);
 448             if (errno != 0 || to_line < 0 || t != p)
 449             {
 450               free (def);
 451               return counter;
 452             }
 453           }
 454           else /* one number means "match this line only" */
 455             to_line = from_line;
 456         }
 457         else /* default to 0-max */
 458         {
 459           from_line = 0;
 460           to_line = INT_MAX;
 461         }
 462         break;
 463       }
 464       start = p + 1;
 465       state += 1;
 466       break;
 467     case '\0': /* found EOL */
 468       keep_looking = 0;
 469       /* fall through to '/' */
 470     case '/': /* found a definition separator */
 471       switch (state)
 472       {
 473       case 4: /* within a log level */
 474         p[0] = '\0';
 475         state = 0;
 476         level = get_type ((const char *) start);
 477         if (level == GNUNET_ERROR_TYPE_INVALID || level == GNUNET_ERROR_TYPE_UNSPECIFIED)
 478         {
 479           free (def);
 480           return counter;
 481         }
 482         add_definition (comp, file, function, from_line, to_line, level, force);
 483         counter += 1;
 484         start = p + 1;
 485         break;
 486       default:
 487         break;
 488       }
 489     default:
 490       break;
 491     }
 492   }
 493   free (def);
 494   return counter;
 495 }
 496
 497 /**
 498  * Utility function - parses GNUNET_LOG and GNUNET_FORCE_LOG.
 499  */
 500 static void
 501 parse_all_definitions ()
 502 {
 503   if (gnunet_log_parsed == GNUNET_NO)
 504     parse_definitions ("GNUNET_LOG", 0);
 505   gnunet_log_parsed = GNUNET_YES;
 506   if (gnunet_force_log_parsed == GNUNET_NO)
 507     gnunet_force_log_present = parse_definitions ("GNUNET_FORCE_LOG", 1) > 0 ? GNUNET_YES : GNUNET_NO;
 508   gnunet_force_log_parsed = GNUNET_YES;
 509 }
 510 #endif
 511 /**
 512  * Setup logging.
 513  *
 514  * @param comp default component to use
 515  * @param loglevel what types of messages should be logged
 516  * @param logfile which file to write log messages to (can be NULL)
 517  * @return GNUNET_OK on success
 518  */
 519 int
 520 GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile)
 521 {
 522   FILE *altlog;
 523   int dirwarn;
 524   char *fn;
 525   const char *env_logfile = NULL;
 526
 527   min_level = get_type (loglevel);
 528 #if !defined(GNUNET_CULL_LOGGING)
 529   parse_all_definitions ();
 530 #endif
 531 #ifdef WINDOWS
 532   QueryPerformanceFrequency (&performance_frequency);
 533 #endif
 534   GNUNET_free_non_null (component);
 535   GNUNET_asprintf (&component, "%s-%d", comp, getpid ());
 536   GNUNET_free_non_null (component_nopid);
 537   component_nopid = strdup (comp);
 538
 539   env_logfile = getenv ("GNUNET_FORCE_LOGFILE");
 540   if (env_logfile != NULL)
 541     logfile = env_logfile;
 542
 543   if (logfile == NULL)
 544     return GNUNET_OK;
 545   fn = GNUNET_STRINGS_filename_expand (logfile);
 546   if (NULL == fn)
 547     return GNUNET_SYSERR;
 548   dirwarn = (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn));
 549   altlog = FOPEN (fn, "a");
 550   if (altlog == NULL)
 551   {
 552     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", fn);
 553     if (dirwarn)
 554       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 555                   _("Failed to create or access directory for log file `%s'\n"),
 556                   fn);
 557     GNUNET_free (fn);
 558     return GNUNET_SYSERR;
 559   }
 560   GNUNET_free (fn);
 561   if (GNUNET_stderr != NULL)
 562     fclose (GNUNET_stderr);
 563   GNUNET_stderr = altlog;
 564   return GNUNET_OK;
 565 }
 566
 567 /**
 568  * Add a custom logger.
 569  *
 570  * @param logger log function
 571  * @param logger_cls closure for logger
 572  */
 573 void
 574 GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls)
 575 {
 576   struct CustomLogger *entry;
 577
 578   entry = GNUNET_malloc (sizeof (struct CustomLogger));
 579   entry->logger = logger;
 580   entry->logger_cls = logger_cls;
 581   entry->next = loggers;
 582   loggers = entry;
 583 }
 584
 585 /**
 586  * Remove a custom logger.
 587  *
 588  * @param logger log function
 589  * @param logger_cls closure for logger
 590  */
 591 void
 592 GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls)
 593 {
 594   struct CustomLogger *pos;
 595   struct CustomLogger *prev;
 596
 597   prev = NULL;
 598   pos = loggers;
 599   while ((pos != NULL) &&
 600          ((pos->logger != logger) || (pos->logger_cls != logger_cls)))
 601   {
 602     prev = pos;
 603     pos = pos->next;
 604   }
 605   GNUNET_assert (pos != NULL);
 606   if (prev == NULL)
 607     loggers = pos->next;
 608   else
 609     prev->next = pos->next;
 610   GNUNET_free (pos);
 611 }
 612
 613
 614 /**
 615  * Actually output the log message.
 616  *
 617  * @param kind how severe was the issue
 618  * @param comp component responsible
 619  * @param datestr current date/time
 620  * @param msg the actual message
 621  */
 622 static void
 623 output_message (enum GNUNET_ErrorType kind, const char *comp,
 624                 const char *datestr, const char *msg)
 625 {
 626   struct CustomLogger *pos;
 627
 628   if (GNUNET_stderr != NULL)
 629   {
 630     fprintf (GNUNET_stderr, "%s %s %s %s", datestr, comp,
 631              GNUNET_error_type_to_string (kind), msg);
 632     fflush (GNUNET_stderr);
 633   }
 634   pos = loggers;
 635   while (pos != NULL)
 636   {
 637     pos->logger (pos->logger_cls, kind, comp, datestr, msg);
 638     pos = pos->next;
 639   }
 640 }
 641
 642
 643 /**
 644  * Flush an existing bulk report to the output.
 645  *
 646  * @param datestr our current timestamp
 647  */
 648 static void
 649 flush_bulk (const char *datestr)
 650 {
 651   char msg[DATE_STR_SIZE + BULK_TRACK_SIZE + 256];
 652   int rev;
 653   char *last;
 654   char *ft;
 655
 656   if ((last_bulk_time.abs_value == 0) || (last_bulk_repeat == 0))
 657     return;
 658   rev = 0;
 659   last = memchr (last_bulk, '\0', BULK_TRACK_SIZE);
 660   if (last == NULL)
 661     last = &last_bulk[BULK_TRACK_SIZE - 1];
 662   else if (last != last_bulk)
 663     last--;
 664   if (last[0] == '\n')
 665   {
 666     rev = 1;
 667     last[0] = '\0';
 668   }
 669   ft = GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration
 670                                                (last_bulk_time));
 671   snprintf (msg, sizeof (msg),
 672             _("Message `%.*s' repeated %u times in the last %s\n"),
 673             BULK_TRACK_SIZE, last_bulk, last_bulk_repeat, ft);
 674   GNUNET_free (ft);
 675   if (rev == 1)
 676     last[0] = '\n';
 677   output_message (last_bulk_kind, last_bulk_comp, datestr, msg);
 678   last_bulk_time = GNUNET_TIME_absolute_get ();
 679   last_bulk_repeat = 0;
 680 }
 681
 682
 683 /**
 684  * Ignore the next n calls to the log function.
 685  *
 686  * @param n number of log calls to ignore
 687  * @param check_reset GNUNET_YES to assert that the log skip counter is currently zero
 688  */
 689 void
 690 GNUNET_log_skip (unsigned int n, int check_reset)
 691 {
 692   if (n == 0)
 693   {
 694     int ok;
 695
 696     ok = (0 == skip_log);
 697     skip_log = 0;
 698     if (check_reset)
 699       GNUNET_assert (ok);
 700   }
 701   else
 702     skip_log += n;
 703 }
 704
 705
 706 /**
 707  * Output a log message using the default mechanism.
 708  *
 709  * @param kind how severe was the issue
 710  * @param comp component responsible
 711  * @param message the actual message
 712  * @param va arguments to the format string "message"
 713  */
 714 static void
 715 mylog (enum GNUNET_ErrorType kind, const char *comp, const char *message,
 716        va_list va)
 717 {
 718   char date[DATE_STR_SIZE];
 719   char date2[DATE_STR_SIZE];
 720   time_t timetmp;
 721   struct timeval timeofday;
 722   struct tm *tmptr;
 723   size_t size;
 724   char *buf;
 725   va_list vacp;
 726
 727   va_copy (vacp, va);
 728   size = VSNPRINTF (NULL, 0, message, vacp) + 1;
 729   va_end (vacp);
 730   buf = malloc (size);
 731   if (buf == NULL)
 732     return;                     /* oops */
 733   VSNPRINTF (buf, size, message, va);
 734   time (&timetmp);
 735   memset (date, 0, DATE_STR_SIZE);
 736   tmptr = localtime (&timetmp);
 737   gettimeofday (&timeofday, NULL);
 738   if (NULL != tmptr)
 739   {
 740 #ifdef WINDOWS
 741     LARGE_INTEGER pc;
 742
 743     pc.QuadPart = 0;
 744     QueryPerformanceCounter (&pc);
 745     strftime (date2, DATE_STR_SIZE, "%b %d %H:%M:%S-%%020llu", tmptr);
 746     snprintf (date, sizeof (date), date2,
 747               (long long) (pc.QuadPart /
 748                            (performance_frequency.QuadPart / 1000)));
 749 #else
 750     strftime (date2, DATE_STR_SIZE, "%b %d %H:%M:%S-%%06u", tmptr);
 751     snprintf (date, sizeof (date), date2, timeofday.tv_usec);
 752 #endif
 753   }
 754   else
 755     strcpy (date, "localtime error");
 756   if ((0 != (kind & GNUNET_ERROR_TYPE_BULK)) && (last_bulk_time.abs_value != 0)
 757       && (0 == strncmp (buf, last_bulk, sizeof (last_bulk))))
 758   {
 759     last_bulk_repeat++;
 760     if ((GNUNET_TIME_absolute_get_duration (last_bulk_time).rel_value >
 761          BULK_DELAY_THRESHOLD) || (last_bulk_repeat > BULK_REPEAT_THRESHOLD))
 762       flush_bulk (date);
 763     free (buf);
 764     return;
 765   }
 766   flush_bulk (date);
 767   strncpy (last_bulk, buf, sizeof (last_bulk));
 768   last_bulk_repeat = 0;
 769   last_bulk_kind = kind;
 770   last_bulk_time = GNUNET_TIME_absolute_get ();
 771   strncpy (last_bulk_comp, comp, COMP_TRACK_SIZE);
 772   output_message (kind, comp, date, buf);
 773   free (buf);
 774 }
 775
 776
 777 /**
 778  * Main log function.
 779  *
 780  * @param kind how serious is the error?
 781  * @param message what is the message (format string)
 782  * @param ... arguments for format string
 783  */
 784 void
 785 GNUNET_log_nocheck (enum GNUNET_ErrorType kind, const char *message, ...)
 786 {
 787   va_list va;
 788
 789   va_start (va, message);
 790   mylog (kind, component, message, va);
 791   va_end (va);
 792 }
 793
 794
 795 /**
 796  * Log function that specifies an alternative component.
 797  * This function should be used by plugins.
 798  *
 799  * @param kind how serious is the error?
 800  * @param comp component responsible for generating the message
 801  * @param message what is the message (format string)
 802  * @param ... arguments for format string
 803  */
 804 void
 805 GNUNET_log_from_nocheck (enum GNUNET_ErrorType kind, const char *comp,
 806                  const char *message, ...)
 807 {
 808   va_list va;
 809   char comp_w_pid[128];
 810
 811   if (comp == NULL)
 812     comp = component_nopid;
 813
 814   va_start (va, message);
 815   GNUNET_snprintf (comp_w_pid, sizeof (comp_w_pid), "%s-%d", comp, getpid ());
 816   mylog (kind, comp_w_pid, message, va);
 817   va_end (va);
 818 }
 819
 820
 821 /**
 822  * Convert error type to string.
 823  *
 824  * @param kind type to convert
 825  * @return string corresponding to the type
 826  */
 827 const char *
 828 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind)
 829 {
 830   if ((kind & GNUNET_ERROR_TYPE_ERROR) > 0)
 831     return _("ERROR");
 832   if ((kind & GNUNET_ERROR_TYPE_WARNING) > 0)
 833     return _("WARNING");
 834   if ((kind & GNUNET_ERROR_TYPE_INFO) > 0)
 835     return _("INFO");
 836   if ((kind & GNUNET_ERROR_TYPE_DEBUG) > 0)
 837     return _("DEBUG");
 838   if ((kind & ~GNUNET_ERROR_TYPE_BULK) == 0)
 839     return _("NONE");
 840   return _("INVALID");
 841 }
 842
 843
 844 /**
 845  * Convert a hash to a string (for printing debug messages).
 846  * This is one of the very few calls in the entire API that is
 847  * NOT reentrant!
 848  *
 849  * @param hc the hash code
 850  * @return string form; will be overwritten by next call to GNUNET_h2s.
 851  */
 852 const char *
 853 GNUNET_h2s (const GNUNET_HashCode * hc)
 854 {
 855   static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
 856
 857   GNUNET_CRYPTO_hash_to_enc (hc, &ret);
 858   ret.encoding[8] = '\0';
 859   return (const char *) ret.encoding;
 860 }
 861
 862 /**
 863  * Convert a hash to a string (for printing debug messages).
 864  * This is one of the very few calls in the entire API that is
 865  * NOT reentrant!
 866  *
 867  * @param hc the hash code
 868  * @return string form; will be overwritten by next call to GNUNET_h2s_full.
 869  */
 870 const char *
 871 GNUNET_h2s_full (const GNUNET_HashCode * hc)
 872 {
 873   static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
 874
 875   GNUNET_CRYPTO_hash_to_enc (hc, &ret);
 876   ret.encoding[sizeof (ret) - 1] = '\0';
 877   return (const char *) ret.encoding;
 878 }
 879
 880 /**
 881  * Convert a peer identity to a string (for printing debug messages).
 882  * This is one of the very few calls in the entire API that is
 883  * NOT reentrant!
 884  *
 885  * @param pid the peer identity
 886  * @return string form of the pid; will be overwritten by next
 887  *         call to GNUNET_i2s.
 888  */
 889 const char *
 890 GNUNET_i2s (const struct GNUNET_PeerIdentity *pid)
 891 {
 892   static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
 893
 894   GNUNET_CRYPTO_hash_to_enc (&pid->hashPubKey, &ret);
 895   ret.encoding[4] = '\0';
 896   return (const char *) ret.encoding;
 897 }
 898
 899
 900
 901 /**
 902  * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
 903  * (for printing debug messages).  This is one of the very few calls
 904  * in the entire API that is NOT reentrant!
 905  *
 906  * @param addr the address
 907  * @param addrlen the length of the address
 908  * @return nicely formatted string for the address
 909  *  will be overwritten by next call to GNUNET_a2s.
 910  */
 911 const char *
 912 GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen)
 913 {
 914   static char buf[INET6_ADDRSTRLEN + 8];
 915   static char b2[6];
 916   const struct sockaddr_in *v4;
 917   const struct sockaddr_un *un;
 918   const struct sockaddr_in6 *v6;
 919   unsigned int off;
 920
 921   if (addr == NULL)
 922     return _("unknown address");
 923   switch (addr->sa_family)
 924   {
 925   case AF_INET:
 926     if (addrlen != sizeof (struct sockaddr_in))
 927       return "<invalid v4 address>";
 928     v4 = (const struct sockaddr_in *) addr;
 929     inet_ntop (AF_INET, &v4->sin_addr, buf, INET_ADDRSTRLEN);
 930     if (0 == ntohs (v4->sin_port))
 931       return buf;
 932     strcat (buf, ":");
 933     GNUNET_snprintf (b2, sizeof (b2), "%u", ntohs (v4->sin_port));
 934     strcat (buf, b2);
 935     return buf;
 936   case AF_INET6:
 937     if (addrlen != sizeof (struct sockaddr_in6))
 938       return "<invalid v4 address>";
 939     v6 = (const struct sockaddr_in6 *) addr;
 940     buf[0] = '[';
 941     inet_ntop (AF_INET6, &v6->sin6_addr, &buf[1], INET6_ADDRSTRLEN);
 942     if (0 == ntohs (v6->sin6_port))
 943       return &buf[1];
 944     strcat (buf, "]:");
 945     GNUNET_snprintf (b2, sizeof (b2), "%u", ntohs (v6->sin6_port));
 946     strcat (buf, b2);
 947     return buf;
 948   case AF_UNIX:
 949     if (addrlen <= sizeof (sa_family_t))
 950       return "<unbound UNIX client>";
 951     un = (const struct sockaddr_un *) addr;
 952     off = 0;
 953     if (un->sun_path[0] == '\0')
 954       off++;
 955     snprintf (buf, sizeof (buf), "%s%.*s", (off == 1) ? "@" : "",
 956               (int) (addrlen - sizeof (sa_family_t) - 1 - off),
 957               &un->sun_path[off]);
 958     return buf;
 959   default:
 960     return _("invalid address");
 961   }
 962 }
 963
 964
 965 /**
 966  * Initializer
 967  */
 968 void __attribute__ ((constructor)) GNUNET_util_cl_init ()
 969 {
 970   GNUNET_stderr = stderr;
 971 #ifdef MINGW
 972   GNInitWinEnv (NULL);
 973 #endif
 974 }
 975
 976
 977 /**
 978  * Destructor
 979  */
 980 void __attribute__ ((destructor)) GNUNET_util_cl_fini ()
 981 {
 982 #ifdef MINGW
 983   GNShutdownWinEnv ();
 984 #endif
 985 }
 986
 987 /* end of common_logging.c */