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"
34 * After how many milliseconds do we always print
35 * that "message X was repeated N times"? Use 12h.
37 #define BULK_DELAY_THRESHOLD (12 * 60 * 60 * 1000)
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)
44 #define BULK_REPEAT_THRESHOLD 1000
47 * How many characters do we use for matching of
50 #define BULK_TRACK_SIZE 256
53 * How many characters do we use for matching of
56 #define COMP_TRACK_SIZE 32
59 * How many characters can a date/time string
62 #define DATE_STR_SIZE 64
65 * Linked list of active loggers.
70 * This is a linked list.
72 struct CustomLogger *next;
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!
90 static char last_bulk[BULK_TRACK_SIZE];
93 * Type of the last bulk message.
95 static enum GNUNET_ErrorType last_bulk_kind;
98 * Time of the last bulk error message (0 for none)
100 static struct GNUNET_TIME_Absolute last_bulk_time;
103 * Number of times that bulk message has been repeated since.
105 static unsigned int last_bulk_repeat;
108 * Component when the last bulk was logged. Will be 0-terminated.
110 static char last_bulk_comp[COMP_TRACK_SIZE + 1];
115 static char *component;
120 static enum GNUNET_ErrorType min_level;
123 * Linked list of our custom loggres.
125 static struct CustomLogger *loggers;
128 * Number of log calls to ignore.
130 static unsigned int skip_log;
133 * File descriptor to use for "stderr", or NULL for none.
135 static FILE *GNUNET_stderr;
139 * Contains the number of performance counts per second.
141 LARGE_INTEGER performance_frequency;
145 * Convert a textual description of a loglevel
146 * to the respective GNUNET_GE_KIND.
148 * @param log loglevel to parse
149 * @return GNUNET_GE_INVALID if log does not parse
151 static enum GNUNET_ErrorType
152 get_type (const char *log)
154 if (0 == strcasecmp (log, _("DEBUG")))
155 return GNUNET_ERROR_TYPE_DEBUG;
156 if (0 == strcasecmp (log, _("INFO")))
157 return GNUNET_ERROR_TYPE_INFO;
158 if (0 == strcasecmp (log, _("WARNING")))
159 return GNUNET_ERROR_TYPE_WARNING;
160 if (0 == strcasecmp (log, _("ERROR")))
161 return GNUNET_ERROR_TYPE_ERROR;
162 if (0 == strcasecmp (log, _("NONE")))
163 return GNUNET_ERROR_TYPE_NONE;
164 return GNUNET_ERROR_TYPE_INVALID;
171 * @param comp default component to use
172 * @param loglevel what types of messages should be logged
173 * @param logfile which file to write log messages to (can be NULL)
174 * @return GNUNET_OK on success
177 GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile)
182 const char *env_loglevel;
183 int env_minlevel = 0;
184 int env_min_force_level = 100000;
187 QueryPerformanceFrequency (&performance_frequency);
189 GNUNET_free_non_null (component);
190 GNUNET_asprintf (&component, "%s-%d", comp, getpid ());
191 env_loglevel = getenv ("GNUNET_LOGLEVEL");
192 if (env_loglevel != NULL)
193 env_minlevel = get_type (env_loglevel);
194 env_loglevel = getenv ("GNUNET_FORCE_LOGLEVEL");
195 if (env_loglevel != NULL)
196 env_min_force_level = get_type (env_loglevel);
197 min_level = get_type (loglevel);
198 if (env_minlevel > min_level)
199 min_level = env_minlevel;
200 if (env_min_force_level < min_level)
201 min_level = env_min_force_level;
204 fn = GNUNET_STRINGS_filename_expand (logfile);
206 return GNUNET_SYSERR;
207 dirwarn = (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn));
208 altlog = FOPEN (fn, "a");
211 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", fn);
213 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
214 _("Failed to create or access directory for log file `%s'\n"),
217 return GNUNET_SYSERR;
220 if (GNUNET_stderr != NULL)
221 fclose (GNUNET_stderr);
222 GNUNET_stderr = altlog;
227 * Add a custom logger.
229 * @param logger log function
230 * @param logger_cls closure for logger
233 GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls)
235 struct CustomLogger *entry;
237 entry = GNUNET_malloc (sizeof (struct CustomLogger));
238 entry->logger = logger;
239 entry->logger_cls = logger_cls;
240 entry->next = loggers;
245 * Remove a custom logger.
247 * @param logger log function
248 * @param logger_cls closure for logger
251 GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls)
253 struct CustomLogger *pos;
254 struct CustomLogger *prev;
258 while ((pos != NULL) &&
259 ((pos->logger != logger) || (pos->logger_cls != logger_cls)))
264 GNUNET_assert (pos != NULL);
268 prev->next = pos->next;
274 * Actually output the log message.
276 * @param kind how severe was the issue
277 * @param comp component responsible
278 * @param datestr current date/time
279 * @param msg the actual message
282 output_message (enum GNUNET_ErrorType kind, const char *comp,
283 const char *datestr, const char *msg)
285 struct CustomLogger *pos;
287 if (GNUNET_stderr != NULL)
289 fprintf (GNUNET_stderr, "%s %s %s %s", datestr, comp,
290 GNUNET_error_type_to_string (kind), msg);
291 fflush (GNUNET_stderr);
296 pos->logger (pos->logger_cls, kind, comp, datestr, msg);
303 * Flush an existing bulk report to the output.
305 * @param datestr our current timestamp
308 flush_bulk (const char *datestr)
310 char msg[DATE_STR_SIZE + BULK_TRACK_SIZE + 256];
315 if ((last_bulk_time.abs_value == 0) || (last_bulk_repeat == 0))
318 last = memchr (last_bulk, '\0', BULK_TRACK_SIZE);
320 last = &last_bulk[BULK_TRACK_SIZE - 1];
321 else if (last != last_bulk)
328 ft = GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration
330 snprintf (msg, sizeof (msg),
331 _("Message `%.*s' repeated %u times in the last %s\n"),
332 BULK_TRACK_SIZE, last_bulk, last_bulk_repeat, ft);
336 output_message (last_bulk_kind, last_bulk_comp, datestr, msg);
337 last_bulk_time = GNUNET_TIME_absolute_get ();
338 last_bulk_repeat = 0;
343 * Ignore the next n calls to the log function.
345 * @param n number of log calls to ignore
346 * @param check_reset GNUNET_YES to assert that the log skip counter is currently zero
349 GNUNET_log_skip (unsigned int n, int check_reset)
355 ok = (0 == skip_log);
366 * Output a log message using the default mechanism.
368 * @param kind how severe was the issue
369 * @param comp component responsible
370 * @param message the actual message
371 * @param va arguments to the format string "message"
374 mylog (enum GNUNET_ErrorType kind, const char *comp, const char *message,
377 char date[DATE_STR_SIZE];
378 char date2[DATE_STR_SIZE];
380 struct timeval timeofday;
391 if ((kind & (~GNUNET_ERROR_TYPE_BULK)) > min_level)
394 size = VSNPRINTF (NULL, 0, message, vacp) + 1;
399 VSNPRINTF (buf, size, message, va);
401 memset (date, 0, DATE_STR_SIZE);
402 tmptr = localtime (&timetmp);
403 gettimeofday (&timeofday, NULL);
410 QueryPerformanceCounter (&pc);
411 strftime (date2, DATE_STR_SIZE, "%b %d %H:%M:%S-%%020llu", tmptr);
412 snprintf (date, sizeof (date), date2,
413 (long long) (pc.QuadPart /
414 (performance_frequency.QuadPart / 1000)));
416 strftime (date2, DATE_STR_SIZE, "%b %d %H:%M:%S-%%06u", tmptr);
417 snprintf (date, sizeof (date), date2, timeofday.tv_usec);
421 strcpy (date, "localtime error");
422 if ((0 != (kind & GNUNET_ERROR_TYPE_BULK)) && (last_bulk_time.abs_value != 0)
423 && (0 == strncmp (buf, last_bulk, sizeof (last_bulk))))
426 if ((GNUNET_TIME_absolute_get_duration (last_bulk_time).rel_value >
427 BULK_DELAY_THRESHOLD) || (last_bulk_repeat > BULK_REPEAT_THRESHOLD))
433 strncpy (last_bulk, buf, sizeof (last_bulk));
434 last_bulk_repeat = 0;
435 last_bulk_kind = kind;
436 last_bulk_time = GNUNET_TIME_absolute_get ();
437 strncpy (last_bulk_comp, comp, COMP_TRACK_SIZE);
438 output_message (kind, comp, date, buf);
446 * @param kind how serious is the error?
447 * @param message what is the message (format string)
448 * @param ... arguments for format string
451 GNUNET_log (enum GNUNET_ErrorType kind, const char *message, ...)
455 va_start (va, message);
456 mylog (kind, component, message, va);
462 * Log function that specifies an alternative component.
463 * This function should be used by plugins.
465 * @param kind how serious is the error?
466 * @param comp component responsible for generating the message
467 * @param message what is the message (format string)
468 * @param ... arguments for format string
471 GNUNET_log_from (enum GNUNET_ErrorType kind, const char *comp,
472 const char *message, ...)
475 char comp_w_pid[128];
477 va_start (va, message);
478 GNUNET_snprintf (comp_w_pid, sizeof (comp_w_pid), "%s-%d", comp, getpid ());
479 mylog (kind, comp_w_pid, message, va);
485 * Convert error type to string.
487 * @param kind type to convert
488 * @return string corresponding to the type
491 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind)
493 if ((kind & GNUNET_ERROR_TYPE_ERROR) > 0)
495 if ((kind & GNUNET_ERROR_TYPE_WARNING) > 0)
497 if ((kind & GNUNET_ERROR_TYPE_INFO) > 0)
499 if ((kind & GNUNET_ERROR_TYPE_DEBUG) > 0)
506 * Convert a hash to a string (for printing debug messages).
507 * This is one of the very few calls in the entire API that is
510 * @param hc the hash code
511 * @return string form; will be overwritten by next call to GNUNET_h2s.
514 GNUNET_h2s (const GNUNET_HashCode * hc)
516 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
518 GNUNET_CRYPTO_hash_to_enc (hc, &ret);
519 ret.encoding[8] = '\0';
520 return (const char *) ret.encoding;
524 * Convert a hash to a string (for printing debug messages).
525 * This is one of the very few calls in the entire API that is
528 * @param hc the hash code
529 * @return string form; will be overwritten by next call to GNUNET_h2s_full.
532 GNUNET_h2s_full (const GNUNET_HashCode * hc)
534 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
536 GNUNET_CRYPTO_hash_to_enc (hc, &ret);
537 ret.encoding[sizeof (ret) - 1] = '\0';
538 return (const char *) ret.encoding;
542 * Convert a peer identity to a string (for printing debug messages).
543 * This is one of the very few calls in the entire API that is
546 * @param pid the peer identity
547 * @return string form of the pid; will be overwritten by next
548 * call to GNUNET_i2s.
551 GNUNET_i2s (const struct GNUNET_PeerIdentity *pid)
553 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
555 GNUNET_CRYPTO_hash_to_enc (&pid->hashPubKey, &ret);
556 ret.encoding[4] = '\0';
557 return (const char *) ret.encoding;
563 * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
564 * (for printing debug messages). This is one of the very few calls
565 * in the entire API that is NOT reentrant!
567 * @param addr the address
568 * @param addrlen the length of the address
569 * @return nicely formatted string for the address
570 * will be overwritten by next call to GNUNET_a2s.
573 GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen)
575 static char buf[INET6_ADDRSTRLEN + 8];
577 const struct sockaddr_in *v4;
578 const struct sockaddr_un *un;
579 const struct sockaddr_in6 *v6;
583 return _("unknown address");
584 switch (addr->sa_family)
587 if (addrlen != sizeof (struct sockaddr_in))
588 return "<invalid v4 address>";
589 v4 = (const struct sockaddr_in *) addr;
590 inet_ntop (AF_INET, &v4->sin_addr, buf, INET_ADDRSTRLEN);
591 if (0 == ntohs (v4->sin_port))
594 GNUNET_snprintf (b2, sizeof (b2), "%u", ntohs (v4->sin_port));
598 if (addrlen != sizeof (struct sockaddr_in6))
599 return "<invalid v4 address>";
600 v6 = (const struct sockaddr_in6 *) addr;
602 inet_ntop (AF_INET6, &v6->sin6_addr, &buf[1], INET6_ADDRSTRLEN);
603 if (0 == ntohs (v6->sin6_port))
606 GNUNET_snprintf (b2, sizeof (b2), "%u", ntohs (v6->sin6_port));
610 if (addrlen <= sizeof (sa_family_t))
611 return "<unbound UNIX client>";
612 un = (const struct sockaddr_un *) addr;
614 if (un->sun_path[0] == '\0')
616 snprintf (buf, sizeof (buf), "%s%.*s", (off == 1) ? "@" : "",
617 (int) (addrlen - sizeof (sa_family_t) - 1 - off),
621 return _("invalid address");
629 void __attribute__ ((constructor)) GNUNET_util_cl_init ()
631 GNUNET_stderr = stderr;
641 void __attribute__ ((destructor)) GNUNET_util_cl_fini ()
648 /* end of common_logging.c */