src/util/common_logging.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2006-2013 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 3, 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_util_lib.h"
  29 #include <regex.h>
  30
  31
  32 /**
  33  * After how many milliseconds do we always print
  34  * that "message X was repeated N times"?  Use 12h.
  35  */
  36 #define BULK_DELAY_THRESHOLD (12 * 60 * 60 * 1000LL * 1000LL)
  37
  38 /**
  39  * After how many repetitions do we always print
  40  * that "message X was repeated N times"? (even if
  41  * we have not yet reached the delay threshold)
  42  */
  43 #define BULK_REPEAT_THRESHOLD 1000
  44
  45 /**
  46  * How many characters do we use for matching of
  47  * bulk messages?
  48  */
  49 #define BULK_TRACK_SIZE 256
  50
  51 /**
  52  * How many characters do we use for matching of
  53  * bulk components?
  54  */
  55 #define COMP_TRACK_SIZE 32
  56
  57 /**
  58  * How many characters can a date/time string
  59  * be at most?
  60  */
  61 #define DATE_STR_SIZE 64
  62
  63 /**
  64  * How many log files to keep?
  65  */
  66 #define ROTATION_KEEP 3
  67
  68 #ifndef PATH_MAX
  69 /**
  70  * Assumed maximum path length (for the log file name).
  71  */
  72 #define PATH_MAX 4096
  73 #endif
  74
  75
  76 /**
  77  * Linked list of active loggers.
  78  */
  79 struct CustomLogger
  80 {
  81   /**
  82    * This is a linked list.
  83    */
  84   struct CustomLogger *next;
  85
  86   /**
  87    * Log function.
  88    */
  89   GNUNET_Logger logger;
  90
  91   /**
  92    * Closure for logger.
  93    */
  94   void *logger_cls;
  95 };
  96
  97 /**
  98  * The last "bulk" error message that we have been logging.
  99  * Note that this message maybe truncated to the first BULK_TRACK_SIZE
 100  * characters, in which case it is NOT 0-terminated!
 101  */
 102 static char last_bulk[BULK_TRACK_SIZE];
 103
 104 /**
 105  * Type of the last bulk message.
 106  */
 107 static enum GNUNET_ErrorType last_bulk_kind;
 108
 109 /**
 110  * Time of the last bulk error message (0 for none)
 111  */
 112 static struct GNUNET_TIME_Absolute last_bulk_time;
 113
 114 /**
 115  * Number of times that bulk message has been repeated since.
 116  */
 117 static unsigned int last_bulk_repeat;
 118
 119 /**
 120  * Component when the last bulk was logged.  Will be 0-terminated.
 121  */
 122 static char last_bulk_comp[COMP_TRACK_SIZE + 1];
 123
 124 /**
 125  * Running component.
 126  */
 127 static char *component;
 128
 129 /**
 130  * Running component (without pid).
 131  */
 132 static char *component_nopid;
 133
 134 /**
 135  * Format string describing the name of the log file.
 136  */
 137 static char *log_file_name;
 138
 139 /**
 140  * Minimum log level.
 141  */
 142 static enum GNUNET_ErrorType min_level;
 143
 144 /**
 145  * Linked list of our custom loggres.
 146  */
 147 static struct CustomLogger *loggers;
 148
 149 /**
 150  * Number of log calls to ignore.
 151  */
 152 int skip_log = 0;
 153
 154 /**
 155  * File descriptor to use for "stderr", or NULL for none.
 156  */
 157 static FILE *GNUNET_stderr;
 158
 159 /**
 160  * Represents a single logging definition
 161  */
 162 struct LogDef
 163 {
 164   /**
 165    * Component name regex
 166    */
 167   regex_t component_regex;
 168
 169   /**
 170    * File name regex
 171    */
 172   regex_t file_regex;
 173
 174   /**
 175    * Function name regex
 176    */
 177   regex_t function_regex;
 178
 179   /**
 180    * Lowest line at which this definition matches.
 181    * Defaults to 0. Must be <= to_line.
 182    */
 183   int from_line;
 184
 185   /**
 186    * Highest line at which this definition matches.
 187    * Defaults to INT_MAX. Must be >= from_line.
 188    */
 189   int to_line;
 190
 191   /**
 192    * Maximal log level allowed for calls that match this definition.
 193    * Calls with higher log level will be disabled.
 194    * Must be >= 0
 195    */
 196   int level;
 197
 198   /**
 199    * 1 if this definition comes from GNUNET_FORCE_LOG, which means that it
 200    * overrides any configuration options. 0 otherwise.
 201    */
 202   int force;
 203 };
 204
 205 /**
 206  * Dynamic array of logging definitions
 207  */
 208 static struct LogDef *logdefs;
 209
 210 /**
 211  * Allocated size of logdefs array (in units)
 212  */
 213 static int logdefs_size;
 214
 215 /**
 216  * The number of units used in logdefs array.
 217  */
 218 static int logdefs_len;
 219
 220 /**
 221  * GNUNET_YES if GNUNET_LOG environment variable is already parsed.
 222  */
 223 static int gnunet_log_parsed;
 224
 225 /**
 226  * GNUNET_YES if GNUNET_FORCE_LOG environment variable is already parsed.
 227  */
 228 static int gnunet_force_log_parsed;
 229
 230 /**
 231  * GNUNET_YES if at least one definition with forced == 1 is available.
 232  */
 233 static int gnunet_force_log_present;
 234
 235 #ifdef WINDOWS
 236 /**
 237  * Contains the number of performance counts per second.
 238  */
 239 static LARGE_INTEGER performance_frequency;
 240 #endif
 241
 242
 243 /**
 244  * Convert a textual description of a loglevel
 245  * to the respective GNUNET_GE_KIND.
 246  *
 247  * @param log loglevel to parse
 248  * @return GNUNET_GE_INVALID if log does not parse
 249  */
 250 static enum GNUNET_ErrorType
 251 get_type (const char *log)
 252 {
 253   if (NULL == log)
 254     return GNUNET_ERROR_TYPE_UNSPECIFIED;
 255   if (0 == strcasecmp (log, _("DEBUG")))
 256     return GNUNET_ERROR_TYPE_DEBUG;
 257   if (0 == strcasecmp (log, _("INFO")))
 258     return GNUNET_ERROR_TYPE_INFO;
 259   if (0 == strcasecmp (log, _("WARNING")))
 260     return GNUNET_ERROR_TYPE_WARNING;
 261   if (0 == strcasecmp (log, _("ERROR")))
 262     return GNUNET_ERROR_TYPE_ERROR;
 263   if (0 == strcasecmp (log, _("NONE")))
 264     return GNUNET_ERROR_TYPE_NONE;
 265   return GNUNET_ERROR_TYPE_INVALID;
 266 }
 267
 268
 269 #if !defined(GNUNET_CULL_LOGGING)
 270 /**
 271  * Utility function - reallocates logdefs array to be twice as large.
 272  */
 273 static void
 274 resize_logdefs ()
 275 {
 276   logdefs_size = (logdefs_size + 1) * 2;
 277   logdefs = GNUNET_realloc (logdefs, logdefs_size * sizeof (struct LogDef));
 278 }
 279
 280
 281 /**
 282  * Abort the process, generate a core dump if possible.
 283  */
 284 void
 285 GNUNET_abort ()
 286 {
 287 #if WINDOWS
 288   DebugBreak ();
 289 #endif
 290   abort ();
 291 }
 292
 293
 294 /**
 295  * Rotate logs, deleting the oldest log.
 296  *
 297  * @param new_name new name to add to the rotation
 298  */
 299 static void
 300 log_rotate (const char *new_name)
 301 {
 302   static char *rotation[ROTATION_KEEP];
 303   static unsigned int rotation_off;
 304   char *discard;
 305
 306   if ('\0' == *new_name)
 307     return; /* not a real log file name */
 308   discard = rotation[rotation_off % ROTATION_KEEP];
 309   if (NULL != discard)
 310   {
 311     /* Note: can't log errors during logging (recursion!), so this
 312        operation MUST silently fail... */
 313     (void) UNLINK (discard);
 314     GNUNET_free (discard);
 315   }
 316   rotation[rotation_off % ROTATION_KEEP] = GNUNET_strdup (new_name);
 317   rotation_off++;
 318 }
 319
 320
 321 /**
 322  * Setup the log file.
 323  *
 324  * @param tm timestamp for which we should setup logging
 325  * @return GNUNET_OK on success, GNUNET_SYSERR on error
 326  */
 327 static int
 328 setup_log_file (const struct tm *tm)
 329 {
 330   static char last_fn[PATH_MAX + 1];
 331   char fn[PATH_MAX + 1];
 332   int dirwarn;
 333   int altlog_fd;
 334   int dup_return;
 335   FILE *altlog;
 336   char *leftsquare;
 337
 338   if (NULL == log_file_name)
 339     return GNUNET_SYSERR;
 340   if (0 == strftime (fn, sizeof (fn), log_file_name, tm))
 341     return GNUNET_SYSERR;
 342   leftsquare = strrchr (fn, '[');
 343   if ( (NULL != leftsquare) && (']' == leftsquare[1]) )
 344   {
 345     char *logfile_copy = GNUNET_strdup (fn);
 346     logfile_copy[leftsquare - fn] = '\0';
 347     logfile_copy[leftsquare - fn + 1] = '\0';
 348     snprintf (fn, PATH_MAX, "%s%d%s",
 349          logfile_copy, getpid (), &logfile_copy[leftsquare - fn + 2]);
 350     GNUNET_free (logfile_copy);
 351   }
 352   if (0 == strcmp (fn, last_fn))
 353     return GNUNET_OK; /* no change */
 354   log_rotate (last_fn);
 355   strcpy (last_fn, fn);
 356   dirwarn = (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn));
 357 #if WINDOWS
 358   altlog_fd = OPEN (fn, O_APPEND |
 359                         O_BINARY |
 360                         O_WRONLY | O_CREAT,
 361                         _S_IREAD | _S_IWRITE);
 362 #else
 363   altlog_fd = OPEN (fn, O_APPEND |
 364                         O_WRONLY | O_CREAT,
 365                         S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
 366 #endif
 367   if (-1 != altlog_fd)
 368   {
 369     if (NULL != GNUNET_stderr)
 370       fclose (GNUNET_stderr);
 371     dup_return = dup2 (altlog_fd, 2);
 372     (void) close (altlog_fd);
 373     if (-1 != dup_return)
 374     {
 375       altlog = fdopen (2, "ab");
 376       if (NULL == altlog)
 377       {
 378         (void) close (2);
 379         altlog_fd = -1;
 380       }
 381     }
 382     else
 383     {
 384       altlog_fd = -1;
 385     }
 386   }
 387   if (-1 == altlog_fd)
 388   {
 389     GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "open", fn);
 390     if (dirwarn)
 391       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
 392                   _("Failed to create or access directory for log file `%s'\n"),
 393                   fn);
 394     return GNUNET_SYSERR;
 395   }
 396   GNUNET_stderr = altlog;
 397   return GNUNET_OK;
 398 }
 399
 400 /**
 401  * Utility function - adds a parsed definition to logdefs array.
 402  *
 403  * @param component see struct LogDef, can't be NULL
 404  * @param file see struct LogDef, can't be NULL
 405  * @param function see struct LogDef, can't be NULL
 406  * @param from_line see struct LogDef
 407  * @param to_line see struct LogDef
 408  * @param level see struct LogDef, must be >= 0
 409  * @param force see struct LogDef
 410  * @return 0 on success, regex-specific error otherwise
 411  */
 412 static int
 413 add_definition (char *component, char *file, char *function, int from_line,
 414                 int to_line, int level, int force)
 415 {
 416   struct LogDef n;
 417   int r;
 418
 419   if (logdefs_size == logdefs_len)
 420     resize_logdefs ();
 421   memset (&n, 0, sizeof (n));
 422   if (0 == strlen (component))
 423     component = (char *) ".*";
 424   r = regcomp (&n.component_regex, (const char *) component, REG_NOSUB);
 425   if (0 != r)
 426   {
 427     return r;
 428   }
 429   if (0 == strlen (file))
 430     file = (char *) ".*";
 431   r = regcomp (&n.file_regex, (const char *) file, REG_NOSUB);
 432   if (0 != r)
 433   {
 434     regfree (&n.component_regex);
 435     return r;
 436   }
 437   if ((NULL == function) || (0 == strlen (function)))
 438     function = (char *) ".*";
 439   r = regcomp (&n.function_regex, (const char *) function, REG_NOSUB);
 440   if (0 != r)
 441   {
 442     regfree (&n.component_regex);
 443     regfree (&n.file_regex);
 444     return r;
 445   }
 446   n.from_line = from_line;
 447   n.to_line = to_line;
 448   n.level = level;
 449   n.force = force;
 450   logdefs[logdefs_len++] = n;
 451   return 0;
 452 }
 453
 454
 455 /**
 456  * Decides whether a particular logging call should or should not be allowed
 457  * to be made. Used internally by GNUNET_log*()
 458  *
 459  * @param caller_level loglevel the caller wants to use
 460  * @param comp component name the caller uses (NULL means that global
 461  *   component name is used)
 462  * @param file file name containing the logging call, usually __FILE__
 463  * @param function function which tries to make a logging call,
 464  *   usually __FUNCTION__
 465  * @param line line at which the call is made, usually __LINE__
 466  * @return 0 to disallow the call, 1 to allow it
 467  */
 468 int
 469 GNUNET_get_log_call_status (int caller_level, const char *comp,
 470                             const char *file, const char *function, int line)
 471 {
 472   struct LogDef *ld;
 473   int i;
 474   int force_only;
 475
 476   if (NULL == comp)
 477     /* Use default component */
 478     comp = component_nopid;
 479
 480   /* We have no definitions to override globally configured log level,
 481    * so just use it right away.
 482    */
 483   if ( (min_level >= 0) && (GNUNET_NO == gnunet_force_log_present) )
 484     return caller_level <= min_level;
 485
 486   /* Only look for forced definitions? */
 487   force_only = min_level >= 0;
 488   for (i = 0; i < logdefs_len; i++)
 489   {
 490     ld = &logdefs[i];
 491     if (( (!force_only) || ld->force) &&
 492         (line >= ld->from_line && line <= ld->to_line) &&
 493         (0 == regexec (&ld->component_regex, comp, 0, NULL, 0)) &&
 494         (0 == regexec (&ld->file_regex, file, 0, NULL, 0)) &&
 495         (0 == regexec (&ld->function_regex, function, 0, NULL, 0)))
 496     {
 497       /* We're finished */
 498       return caller_level <= ld->level;
 499     }
 500   }
 501   /* No matches - use global level, if defined */
 502   if (min_level >= 0)
 503     return caller_level <= min_level;
 504   /* All programs/services previously defaulted to WARNING.
 505    * Now WE default to WARNING, and THEY default to NULL.
 506    */
 507   return caller_level <= GNUNET_ERROR_TYPE_WARNING;
 508 }
 509
 510
 511 /**
 512  * Utility function - parses a definition
 513  *
 514  * Definition format:
 515  * component;file;function;from_line-to_line;level[/component...]
 516  * All entries are mandatory, but may be empty.
 517  * Empty entries for component, file and function are treated as
 518  * "matches anything".
 519  * Empty line entry is treated as "from 0 to INT_MAX"
 520  * Line entry with only one line is treated as "this line only"
 521  * Entry for level MUST NOT be empty.
 522  * Entries for component, file and function that consist of a
 523  * single character "*" are treated (at the moment) the same way
 524  * empty entries are treated (wildcard matching is not implemented (yet?)).
 525  * file entry is matched to the end of __FILE__. That is, it might be
 526  * a base name, or a base name with leading directory names (some compilers
 527  * define __FILE__ to absolute file path).
 528  *
 529  * @param constname name of the environment variable from which to get the
 530  *   string to be parsed
 531  * @param force 1 if definitions found in constname are to be forced
 532  * @return number of added definitions
 533  */
 534 static int
 535 parse_definitions (const char *constname, int force)
 536 {
 537   char *def;
 538   const char *tmp;
 539   char *comp = NULL;
 540   char *file = NULL;
 541   char *function = NULL;
 542   char *p;
 543   char *start;
 544   char *t;
 545   short state;
 546   int level;
 547   int from_line, to_line;
 548   int counter = 0;
 549   int keep_looking = 1;
 550
 551   tmp = getenv (constname);
 552   if (NULL == tmp)
 553     return 0;
 554   def = GNUNET_strdup (tmp);
 555   from_line = 0;
 556   to_line = INT_MAX;
 557   for (p = def, state = 0, start = def; keep_looking; p++)
 558   {
 559     switch (p[0])
 560     {
 561     case ';':                  /* found a field separator */
 562       p[0] = '\0';
 563       switch (state)
 564       {
 565       case 0:                  /* within a component name */
 566         comp = start;
 567         break;
 568       case 1:                  /* within a file name */
 569         file = start;
 570         break;
 571       case 2:                  /* within a function name */
 572         /* after a file name there must be a function name */
 573         function = start;
 574         break;
 575       case 3:                  /* within a from-to line range */
 576         if (strlen (start) > 0)
 577         {
 578           errno = 0;
 579           from_line = strtol (start, &t, 10);
 580           if ( (0 != errno) || (from_line < 0) )
 581           {
 582             GNUNET_free (def);
 583             return counter;
 584           }
 585           if ( (t < p) && ('-' == t[0]) )
 586           {
 587             errno = 0;
 588             start = t + 1;
 589             to_line = strtol (start, &t, 10);
 590             if ( (0 != errno) || (to_line < 0) || (t != p) )
 591             {
 592               GNUNET_free (def);
 593               return counter;
 594             }
 595           }
 596           else                  /* one number means "match this line only" */
 597             to_line = from_line;
 598         }
 599         else                    /* default to 0-max */
 600         {
 601           from_line = 0;
 602           to_line = INT_MAX;
 603         }
 604         break;
 605       }
 606       start = p + 1;
 607       state++;
 608       break;
 609     case '\0':                 /* found EOL */
 610       keep_looking = 0;
 611       /* fall through to '/' */
 612     case '/':                  /* found a definition separator */
 613       switch (state)
 614       {
 615       case 4:                  /* within a log level */
 616         p[0] = '\0';
 617         state = 0;
 618         level = get_type ((const char *) start);
 619         if ( (GNUNET_ERROR_TYPE_INVALID == level) ||
 620              (GNUNET_ERROR_TYPE_UNSPECIFIED == level) ||
 621              (0 != add_definition (comp, file, function, from_line, to_line,
 622                                    level, force)) )
 623         {
 624           GNUNET_free (def);
 625           return counter;
 626         }
 627         counter++;
 628         start = p + 1;
 629         break;
 630       default:
 631         break;
 632       }
 633     default:
 634       break;
 635     }
 636   }
 637   GNUNET_free (def);
 638   return counter;
 639 }
 640
 641
 642 /**
 643  * Utility function - parses GNUNET_LOG and GNUNET_FORCE_LOG.
 644  */
 645 static void
 646 parse_all_definitions ()
 647 {
 648   if (GNUNET_NO == gnunet_log_parsed)
 649     parse_definitions ("GNUNET_LOG", 0);
 650   gnunet_log_parsed = GNUNET_YES;
 651   if (GNUNET_NO == gnunet_force_log_parsed)
 652     gnunet_force_log_present =
 653         parse_definitions ("GNUNET_FORCE_LOG", 1) > 0 ? GNUNET_YES : GNUNET_NO;
 654   gnunet_force_log_parsed = GNUNET_YES;
 655 }
 656 #endif
 657
 658
 659 /**
 660  * Setup logging.
 661  *
 662  * @param comp default component to use
 663  * @param loglevel what types of messages should be logged
 664  * @param logfile which file to write log messages to (can be NULL)
 665  * @return #GNUNET_OK on success
 666  */
 667 int
 668 GNUNET_log_setup (const char *comp,
 669                   const char *loglevel,
 670                   const char *logfile)
 671 {
 672   const char *env_logfile;
 673   const struct tm *tm;
 674   time_t t;
 675
 676   min_level = get_type (loglevel);
 677 #if !defined(GNUNET_CULL_LOGGING)
 678   parse_all_definitions ();
 679 #endif
 680 #ifdef WINDOWS
 681   QueryPerformanceFrequency (&performance_frequency);
 682 #endif
 683   GNUNET_free_non_null (component);
 684   GNUNET_asprintf (&component, "%s-%d", comp, getpid ());
 685   GNUNET_free_non_null (component_nopid);
 686   component_nopid = GNUNET_strdup (comp);
 687
 688   env_logfile = getenv ("GNUNET_FORCE_LOGFILE");
 689   if ((NULL != env_logfile) && (strlen (env_logfile) > 0))
 690     logfile = env_logfile;
 691   if (NULL == logfile)
 692     return GNUNET_OK;
 693   GNUNET_free_non_null (log_file_name);
 694   log_file_name = GNUNET_STRINGS_filename_expand (logfile);
 695   if (NULL == log_file_name)
 696     return GNUNET_SYSERR;
 697   t = time (NULL);
 698   tm = gmtime (&t);
 699   return setup_log_file (tm);
 700 }
 701
 702
 703 /**
 704  * Add a custom logger.
 705  *
 706  * @param logger log function
 707  * @param logger_cls closure for logger
 708  */
 709 void
 710 GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls)
 711 {
 712   struct CustomLogger *entry;
 713
 714   entry = GNUNET_malloc (sizeof (struct CustomLogger));
 715   entry->logger = logger;
 716   entry->logger_cls = logger_cls;
 717   entry->next = loggers;
 718   loggers = entry;
 719 }
 720
 721
 722 /**
 723  * Remove a custom logger.
 724  *
 725  * @param logger log function
 726  * @param logger_cls closure for logger
 727  */
 728 void
 729 GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls)
 730 {
 731   struct CustomLogger *pos;
 732   struct CustomLogger *prev;
 733
 734   prev = NULL;
 735   pos = loggers;
 736   while ((pos != NULL) &&
 737          ((pos->logger != logger) || (pos->logger_cls != logger_cls)))
 738   {
 739     prev = pos;
 740     pos = pos->next;
 741   }
 742   GNUNET_assert (pos != NULL);
 743   if (prev == NULL)
 744     loggers = pos->next;
 745   else
 746     prev->next = pos->next;
 747   GNUNET_free (pos);
 748 }
 749
 750 #if WINDOWS
 751 CRITICAL_SECTION output_message_cs;
 752 #endif
 753
 754
 755 /**
 756  * Actually output the log message.
 757  *
 758  * @param kind how severe was the issue
 759  * @param comp component responsible
 760  * @param datestr current date/time
 761  * @param msg the actual message
 762  */
 763 static void
 764 output_message (enum GNUNET_ErrorType kind, const char *comp,
 765                 const char *datestr, const char *msg)
 766 {
 767   struct CustomLogger *pos;
 768 #if WINDOWS
 769   EnterCriticalSection (&output_message_cs);
 770 #endif
 771   if (NULL != GNUNET_stderr)
 772   {
 773     FPRINTF (GNUNET_stderr, "%s %s %s %s", datestr, comp,
 774              GNUNET_error_type_to_string (kind), msg);
 775     fflush (GNUNET_stderr);
 776   }
 777   pos = loggers;
 778   while (pos != NULL)
 779   {
 780     pos->logger (pos->logger_cls, kind, comp, datestr, msg);
 781     pos = pos->next;
 782   }
 783 #if WINDOWS
 784   LeaveCriticalSection (&output_message_cs);
 785 #endif
 786 }
 787
 788
 789 /**
 790  * Flush an existing bulk report to the output.
 791  *
 792  * @param datestr our current timestamp
 793  */
 794 static void
 795 flush_bulk (const char *datestr)
 796 {
 797   char msg[DATE_STR_SIZE + BULK_TRACK_SIZE + 256];
 798   int rev;
 799   char *last;
 800   const char *ft;
 801
 802   if ((0 == last_bulk_time.abs_value_us) || (0 == last_bulk_repeat))
 803     return;
 804   rev = 0;
 805   last = memchr (last_bulk, '\0', BULK_TRACK_SIZE);
 806   if (last == NULL)
 807     last = &last_bulk[BULK_TRACK_SIZE - 1];
 808   else if (last != last_bulk)
 809     last--;
 810   if (last[0] == '\n')
 811   {
 812     rev = 1;
 813     last[0] = '\0';
 814   }
 815   ft = GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration
 816                                                (last_bulk_time), GNUNET_YES);
 817   snprintf (msg, sizeof (msg),
 818             _("Message `%.*s' repeated %u times in the last %s\n"),
 819             BULK_TRACK_SIZE, last_bulk, last_bulk_repeat, ft);
 820   if (rev == 1)
 821     last[0] = '\n';
 822   output_message (last_bulk_kind, last_bulk_comp, datestr, msg);
 823   last_bulk_time = GNUNET_TIME_absolute_get ();
 824   last_bulk_repeat = 0;
 825 }
 826
 827
 828 /**
 829  * Ignore the next n calls to the log function.
 830  *
 831  * @param n number of log calls to ignore (could be negative)
 832  * @param check_reset #GNUNET_YES to assert that the log skip counter is currently zero
 833  */
 834 void
 835 GNUNET_log_skip (int n,
 836                  int check_reset)
 837 {
 838   int ok;
 839
 840   if (0 == n)
 841   {
 842     ok = (0 == skip_log);
 843     skip_log = 0;
 844     if (check_reset)
 845       GNUNET_break (ok);
 846   }
 847   else
 848   {
 849     skip_log += n;
 850   }
 851 }
 852
 853
 854 /**
 855  * Get the number of log calls that are going to be skipped
 856  *
 857  * @return number of log calls to be ignored
 858  */
 859 int
 860 GNUNET_get_log_skip ()
 861 {
 862   return skip_log;
 863 }
 864
 865
 866 /**
 867  * Output a log message using the default mechanism.
 868  *
 869  * @param kind how severe was the issue
 870  * @param comp component responsible
 871  * @param message the actual message
 872  * @param va arguments to the format string "message"
 873  */
 874 static void
 875 mylog (enum GNUNET_ErrorType kind,
 876        const char *comp,
 877        const char *message,
 878        va_list va)
 879 {
 880   char date[DATE_STR_SIZE];
 881   char date2[DATE_STR_SIZE];
 882   struct tm *tmptr;
 883   size_t size;
 884   va_list vacp;
 885
 886   va_copy (vacp, va);
 887   size = VSNPRINTF (NULL, 0, message, vacp) + 1;
 888   GNUNET_assert (0 != size);
 889   va_end (vacp);
 890   memset (date, 0, DATE_STR_SIZE);
 891   {
 892     char buf[size];
 893     long long offset;
 894 #ifdef WINDOWS
 895     LARGE_INTEGER pc;
 896     time_t timetmp;
 897
 898     offset = GNUNET_TIME_get_offset ();
 899     time (&timetmp);
 900     timetmp += offset / 1000;
 901     tmptr = localtime (&timetmp);
 902     pc.QuadPart = 0;
 903     QueryPerformanceCounter (&pc);
 904     if (NULL == tmptr)
 905     {
 906       strcpy (date, "localtime error");
 907     }
 908     else
 909     {
 910       strftime (date2, DATE_STR_SIZE, "%b %d %H:%M:%S-%%020llu", tmptr);
 911       snprintf (date, sizeof (date), date2,
 912                 (long long) (pc.QuadPart /
 913                              (performance_frequency.QuadPart / 1000)));
 914     }
 915 #else
 916     struct timeval timeofday;
 917
 918     gettimeofday (&timeofday, NULL);
 919     offset = GNUNET_TIME_get_offset ();
 920     if (offset > 0)
 921     {
 922       timeofday.tv_sec += offset / 1000LL;
 923       timeofday.tv_usec += (offset % 1000LL) * 1000LL;
 924       if (timeofday.tv_usec > 1000000LL)
 925       {
 926         timeofday.tv_usec -= 1000000LL;
 927         timeofday.tv_sec++;
 928       }
 929     }
 930     else
 931     {
 932       timeofday.tv_sec += offset / 1000LL;
 933       if (timeofday.tv_usec > - (offset % 1000LL) * 1000LL)
 934       {
 935         timeofday.tv_usec += (offset % 1000LL) * 1000LL;
 936       }
 937       else
 938       {
 939         timeofday.tv_usec += 1000000LL + (offset % 1000LL) * 1000LL;
 940         timeofday.tv_sec--;
 941       }
 942     }
 943     tmptr = localtime (&timeofday.tv_sec);
 944     if (NULL == tmptr)
 945     {
 946       strcpy (date, "localtime error");
 947     }
 948     else
 949     {
 950       strftime (date2, DATE_STR_SIZE, "%b %d %H:%M:%S-%%06u", tmptr);
 951       snprintf (date, sizeof (date), date2, timeofday.tv_usec);
 952     }
 953 #endif
 954     VSNPRINTF (buf, size, message, va);
 955     if (NULL != tmptr)
 956       (void) setup_log_file (tmptr);
 957     if ((0 != (kind & GNUNET_ERROR_TYPE_BULK)) &&
 958         (0 != last_bulk_time.abs_value_us) &&
 959         (0 == strncmp (buf, last_bulk, sizeof (last_bulk))))
 960     {
 961       last_bulk_repeat++;
 962       if ( (GNUNET_TIME_absolute_get_duration (last_bulk_time).rel_value_us >
 963             BULK_DELAY_THRESHOLD) ||
 964            (last_bulk_repeat > BULK_REPEAT_THRESHOLD) )
 965         flush_bulk (date);
 966       return;
 967     }
 968     flush_bulk (date);
 969     strncpy (last_bulk, buf, sizeof (last_bulk));
 970     last_bulk_repeat = 0;
 971     last_bulk_kind = kind;
 972     last_bulk_time = GNUNET_TIME_absolute_get ();
 973     strncpy (last_bulk_comp, comp, COMP_TRACK_SIZE);
 974     output_message (kind, comp, date, buf);
 975   }
 976 }
 977
 978
 979 /**
 980  * Main log function.
 981  *
 982  * @param kind how serious is the error?
 983  * @param message what is the message (format string)
 984  * @param ... arguments for format string
 985  */
 986 void
 987 GNUNET_log_nocheck (enum GNUNET_ErrorType kind,
 988                     const char *message, ...)
 989 {
 990   va_list va;
 991
 992   va_start (va, message);
 993   mylog (kind, component, message, va);
 994   va_end (va);
 995 }
 996
 997
 998 /**
 999  * Log function that specifies an alternative component.
1000  * This function should be used by plugins.
1001  *
1002  * @param kind how serious is the error?
1003  * @param comp component responsible for generating the message
1004  * @param message what is the message (format string)
1005  * @param ... arguments for format string
1006  */
1007 void
1008 GNUNET_log_from_nocheck (enum GNUNET_ErrorType kind, const char *comp,
1009                          const char *message, ...)
1010 {
1011   va_list va;
1012   char comp_w_pid[128];
1013
1014   if (comp == NULL)
1015     comp = component_nopid;
1016
1017   va_start (va, message);
1018   GNUNET_snprintf (comp_w_pid, sizeof (comp_w_pid), "%s-%d", comp, getpid ());
1019   mylog (kind, comp_w_pid, message, va);
1020   va_end (va);
1021 }
1022
1023
1024 /**
1025  * Convert error type to string.
1026  *
1027  * @param kind type to convert
1028  * @return string corresponding to the type
1029  */
1030 const char *
1031 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind)
1032 {
1033   if ((kind & GNUNET_ERROR_TYPE_ERROR) > 0)
1034     return _("ERROR");
1035   if ((kind & GNUNET_ERROR_TYPE_WARNING) > 0)
1036     return _("WARNING");
1037   if ((kind & GNUNET_ERROR_TYPE_INFO) > 0)
1038     return _("INFO");
1039   if ((kind & GNUNET_ERROR_TYPE_DEBUG) > 0)
1040     return _("DEBUG");
1041   if ((kind & ~GNUNET_ERROR_TYPE_BULK) == 0)
1042     return _("NONE");
1043   return _("INVALID");
1044 }
1045
1046
1047 /**
1048  * Convert a hash to a string (for printing debug messages).
1049  * This is one of the very few calls in the entire API that is
1050  * NOT reentrant!
1051  *
1052  * @param hc the hash code
1053  * @return string form; will be overwritten by next call to GNUNET_h2s.
1054  */
1055 const char *
1056 GNUNET_h2s (const struct GNUNET_HashCode * hc)
1057 {
1058   static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
1059
1060   GNUNET_CRYPTO_hash_to_enc (hc, &ret);
1061   ret.encoding[8] = '\0';
1062   return (const char *) ret.encoding;
1063 }
1064
1065
1066 /**
1067  * Convert a hash to a string (for printing debug messages).
1068  * This is one of the very few calls in the entire API that is
1069  * NOT reentrant!
1070  *
1071  * @param hc the hash code
1072  * @return string form; will be overwritten by next call to GNUNET_h2s_full.
1073  */
1074 const char *
1075 GNUNET_h2s_full (const struct GNUNET_HashCode * hc)
1076 {
1077   static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
1078
1079   GNUNET_CRYPTO_hash_to_enc (hc, &ret);
1080   ret.encoding[sizeof (ret) - 1] = '\0';
1081   return (const char *) ret.encoding;
1082 }
1083
1084
1085 /**
1086  * Convert a peer identity to a string (for printing debug messages).
1087  * This is one of the very few calls in the entire API that is
1088  * NOT reentrant!
1089  *
1090  * @param pid the peer identity
1091  * @return string form of the pid; will be overwritten by next
1092  *         call to #GNUNET_i2s.
1093  */
1094 const char *
1095 GNUNET_i2s (const struct GNUNET_PeerIdentity *pid)
1096 {
1097   static char buf[256];
1098   char *ret;
1099
1100   ret = GNUNET_CRYPTO_ecc_public_sign_key_to_string (&pid->public_key);
1101   strcpy (buf, ret);
1102   GNUNET_free (ret);
1103   buf[4] = '\0';
1104   return buf;
1105 }
1106
1107
1108 /**
1109  * Convert a peer identity to a string (for printing debug messages).
1110  * This is one of the very few calls in the entire API that is
1111  * NOT reentrant!
1112  *
1113  * @param pid the peer identity
1114  * @return string form of the pid; will be overwritten by next
1115  *         call to #GNUNET_i2s_full.
1116  */
1117 const char *
1118 GNUNET_i2s_full (const struct GNUNET_PeerIdentity *pid)
1119 {
1120   static char buf[256];
1121   char *ret;
1122
1123   ret = GNUNET_CRYPTO_ecc_public_sign_key_to_string (&pid->public_key);
1124   strcpy (buf, ret);
1125   GNUNET_free (ret);
1126   return buf;
1127 }
1128
1129
1130 /**
1131  * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
1132  * (for printing debug messages).  This is one of the very few calls
1133  * in the entire API that is NOT reentrant!
1134  *
1135  * @param addr the address
1136  * @param addrlen the length of the address
1137  * @return nicely formatted string for the address
1138  *  will be overwritten by next call to GNUNET_a2s.
1139  */
1140 const char *
1141 GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen)
1142 {
1143   static char buf[INET6_ADDRSTRLEN + 8];
1144   static char b2[6];
1145   const struct sockaddr_in *v4;
1146   const struct sockaddr_un *un;
1147   const struct sockaddr_in6 *v6;
1148   unsigned int off;
1149
1150   if (addr == NULL)
1151     return _("unknown address");
1152   switch (addr->sa_family)
1153   {
1154   case AF_INET:
1155     if (addrlen != sizeof (struct sockaddr_in))
1156       return "<invalid v4 address>";
1157     v4 = (const struct sockaddr_in *) addr;
1158     inet_ntop (AF_INET, &v4->sin_addr, buf, INET_ADDRSTRLEN);
1159     if (0 == ntohs (v4->sin_port))
1160       return buf;
1161     strcat (buf, ":");
1162     GNUNET_snprintf (b2, sizeof (b2), "%u", ntohs (v4->sin_port));
1163     strcat (buf, b2);
1164     return buf;
1165   case AF_INET6:
1166     if (addrlen != sizeof (struct sockaddr_in6))
1167       return "<invalid v4 address>";
1168     v6 = (const struct sockaddr_in6 *) addr;
1169     buf[0] = '[';
1170     inet_ntop (AF_INET6, &v6->sin6_addr, &buf[1], INET6_ADDRSTRLEN);
1171     if (0 == ntohs (v6->sin6_port))
1172       return &buf[1];
1173     strcat (buf, "]:");
1174     GNUNET_snprintf (b2, sizeof (b2), "%u", ntohs (v6->sin6_port));
1175     strcat (buf, b2);
1176     return buf;
1177   case AF_UNIX:
1178     if (addrlen <= sizeof (sa_family_t))
1179       return "<unbound UNIX client>";
1180     un = (const struct sockaddr_un *) addr;
1181     off = 0;
1182     if (un->sun_path[0] == '\0')
1183       off++;
1184     memset (buf, 0, sizeof (buf));
1185     snprintf (buf, sizeof (buf) - 1, "%s%.*s", (off == 1) ? "@" : "",
1186               (int) (addrlen - sizeof (sa_family_t) - 1 - off),
1187               &un->sun_path[off]);
1188     return buf;
1189   default:
1190     return _("invalid address");
1191   }
1192 }
1193
1194
1195 /**
1196  * Log error message about missing configuration option.
1197  *
1198  * @param kind log level
1199  * @param section section with missing option
1200  * @param option name of missing option
1201  */
1202 void
1203 GNUNET_log_config_missing (enum GNUNET_ErrorType kind,
1204                            const char *section,
1205                            const char *option)
1206 {
1207   GNUNET_log (kind,
1208               _("Configuration fails to specify option `%s' in section `%s'!\n"),
1209               option,
1210               section);
1211 }
1212
1213
1214 /**
1215  * Log error message about invalid configuration option value.
1216  *
1217  * @param kind log level
1218  * @param section section with invalid option
1219  * @param option name of invalid option
1220  * @param required what is required that is invalid about the option
1221  */
1222 void
1223 GNUNET_log_config_invalid (enum GNUNET_ErrorType kind,
1224                            const char *section,
1225                            const char *option,
1226                            const char *required)
1227 {
1228   GNUNET_log (kind,
1229               _("Configuration specifies invalid value for option `%s' in section `%s': %s\n"),
1230               option, section, required);
1231 }
1232
1233
1234 /**
1235  * Initializer
1236  */
1237 void __attribute__ ((constructor)) GNUNET_util_cl_init ()
1238 {
1239   GNUNET_stderr = stderr;
1240 #ifdef MINGW
1241   GNInitWinEnv (NULL);
1242 #endif
1243 #if WINDOWS
1244   if (!InitializeCriticalSectionAndSpinCount (&output_message_cs, 0x00000400))\r
1245     GNUNET_abort ();
1246 #endif
1247 }
1248
1249
1250 /**
1251  * Destructor
1252  */
1253 void __attribute__ ((destructor)) GNUNET_util_cl_fini ()
1254 {
1255 #if WINDOWS
1256   DeleteCriticalSection (&output_message_cs);
1257 #endif
1258 #ifdef MINGW
1259   GNShutdownWinEnv ();
1260 #endif
1261 }
1262
1263 /* end of common_logging.c */