2 This file is part of GNUnet.
3 (C) 2006, 2008, 2009 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file util/common_logging.c
23 * @brief error handling API
25 * @author Christian Grothoff
28 #include "gnunet_common.h"
29 #include "gnunet_crypto_lib.h"
30 #include "gnunet_strings_lib.h"
31 #include "gnunet_time_lib.h"
36 * After how many milliseconds do we always print
37 * that "message X was repeated N times"? Use 12h.
39 #define BULK_DELAY_THRESHOLD (12 * 60 * 60 * 1000)
42 * After how many repetitions do we always print
43 * that "message X was repeated N times"? (even if
44 * we have not yet reached the delay threshold)
46 #define BULK_REPEAT_THRESHOLD 1000
49 * How many characters do we use for matching of
52 #define BULK_TRACK_SIZE 256
55 * How many characters do we use for matching of
58 #define COMP_TRACK_SIZE 32
61 * How many characters can a date/time string
64 #define DATE_STR_SIZE 64
67 * Linked list of active loggers.
72 * This is a linked list.
74 struct CustomLogger *next;
88 * The last "bulk" error message that we have been logging.
89 * Note that this message maybe truncated to the first BULK_TRACK_SIZE
90 * characters, in which case it is NOT 0-terminated!
92 static char last_bulk[BULK_TRACK_SIZE];
95 * Type of the last bulk message.
97 static enum GNUNET_ErrorType last_bulk_kind;
100 * Time of the last bulk error message (0 for none)
102 static struct GNUNET_TIME_Absolute last_bulk_time;
105 * Number of times that bulk message has been repeated since.
107 static unsigned int last_bulk_repeat;
110 * Component when the last bulk was logged. Will be 0-terminated.
112 static char last_bulk_comp[COMP_TRACK_SIZE + 1];
117 static char *component;
120 * Running component (without pid).
122 static char *component_nopid;
127 static enum GNUNET_ErrorType min_level;
130 * Linked list of our custom loggres.
132 static struct CustomLogger *loggers;
135 * Number of log calls to ignore.
137 unsigned int skip_log;
140 * File descriptor to use for "stderr", or NULL for none.
142 static FILE *GNUNET_stderr;
145 * Represents a single logging definition
150 * Component name regex
152 regex_t component_regex;
160 * Function name regex
162 regex_t function_regex;
165 * Lowest line at which this definition matches.
166 * Defaults to 0. Must be <= to_line.
171 * Highest line at which this definition matches.
172 * Defaults to INT_MAX. Must be >= from_line.
177 * Maximal log level allowed for calls that match this definition.
178 * Calls with higher log level will be disabled.
184 * 1 if this definition comes from GNUNET_FORCE_LOG, which means that it
185 * overrides any configuration options. 0 otherwise.
191 * Dynamic array of logging definitions
193 struct LogDef *logdefs = NULL;
196 * Allocated size of logdefs array (in units)
198 int logdefs_size = 0;
201 * The number of units used in logdefs array.
206 * GNUNET_YES if GNUNET_LOG environment variable is already parsed.
208 int gnunet_log_parsed = GNUNET_NO;
211 * GNUNET_YES if GNUNET_FORCE_LOG environment variable is already parsed.
213 int gnunet_force_log_parsed = GNUNET_NO;
216 * GNUNET_YES if at least one definition with forced == 1 is available.
218 int gnunet_force_log_present = GNUNET_NO;
222 * Contains the number of performance counts per second.
224 LARGE_INTEGER performance_frequency;
228 * Convert a textual description of a loglevel
229 * to the respective GNUNET_GE_KIND.
231 * @param log loglevel to parse
232 * @return GNUNET_GE_INVALID if log does not parse
234 static enum GNUNET_ErrorType
235 get_type (const char *log)
238 return GNUNET_ERROR_TYPE_UNSPECIFIED;
239 if (0 == strcasecmp (log, _("DEBUG")))
240 return GNUNET_ERROR_TYPE_DEBUG;
241 if (0 == strcasecmp (log, _("INFO")))
242 return GNUNET_ERROR_TYPE_INFO;
243 if (0 == strcasecmp (log, _("WARNING")))
244 return GNUNET_ERROR_TYPE_WARNING;
245 if (0 == strcasecmp (log, _("ERROR")))
246 return GNUNET_ERROR_TYPE_ERROR;
247 if (0 == strcasecmp (log, _("NONE")))
248 return GNUNET_ERROR_TYPE_NONE;
249 return GNUNET_ERROR_TYPE_INVALID;
252 #if !defined(GNUNET_CULL_LOGGING)
254 * Utility function - reallocates logdefs array to be twice as large.
259 logdefs_size = (logdefs_size + 1) * 2;
260 logdefs = GNUNET_realloc (logdefs, logdefs_size * sizeof (struct LogDef));
265 * Abort the process, generate a core dump if possible.
278 * Utility function - adds a parsed definition to logdefs array.
280 * @param component see struct LogDef, can't be NULL
281 * @param file see struct LogDef, can't be NULL
282 * @param function see struct LogDef, can't be NULL
283 * @param from_line see struct LogDef
284 * @param to_line see struct LogDef
285 * @param level see struct LogDef, must be >= 0
286 * @param force see struct LogDef
287 * @return 0 on success, regex-specific error otherwise
290 add_definition (char *component, char *file, char *function, int from_line,
291 int to_line, int level, int force)
296 if (logdefs_size == logdefs_len)
298 memset (&n, 0, sizeof (n));
299 if (strlen (component) == 0)
300 component = (char *) ".*";
301 r = regcomp (&n.component_regex, (const char *) component, REG_NOSUB);
306 if (strlen (file) == 0)
307 file = (char *) ".*";
308 r = regcomp (&n.file_regex, (const char *) file, REG_NOSUB);
311 regfree (&n.component_regex);
314 if ((NULL == function) || (strlen (function) == 0))
315 function = (char *) ".*";
316 r = regcomp (&n.function_regex, (const char *) function, REG_NOSUB);
319 regfree (&n.component_regex);
320 regfree (&n.file_regex);
323 n.from_line = from_line;
327 logdefs[logdefs_len++] = n;
333 * Decides whether a particular logging call should or should not be allowed
334 * to be made. Used internally by GNUNET_log*()
336 * @param caller_level loglevel the caller wants to use
337 * @param comp component name the caller uses (NULL means that global
338 * component name is used)
339 * @param file file name containing the logging call, usually __FILE__
340 * @param function function which tries to make a logging call,
341 * usually __FUNCTION__
342 * @param line line at which the call is made, usually __LINE__
343 * @return 0 to disallow the call, 1 to allow it
346 GNUNET_get_log_call_status (int caller_level, const char *comp,
347 const char *file, const char *function, int line)
354 /* Use default component */
355 comp = component_nopid;
357 /* We have no definitions to override globally configured log level,
358 * so just use it right away.
360 if (min_level >= 0 && gnunet_force_log_present == GNUNET_NO)
361 return caller_level <= min_level;
363 /* Only look for forced definitions? */
364 force_only = min_level >= 0;
365 for (i = 0; i < logdefs_len; i++)
368 if ((!force_only || ld->force) &&
369 (line >= ld->from_line && line <= ld->to_line) &&
370 (regexec (&ld->component_regex, comp, 0, NULL, 0) == 0) &&
371 (regexec (&ld->file_regex, file, 0, NULL, 0) == 0) &&
372 (regexec (&ld->function_regex, function, 0, NULL, 0) == 0))
375 return caller_level <= ld->level;
378 /* No matches - use global level, if defined */
380 return caller_level <= min_level;
381 /* All programs/services previously defaulted to WARNING.
382 * Now WE default to WARNING, and THEY default to NULL.
384 return caller_level <= GNUNET_ERROR_TYPE_WARNING;
389 * Utility function - parses a definition
392 * component;file;function;from_line-to_line;level[/component...]
393 * All entries are mandatory, but may be empty.
394 * Empty entries for component, file and function are treated as
395 * "matches anything".
396 * Empty line entry is treated as "from 0 to INT_MAX"
397 * Line entry with only one line is treated as "this line only"
398 * Entry for level MUST NOT be empty.
399 * Entries for component, file and function that consist of a
400 * single character "*" are treated (at the moment) the same way
401 * empty entries are treated (wildcard matching is not implemented (yet?)).
402 * file entry is matched to the end of __FILE__. That is, it might be
403 * a base name, or a base name with leading directory names (some compilers
404 * define __FILE__ to absolute file path).
406 * @param constname name of the environment variable from which to get the
407 * string to be parsed
408 * @param force 1 if definitions found in constname are to be forced
409 * @return number of added definitions
412 parse_definitions (const char *constname, int force)
418 char *function = NULL;
424 int from_line, to_line;
426 int keep_looking = 1;
428 tmp = getenv (constname);
431 def = GNUNET_strdup (tmp);
435 for (p = def, state = 0, start = def; keep_looking; p++)
439 case ';': /* found a field separator */
443 case 0: /* within a component name */
446 case 1: /* within a file name */
449 case 2: /* within a function name */
450 /* after a file name there must be a function name */
453 case 3: /* within a from-to line range */
454 if (strlen (start) > 0)
457 from_line = strtol (start, &t, 10);
458 if (errno != 0 || from_line < 0)
463 if (t < p && t[0] == '-')
467 to_line = strtol (start, &t, 10);
468 if (errno != 0 || to_line < 0 || t != p)
474 else /* one number means "match this line only" */
477 else /* default to 0-max */
487 case '\0': /* found EOL */
489 /* fall through to '/' */
490 case '/': /* found a definition separator */
493 case 4: /* within a log level */
496 level = get_type ((const char *) start);
497 if (level == GNUNET_ERROR_TYPE_INVALID ||
498 level == GNUNET_ERROR_TYPE_UNSPECIFIED ||
499 0 != add_definition (comp, file, function, from_line, to_line,
520 * Utility function - parses GNUNET_LOG and GNUNET_FORCE_LOG.
523 parse_all_definitions ()
525 if (gnunet_log_parsed == GNUNET_NO)
526 parse_definitions ("GNUNET_LOG", 0);
527 gnunet_log_parsed = GNUNET_YES;
528 if (gnunet_force_log_parsed == GNUNET_NO)
529 gnunet_force_log_present =
530 parse_definitions ("GNUNET_FORCE_LOG", 1) > 0 ? GNUNET_YES : GNUNET_NO;
531 gnunet_force_log_parsed = GNUNET_YES;
537 * @param comp default component to use
538 * @param loglevel what types of messages should be logged
539 * @param logfile which file to write log messages to (can be NULL)
540 * @return GNUNET_OK on success
543 GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile)
548 const char *env_logfile = NULL;
550 min_level = get_type (loglevel);
551 #if !defined(GNUNET_CULL_LOGGING)
552 parse_all_definitions ();
555 QueryPerformanceFrequency (&performance_frequency);
557 GNUNET_free_non_null (component);
558 GNUNET_asprintf (&component, "%s-%d", comp, getpid ());
559 GNUNET_free_non_null (component_nopid);
560 component_nopid = GNUNET_strdup (comp);
562 env_logfile = getenv ("GNUNET_FORCE_LOGFILE");
563 if ((env_logfile != NULL) && (strlen (env_logfile) > 0))
564 logfile = env_logfile;
568 fn = GNUNET_STRINGS_filename_expand (logfile);
570 return GNUNET_SYSERR;
571 dirwarn = (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn));
572 altlog = FOPEN (fn, "a");
575 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", fn);
577 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
578 _("Failed to create or access directory for log file `%s'\n"),
581 return GNUNET_SYSERR;
584 if (GNUNET_stderr != NULL)
585 fclose (GNUNET_stderr);
586 GNUNET_stderr = altlog;
591 * Add a custom logger.
593 * @param logger log function
594 * @param logger_cls closure for logger
597 GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls)
599 struct CustomLogger *entry;
601 entry = GNUNET_malloc (sizeof (struct CustomLogger));
602 entry->logger = logger;
603 entry->logger_cls = logger_cls;
604 entry->next = loggers;
609 * Remove a custom logger.
611 * @param logger log function
612 * @param logger_cls closure for logger
615 GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls)
617 struct CustomLogger *pos;
618 struct CustomLogger *prev;
622 while ((pos != NULL) &&
623 ((pos->logger != logger) || (pos->logger_cls != logger_cls)))
628 GNUNET_assert (pos != NULL);
632 prev->next = pos->next;
638 * Actually output the log message.
640 * @param kind how severe was the issue
641 * @param comp component responsible
642 * @param datestr current date/time
643 * @param msg the actual message
646 output_message (enum GNUNET_ErrorType kind, const char *comp,
647 const char *datestr, const char *msg)
649 struct CustomLogger *pos;
651 if (GNUNET_stderr != NULL)
653 fprintf (GNUNET_stderr, "%s %s %s %s", datestr, comp,
654 GNUNET_error_type_to_string (kind), msg);
655 fflush (GNUNET_stderr);
660 pos->logger (pos->logger_cls, kind, comp, datestr, msg);
667 * Flush an existing bulk report to the output.
669 * @param datestr our current timestamp
672 flush_bulk (const char *datestr)
674 char msg[DATE_STR_SIZE + BULK_TRACK_SIZE + 256];
679 if ((last_bulk_time.abs_value == 0) || (last_bulk_repeat == 0))
682 last = memchr (last_bulk, '\0', BULK_TRACK_SIZE);
684 last = &last_bulk[BULK_TRACK_SIZE - 1];
685 else if (last != last_bulk)
692 ft = GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration
694 snprintf (msg, sizeof (msg),
695 _("Message `%.*s' repeated %u times in the last %s\n"),
696 BULK_TRACK_SIZE, last_bulk, last_bulk_repeat, ft);
700 output_message (last_bulk_kind, last_bulk_comp, datestr, msg);
701 last_bulk_time = GNUNET_TIME_absolute_get ();
702 last_bulk_repeat = 0;
707 * Ignore the next n calls to the log function.
709 * @param n number of log calls to ignore
710 * @param check_reset GNUNET_YES to assert that the log skip counter is currently zero
713 GNUNET_log_skip (unsigned int n, int check_reset)
719 ok = (0 == skip_log);
730 * Output a log message using the default mechanism.
732 * @param kind how severe was the issue
733 * @param comp component responsible
734 * @param message the actual message
735 * @param va arguments to the format string "message"
738 mylog (enum GNUNET_ErrorType kind, const char *comp, const char *message,
741 char date[DATE_STR_SIZE];
742 char date2[DATE_STR_SIZE];
744 struct timeval timeofday;
750 size = VSNPRINTF (NULL, 0, message, vacp) + 1;
751 GNUNET_assert (0 != size);
756 VSNPRINTF (buf, size, message, va);
758 memset (date, 0, DATE_STR_SIZE);
759 tmptr = localtime (&timetmp);
760 gettimeofday (&timeofday, NULL);
767 QueryPerformanceCounter (&pc);
768 strftime (date2, DATE_STR_SIZE, "%b %d %H:%M:%S-%%020llu", tmptr);
769 snprintf (date, sizeof (date), date2,
770 (long long) (pc.QuadPart /
771 (performance_frequency.QuadPart / 1000)));
773 strftime (date2, DATE_STR_SIZE, "%b %d %H:%M:%S-%%06u", tmptr);
774 snprintf (date, sizeof (date), date2, timeofday.tv_usec);
778 strcpy (date, "localtime error");
779 if ((0 != (kind & GNUNET_ERROR_TYPE_BULK)) &&
780 (last_bulk_time.abs_value != 0) &&
781 (0 == strncmp (buf, last_bulk, sizeof (last_bulk))))
784 if ((GNUNET_TIME_absolute_get_duration (last_bulk_time).rel_value >
785 BULK_DELAY_THRESHOLD) || (last_bulk_repeat > BULK_REPEAT_THRESHOLD))
790 strncpy (last_bulk, buf, sizeof (last_bulk));
791 last_bulk_repeat = 0;
792 last_bulk_kind = kind;
793 last_bulk_time = GNUNET_TIME_absolute_get ();
794 strncpy (last_bulk_comp, comp, COMP_TRACK_SIZE);
795 output_message (kind, comp, date, buf);
803 * @param kind how serious is the error?
804 * @param message what is the message (format string)
805 * @param ... arguments for format string
808 GNUNET_log_nocheck (enum GNUNET_ErrorType kind, const char *message, ...)
812 va_start (va, message);
813 mylog (kind, component, message, va);
819 * Log function that specifies an alternative component.
820 * This function should be used by plugins.
822 * @param kind how serious is the error?
823 * @param comp component responsible for generating the message
824 * @param message what is the message (format string)
825 * @param ... arguments for format string
828 GNUNET_log_from_nocheck (enum GNUNET_ErrorType kind, const char *comp,
829 const char *message, ...)
832 char comp_w_pid[128];
835 comp = component_nopid;
837 va_start (va, message);
838 GNUNET_snprintf (comp_w_pid, sizeof (comp_w_pid), "%s-%d", comp, getpid ());
839 mylog (kind, comp_w_pid, message, va);
845 * Convert error type to string.
847 * @param kind type to convert
848 * @return string corresponding to the type
851 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind)
853 if ((kind & GNUNET_ERROR_TYPE_ERROR) > 0)
855 if ((kind & GNUNET_ERROR_TYPE_WARNING) > 0)
857 if ((kind & GNUNET_ERROR_TYPE_INFO) > 0)
859 if ((kind & GNUNET_ERROR_TYPE_DEBUG) > 0)
861 if ((kind & ~GNUNET_ERROR_TYPE_BULK) == 0)
868 * Convert a hash to a string (for printing debug messages).
869 * This is one of the very few calls in the entire API that is
872 * @param hc the hash code
873 * @return string form; will be overwritten by next call to GNUNET_h2s.
876 GNUNET_h2s (const GNUNET_HashCode * hc)
878 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
880 GNUNET_CRYPTO_hash_to_enc (hc, &ret);
881 ret.encoding[8] = '\0';
882 return (const char *) ret.encoding;
886 * Convert a hash to a string (for printing debug messages).
887 * This is one of the very few calls in the entire API that is
890 * @param hc the hash code
891 * @return string form; will be overwritten by next call to GNUNET_h2s_full.
894 GNUNET_h2s_full (const GNUNET_HashCode * hc)
896 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
898 GNUNET_CRYPTO_hash_to_enc (hc, &ret);
899 ret.encoding[sizeof (ret) - 1] = '\0';
900 return (const char *) ret.encoding;
904 * Convert a peer identity to a string (for printing debug messages).
905 * This is one of the very few calls in the entire API that is
908 * @param pid the peer identity
909 * @return string form of the pid; will be overwritten by next
910 * call to GNUNET_i2s.
913 GNUNET_i2s (const struct GNUNET_PeerIdentity *pid)
915 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
917 GNUNET_CRYPTO_hash_to_enc (&pid->hashPubKey, &ret);
918 ret.encoding[4] = '\0';
919 return (const char *) ret.encoding;
925 * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
926 * (for printing debug messages). This is one of the very few calls
927 * in the entire API that is NOT reentrant!
929 * @param addr the address
930 * @param addrlen the length of the address
931 * @return nicely formatted string for the address
932 * will be overwritten by next call to GNUNET_a2s.
935 GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen)
937 static char buf[INET6_ADDRSTRLEN + 8];
939 const struct sockaddr_in *v4;
940 const struct sockaddr_un *un;
941 const struct sockaddr_in6 *v6;
945 return _("unknown address");
946 switch (addr->sa_family)
949 if (addrlen != sizeof (struct sockaddr_in))
950 return "<invalid v4 address>";
951 v4 = (const struct sockaddr_in *) addr;
952 inet_ntop (AF_INET, &v4->sin_addr, buf, INET_ADDRSTRLEN);
953 if (0 == ntohs (v4->sin_port))
956 GNUNET_snprintf (b2, sizeof (b2), "%u", ntohs (v4->sin_port));
960 if (addrlen != sizeof (struct sockaddr_in6))
961 return "<invalid v4 address>";
962 v6 = (const struct sockaddr_in6 *) addr;
964 inet_ntop (AF_INET6, &v6->sin6_addr, &buf[1], INET6_ADDRSTRLEN);
965 if (0 == ntohs (v6->sin6_port))
968 GNUNET_snprintf (b2, sizeof (b2), "%u", ntohs (v6->sin6_port));
972 if (addrlen <= sizeof (sa_family_t))
973 return "<unbound UNIX client>";
974 un = (const struct sockaddr_un *) addr;
976 if (un->sun_path[0] == '\0')
978 snprintf (buf, sizeof (buf), "%s%.*s", (off == 1) ? "@" : "",
979 (int) (addrlen - sizeof (sa_family_t) - 1 - off),
983 return _("invalid address");
991 void __attribute__ ((constructor)) GNUNET_util_cl_init ()
993 GNUNET_stderr = stderr;
1003 void __attribute__ ((destructor)) GNUNET_util_cl_fini ()
1006 GNShutdownWinEnv ();
1010 /* end of common_logging.c */