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
 255 #if !defined(GNUNET_CULL_LOGGING)
 256 /**
 257  * Utility function - reallocates logdefs array to be twice as large.
 258  */
 259 static void
 260 resize_logdefs ()
 261 {
 262   logdefs_size = (logdefs_size + 1) * 2;
 263   logdefs = GNUNET_realloc (logdefs, logdefs_size * sizeof (struct LogDef));
 264 }
 265
 266 /**
 267  * Utility function - adds a parsed definition to logdefs array.
 268  *
 269  * @param component see struct LogDef, can't be NULL
 270  * @param file see struct LogDef, can't be NULL
 271  * @param function see struct LogDef, can't be NULL
 272  * @param from_line see struct LogDef
 273  * @param to_line see struct LogDef
 274  * @param level see struct LogDef, must be >= 0
 275  * @param force see struct LogDef
 276  */
 277 static void
 278 add_definition (char *component, char *file, char *function, int from_line,
 279                 int to_line, int level, int force)
 280 {
 281   if (logdefs_size == logdefs_len)
 282     resize_logdefs ();
 283   struct LogDef n;
 284   memset (&n, 0, sizeof (n));
 285   if (strlen (component) > 0 && component[0] != '*')
 286     n.component = strdup (component);
 287   if (strlen (file) > 0 && file[0] != '*')
 288     {
 289       n.file = strdup (file);
 290       n.strlen_file = strlen (file);
 291     }
 292   if ( (NULL != function) &&
 293        (strlen (function) > 0) &&
 294        (function[0] != '*') )
 295     n.function = strdup (function);
 296   n.from_line = from_line;
 297   n.to_line = to_line;
 298   n.level = level;
 299   n.force = force;
 300   logdefs[logdefs_len++] = n;
 301 }
 302
 303
 304 /**
 305  * Decides whether a particular logging call should or should not be allowed
 306  * to be made. Used internally by GNUNET_log*()
 307  *
 308  * @param caller_level loglevel the caller wants to use
 309  * @param comp component name the caller uses (NULL means that global
 310  *   component name is used)
 311  * @param file file name containing the logging call, usually __FILE__
 312  * @param function function which tries to make a logging call,
 313  *   usually __FUNCTION__
 314  * @param line line at which the call is made, usually __LINE__
 315  * @return 0 to disallow the call, 1 to allow it
 316  */
 317 int
 318 GNUNET_get_log_call_status (int caller_level, const char *comp,
 319                             const char *file, const char *function, int line)
 320 {
 321   struct LogDef *ld;
 322   int i;
 323   int force_only;
 324   size_t strlen_file;
 325
 326   if (comp == NULL)
 327     /* Use default component */
 328     comp = component_nopid;
 329
 330   /* We have no definitions to override globally configured log level,
 331    * so just use it right away.
 332    */
 333   if (min_level >= 0 && gnunet_force_log_present == GNUNET_NO)
 334     return caller_level <= min_level;
 335
 336   /* Only look for forced definitions? */
 337   force_only = min_level >= 0;
 338   strlen_file = strlen (file);
 339   for (i = 0; i < logdefs_len; i++)
 340     {
 341       ld = &logdefs[i];
 342       if ((!force_only || ld->force) &&
 343           (line >= ld->from_line && line <= ld->to_line) &&
 344           (ld->component == NULL || strcmp (comp, ld->component) == 0) &&
 345           (ld->file == NULL ||
 346            (ld->strlen_file <= strlen_file &&
 347             strcmp (&file[strlen_file - ld->strlen_file], ld->file) == 0)) &&
 348           (ld->function == NULL || strcmp (function, ld->function) == 0))
 349         {
 350           /* We're finished */
 351           return caller_level <= ld->level;
 352         }
 353     }
 354   /* No matches - use global level, if defined */
 355   if (min_level >= 0)
 356     return caller_level <= min_level;
 357   /* All programs/services previously defaulted to WARNING.
 358    * Now WE default to WARNING, and THEY default to NULL.
 359    */
 360   return caller_level <= GNUNET_ERROR_TYPE_WARNING;
 361 }
 362
 363
 364 /**
 365  * Utility function - parses a definition
 366  *
 367  * Definition format:
 368  * component;file;function;from_line-to_line;level[/component...]
 369  * All entries are mandatory, but may be empty.
 370  * Empty entries for component, file and function are treated as
 371  * "matches anything".
 372  * Empty line entry is treated as "from 0 to INT_MAX"
 373  * Line entry with only one line is treated as "this line only"
 374  * Entry for level MUST NOT be empty.
 375  * Entries for component, file and function that consist of a
 376  * single character "*" are treated (at the moment) the same way
 377  * empty entries are treated (wildcard matching is not implemented (yet?)).
 378  * file entry is matched to the end of __FILE__. That is, it might be
 379  * a base name, or a base name with leading directory names (some compilers
 380  * define __FILE__ to absolute file path).
 381  *
 382  * @param constname name of the environment variable from which to get the
 383  *   string to be parsed
 384  * @param force 1 if definitions found in @constname are to be forced
 385  * @return number of added definitions
 386  */
 387 static int
 388 parse_definitions (const char *constname, int force)
 389 {
 390   char *def;
 391   const char *tmp;
 392   char *comp = NULL;
 393   char *file = NULL;
 394   char *function = NULL;
 395   char *p;
 396   char *start;
 397   char *t;
 398   short state;
 399   int level;
 400   int from_line, to_line;
 401   int counter = 0;
 402   int keep_looking = 1;
 403   tmp = getenv (constname);
 404   if (tmp == NULL)
 405     return 0;
 406   def = strdup (tmp);
 407   level = -1;
 408   from_line = 0;
 409   to_line = INT_MAX;
 410   for (p = def, state = 0, start = def; keep_looking; p++)
 411     {
 412       switch (p[0])
 413         {
 414         case ';':               /* found a field separator */
 415           p[0] = '\0';
 416           switch (state)
 417             {
 418             case 0:             /* within a component name */
 419               comp = start;
 420               break;
 421             case 1:             /* within a file name */
 422               file = start;
 423               break;
 424             case 2:             /* within a function name */
 425               /* after a file name there must be a function name */
 426               function = start;
 427               break;
 428             case 3:             /* within a from-to line range */
 429               if (strlen (start) > 0)
 430                 {
 431                   errno = 0;
 432                   from_line = strtol (start, &t, 10);
 433                   if (errno != 0 || from_line < 0)
 434                     {
 435                       free (def);
 436                       return counter;
 437                     }
 438                   if (t < p && t[0] == '-')
 439                     {
 440                       errno = 0;
 441                       start = t + 1;
 442                       to_line = strtol (start, &t, 10);
 443                       if (errno != 0 || to_line < 0 || t != p)
 444                         {
 445                           free (def);
 446                           return counter;
 447                         }
 448                     }
 449                   else          /* one number means "match this line only" */
 450                     to_line = from_line;
 451                 }
 452               else              /* default to 0-max */
 453                 {
 454                   from_line = 0;
 455                   to_line = INT_MAX;
 456                 }
 457               break;
 458             }
 459           start = p + 1;
 460           state += 1;
 461           break;
 462         case '\0':              /* found EOL */
 463           keep_looking = 0;
 464           /* fall through to '/' */
 465         case '/':               /* found a definition separator */
 466           switch (state)
 467             {
 468             case 4:             /* within a log level */
 469               p[0] = '\0';
 470               state = 0;
 471               level = get_type ((const char *) start);
 472               if (level == GNUNET_ERROR_TYPE_INVALID
 473                   || level == GNUNET_ERROR_TYPE_UNSPECIFIED)
 474                 {
 475                   free (def);
 476                   return counter;
 477                 }
 478               add_definition (comp, file, function, from_line, to_line, level,
 479                               force);
 480               counter += 1;
 481               start = p + 1;
 482               break;
 483             default:
 484               break;
 485             }
 486         default:
 487           break;
 488         }
 489     }
 490   free (def);
 491   return counter;
 492 }
 493
 494 /**
 495  * Utility function - parses GNUNET_LOG and GNUNET_FORCE_LOG.
 496  */
 497 static void
 498 parse_all_definitions ()
 499 {
 500   if (gnunet_log_parsed == GNUNET_NO)
 501     parse_definitions ("GNUNET_LOG", 0);
 502   gnunet_log_parsed = GNUNET_YES;
 503   if (gnunet_force_log_parsed == GNUNET_NO)
 504     gnunet_force_log_present =
 505       parse_definitions ("GNUNET_FORCE_LOG", 1) > 0 ? GNUNET_YES : GNUNET_NO;
 506   gnunet_force_log_parsed = GNUNET_YES;
 507 }
 508 #endif
 509 /**
 510  * Setup logging.
 511  *
 512  * @param comp default component to use
 513  * @param loglevel what types of messages should be logged
 514  * @param logfile which file to write log messages to (can be NULL)
 515  * @return GNUNET_OK on success
 516  */
 517 int
 518 GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile)
 519 {
 520   FILE *altlog;
 521   int dirwarn;
 522   char *fn;
 523   const char *env_logfile = NULL;
 524
 525   min_level = get_type (loglevel);
 526 #if !defined(GNUNET_CULL_LOGGING)
 527   parse_all_definitions ();
 528 #endif
 529 #ifdef WINDOWS
 530   QueryPerformanceFrequency (&performance_frequency);
 531 #endif
 532   GNUNET_free_non_null (component);
 533   GNUNET_asprintf (&component, "%s-%d", comp, getpid ());
 534   GNUNET_free_non_null (component_nopid);
 535   component_nopid = strdup (comp);
 536
 537   env_logfile = getenv ("GNUNET_FORCE_LOGFILE");
 538   if (env_logfile != NULL)
 539     logfile = env_logfile;
 540
 541   if (logfile == NULL)
 542     return GNUNET_OK;
 543   fn = GNUNET_STRINGS_filename_expand (logfile);
 544   if (NULL == fn)
 545     return GNUNET_SYSERR;
 546   dirwarn = (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn));
 547   altlog = FOPEN (fn, "a");
 548   if (altlog == NULL)
 549     {
 550       GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", fn);
 551       if (dirwarn)
 552         GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 553                     _
 554                     ("Failed to create or access directory for log file `%s'\n"),
 555                     fn);
 556       GNUNET_free (fn);
 557       return GNUNET_SYSERR;
 558     }
 559   GNUNET_free (fn);
 560   if (GNUNET_stderr != NULL)
 561     fclose (GNUNET_stderr);
 562   GNUNET_stderr = altlog;
 563   return GNUNET_OK;
 564 }
 565
 566 /**
 567  * Add a custom logger.
 568  *
 569  * @param logger log function
 570  * @param logger_cls closure for logger
 571  */
 572 void
 573 GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls)
 574 {
 575   struct CustomLogger *entry;
 576
 577   entry = GNUNET_malloc (sizeof (struct CustomLogger));
 578   entry->logger = logger;
 579   entry->logger_cls = logger_cls;
 580   entry->next = loggers;
 581   loggers = entry;
 582 }
 583
 584 /**
 585  * Remove a custom logger.
 586  *
 587  * @param logger log function
 588  * @param logger_cls closure for logger
 589  */
 590 void
 591 GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls)
 592 {
 593   struct CustomLogger *pos;
 594   struct CustomLogger *prev;
 595
 596   prev = NULL;
 597   pos = loggers;
 598   while ((pos != NULL) &&
 599          ((pos->logger != logger) || (pos->logger_cls != logger_cls)))
 600     {
 601       prev = pos;
 602       pos = pos->next;
 603     }
 604   GNUNET_assert (pos != NULL);
 605   if (prev == NULL)
 606     loggers = pos->next;
 607   else
 608     prev->next = pos->next;
 609   GNUNET_free (pos);
 610 }
 611
 612
 613 /**
 614  * Actually output the log message.
 615  *
 616  * @param kind how severe was the issue
 617  * @param comp component responsible
 618  * @param datestr current date/time
 619  * @param msg the actual message
 620  */
 621 static void
 622 output_message (enum GNUNET_ErrorType kind, const char *comp,
 623                 const char *datestr, const char *msg)
 624 {
 625   struct CustomLogger *pos;
 626
 627   if (GNUNET_stderr != NULL)
 628     {
 629       fprintf (GNUNET_stderr, "%s %s %s %s", datestr, comp,
 630                GNUNET_error_type_to_string (kind), msg);
 631       fflush (GNUNET_stderr);
 632     }
 633   pos = loggers;
 634   while (pos != NULL)
 635     {
 636       pos->logger (pos->logger_cls, kind, comp, datestr, msg);
 637       pos = pos->next;
 638     }
 639 }
 640
 641
 642 /**
 643  * Flush an existing bulk report to the output.
 644  *
 645  * @param datestr our current timestamp
 646  */
 647 static void
 648 flush_bulk (const char *datestr)
 649 {
 650   char msg[DATE_STR_SIZE + BULK_TRACK_SIZE + 256];
 651   int rev;
 652   char *last;
 653   char *ft;
 654
 655   if ((last_bulk_time.abs_value == 0) || (last_bulk_repeat == 0))
 656     return;
 657   rev = 0;
 658   last = memchr (last_bulk, '\0', BULK_TRACK_SIZE);
 659   if (last == NULL)
 660     last = &last_bulk[BULK_TRACK_SIZE - 1];
 661   else if (last != last_bulk)
 662     last--;
 663   if (last[0] == '\n')
 664     {
 665       rev = 1;
 666       last[0] = '\0';
 667     }
 668   ft =
 669     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   va_list vacp;
 725
 726   va_copy (vacp, va);
 727   size = VSNPRINTF (NULL, 0, message, vacp) + 1;
 728   GNUNET_assert (0 != size);
 729   va_end (vacp);
 730   {
 731     char buf[size];
 732
 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))
 757         && (last_bulk_time.abs_value != 0)
 758         && (0 == strncmp (buf, last_bulk, sizeof (last_bulk))))
 759       {
 760         last_bulk_repeat++;
 761         if ((GNUNET_TIME_absolute_get_duration (last_bulk_time).rel_value >
 762              BULK_DELAY_THRESHOLD)
 763             || (last_bulk_repeat > BULK_REPEAT_THRESHOLD))
 764           flush_bulk (date);
 765         return;
 766       }
 767     flush_bulk (date);
 768     strncpy (last_bulk, buf, sizeof (last_bulk));
 769     last_bulk_repeat = 0;
 770     last_bulk_kind = kind;
 771     last_bulk_time = GNUNET_TIME_absolute_get ();
 772     strncpy (last_bulk_comp, comp, COMP_TRACK_SIZE);
 773     output_message (kind, comp, date, buf);
 774   }
 775 }
 776
 777
 778 /**
 779  * Main log function.
 780  *
 781  * @param kind how serious is the error?
 782  * @param message what is the message (format string)
 783  * @param ... arguments for format string
 784  */
 785 void
 786 GNUNET_log_nocheck (enum GNUNET_ErrorType kind, const char *message, ...)
 787 {
 788   va_list va;
 789
 790   va_start (va, message);
 791   mylog (kind, component, message, va);
 792   va_end (va);
 793 }
 794
 795
 796 /**
 797  * Log function that specifies an alternative component.
 798  * This function should be used by plugins.
 799  *
 800  * @param kind how serious is the error?
 801  * @param comp component responsible for generating the message
 802  * @param message what is the message (format string)
 803  * @param ... arguments for format string
 804  */
 805 void
 806 GNUNET_log_from_nocheck (enum GNUNET_ErrorType kind, const char *comp,
 807                          const char *message, ...)
 808 {
 809   va_list va;
 810   char comp_w_pid[128];
 811
 812   if (comp == NULL)
 813     comp = component_nopid;
 814
 815   va_start (va, message);
 816   GNUNET_snprintf (comp_w_pid, sizeof (comp_w_pid), "%s-%d", comp, getpid ());
 817   mylog (kind, comp_w_pid, message, va);
 818   va_end (va);
 819 }
 820
 821
 822 /**
 823  * Convert error type to string.
 824  *
 825  * @param kind type to convert
 826  * @return string corresponding to the type
 827  */
 828 const char *
 829 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind)
 830 {
 831   if ((kind & GNUNET_ERROR_TYPE_ERROR) > 0)
 832     return _("ERROR");
 833   if ((kind & GNUNET_ERROR_TYPE_WARNING) > 0)
 834     return _("WARNING");
 835   if ((kind & GNUNET_ERROR_TYPE_INFO) > 0)
 836     return _("INFO");
 837   if ((kind & GNUNET_ERROR_TYPE_DEBUG) > 0)
 838     return _("DEBUG");
 839   if ((kind & ~GNUNET_ERROR_TYPE_BULK) == 0)
 840     return _("NONE");
 841   return _("INVALID");
 842 }
 843
 844
 845 /**
 846  * Convert a hash to a string (for printing debug messages).
 847  * This is one of the very few calls in the entire API that is
 848  * NOT reentrant!
 849  *
 850  * @param hc the hash code
 851  * @return string form; will be overwritten by next call to GNUNET_h2s.
 852  */
 853 const char *
 854 GNUNET_h2s (const GNUNET_HashCode * hc)
 855 {
 856   static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
 857
 858   GNUNET_CRYPTO_hash_to_enc (hc, &ret);
 859   ret.encoding[8] = '\0';
 860   return (const char *) ret.encoding;
 861 }
 862
 863 /**
 864  * Convert a hash to a string (for printing debug messages).
 865  * This is one of the very few calls in the entire API that is
 866  * NOT reentrant!
 867  *
 868  * @param hc the hash code
 869  * @return string form; will be overwritten by next call to GNUNET_h2s_full.
 870  */
 871 const char *
 872 GNUNET_h2s_full (const GNUNET_HashCode * hc)
 873 {
 874   static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
 875
 876   GNUNET_CRYPTO_hash_to_enc (hc, &ret);
 877   ret.encoding[sizeof (ret) - 1] = '\0';
 878   return (const char *) ret.encoding;
 879 }
 880
 881 /**
 882  * Convert a peer identity to a string (for printing debug messages).
 883  * This is one of the very few calls in the entire API that is
 884  * NOT reentrant!
 885  *
 886  * @param pid the peer identity
 887  * @return string form of the pid; will be overwritten by next
 888  *         call to GNUNET_i2s.
 889  */
 890 const char *
 891 GNUNET_i2s (const struct GNUNET_PeerIdentity *pid)
 892 {
 893   static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
 894
 895   GNUNET_CRYPTO_hash_to_enc (&pid->hashPubKey, &ret);
 896   ret.encoding[4] = '\0';
 897   return (const char *) ret.encoding;
 898 }
 899
 900
 901
 902 /**
 903  * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
 904  * (for printing debug messages).  This is one of the very few calls
 905  * in the entire API that is NOT reentrant!
 906  *
 907  * @param addr the address
 908  * @param addrlen the length of the address
 909  * @return nicely formatted string for the address
 910  *  will be overwritten by next call to GNUNET_a2s.
 911  */
 912 const char *
 913 GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen)
 914 {
 915   static char buf[INET6_ADDRSTRLEN + 8];
 916   static char b2[6];
 917   const struct sockaddr_in *v4;
 918   const struct sockaddr_un *un;
 919   const struct sockaddr_in6 *v6;
 920   unsigned int off;
 921
 922   if (addr == NULL)
 923     return _("unknown address");
 924   switch (addr->sa_family)
 925     {
 926     case AF_INET:
 927       if (addrlen != sizeof (struct sockaddr_in))
 928         return "<invalid v4 address>";
 929       v4 = (const struct sockaddr_in *) addr;
 930       inet_ntop (AF_INET, &v4->sin_addr, buf, INET_ADDRSTRLEN);
 931       if (0 == ntohs (v4->sin_port))
 932         return buf;
 933       strcat (buf, ":");
 934       GNUNET_snprintf (b2, sizeof (b2), "%u", ntohs (v4->sin_port));
 935       strcat (buf, b2);
 936       return buf;
 937     case AF_INET6:
 938       if (addrlen != sizeof (struct sockaddr_in6))
 939         return "<invalid v4 address>";
 940       v6 = (const struct sockaddr_in6 *) addr;
 941       buf[0] = '[';
 942       inet_ntop (AF_INET6, &v6->sin6_addr, &buf[1], INET6_ADDRSTRLEN);
 943       if (0 == ntohs (v6->sin6_port))
 944         return &buf[1];
 945       strcat (buf, "]:");
 946       GNUNET_snprintf (b2, sizeof (b2), "%u", ntohs (v6->sin6_port));
 947       strcat (buf, b2);
 948       return buf;
 949     case AF_UNIX:
 950       if (addrlen <= sizeof (sa_family_t))
 951         return "<unbound UNIX client>";
 952       un = (const struct sockaddr_un *) addr;
 953       off = 0;
 954       if (un->sun_path[0] == '\0')
 955         off++;
 956       snprintf (buf, sizeof (buf), "%s%.*s", (off == 1) ? "@" : "",
 957                 (int) (addrlen - sizeof (sa_family_t) - 1 - off),
 958                 &un->sun_path[off]);
 959       return buf;
 960     default:
 961       return _("invalid address");
 962     }
 963 }
 964
 965
 966 /**
 967  * Initializer
 968  */
 969 void __attribute__ ((constructor)) GNUNET_util_cl_init ()
 970 {
 971   GNUNET_stderr = stderr;
 972 #ifdef MINGW
 973   GNInitWinEnv (NULL);
 974 #endif
 975 }
 976
 977
 978 /**
 979  * Destructor
 980  */
 981 void __attribute__ ((destructor)) GNUNET_util_cl_fini ()
 982 {
 983 #ifdef MINGW
 984   GNShutdownWinEnv ();
 985 #endif
 986 }
 987
 988 /* end of common_logging.c */