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 seconds 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;
138 * Convert a textual description of a loglevel
139 * to the respective GNUNET_GE_KIND.
141 * @param log loglevel to parse
142 * @return GNUNET_GE_INVALID if log does not parse
144 static enum GNUNET_ErrorType
145 get_type (const char *log)
147 if (0 == strcasecmp (log, _("DEBUG")))
148 return GNUNET_ERROR_TYPE_DEBUG;
149 if (0 == strcasecmp (log, _("INFO")))
150 return GNUNET_ERROR_TYPE_INFO;
151 if (0 == strcasecmp (log, _("WARNING")))
152 return GNUNET_ERROR_TYPE_WARNING;
153 if (0 == strcasecmp (log, _("ERROR")))
154 return GNUNET_ERROR_TYPE_ERROR;
155 return GNUNET_ERROR_TYPE_INVALID;
162 * @param comp default component to use
163 * @param loglevel what types of messages should be logged
164 * @param logfile which file to write log messages to (can be NULL)
165 * @return GNUNET_OK on success
168 GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile)
174 GNUNET_free_non_null (component);
175 GNUNET_asprintf (&component,
179 min_level = get_type (loglevel);
182 fn = GNUNET_STRINGS_filename_expand (logfile);
184 return GNUNET_SYSERR;
185 dirwarn = (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn));
186 altlog = FOPEN (fn, "a");
189 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", fn);
191 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
192 _("Failed to create or access directory for log file `%s'\n"),
195 return GNUNET_SYSERR;
198 if (GNUNET_stderr != NULL)
199 fclose (GNUNET_stderr);
200 GNUNET_stderr = altlog;
205 * Add a custom logger.
207 * @param logger log function
208 * @param logger_cls closure for logger
211 GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls)
213 struct CustomLogger *entry;
215 entry = GNUNET_malloc (sizeof (struct CustomLogger));
216 entry->logger = logger;
217 entry->logger_cls = logger_cls;
218 entry->next = loggers;
223 * Remove a custom logger.
225 * @param logger log function
226 * @param logger_cls closure for logger
229 GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls)
231 struct CustomLogger *pos;
232 struct CustomLogger *prev;
236 while ((pos != NULL) &&
237 ((pos->logger != logger) || (pos->logger_cls != logger_cls)))
242 GNUNET_assert (pos != NULL);
246 prev->next = pos->next;
252 * Actually output the log message.
254 * @param kind how severe was the issue
255 * @param comp component responsible
256 * @param datestr current date/time
257 * @param msg the actual message
260 output_message (enum GNUNET_ErrorType kind,
261 const char *comp, const char *datestr, const char *msg)
263 struct CustomLogger *pos;
264 if (GNUNET_stderr != NULL)
266 fprintf (GNUNET_stderr, "%s %s %s %s", datestr, comp,
267 GNUNET_error_type_to_string (kind), msg);
268 fflush (GNUNET_stderr);
273 pos->logger (pos->logger_cls, kind, comp, datestr, msg);
280 * Flush an existing bulk report to the output.
282 * @param datestr our current timestamp
285 flush_bulk (const char *datestr)
287 char msg[DATE_STR_SIZE + BULK_TRACK_SIZE + 256];
292 if ((last_bulk_time.value == 0) || (last_bulk_repeat == 0))
295 last = memchr (last_bulk, '\0', BULK_TRACK_SIZE);
297 last = &last_bulk[BULK_TRACK_SIZE - 1];
298 else if (last != last_bulk)
306 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration
308 snprintf (msg, sizeof (msg),
309 _("Message `%.*s' repeated %u times in the last %s\n"),
310 BULK_TRACK_SIZE, last_bulk, last_bulk_repeat, ft);
314 output_message (last_bulk_kind, last_bulk_comp, datestr, msg);
315 last_bulk_time = GNUNET_TIME_absolute_get ();
316 last_bulk_repeat = 0;
321 * Ignore the next n calls to the log function.
323 * @param n number of log calls to ignore
324 * @param check_reset GNUNET_YES to assert that the log skip counter is currently zero
327 GNUNET_log_skip (unsigned int n, int check_reset)
333 ok = (0 == skip_log);
344 * Output a log message using the default mechanism.
346 * @param kind how severe was the issue
347 * @param comp component responsible
348 * @param message the actual message
349 * @param va arguments to the format string "message"
352 mylog (enum GNUNET_ErrorType kind,
353 const char *comp, const char *message, va_list va)
355 char date[DATE_STR_SIZE];
367 if ((kind & (~GNUNET_ERROR_TYPE_BULK)) > min_level)
370 size = VSNPRINTF (NULL, 0, message, vacp) + 1;
375 VSNPRINTF (buf, size, message, va);
377 memset (date, 0, DATE_STR_SIZE);
378 tmptr = localtime (&timetmp);
380 strftime (date, DATE_STR_SIZE, "%b %d %H:%M:%S", tmptr);
382 strcpy (date, "localtime error");
383 if ((0 != (kind & GNUNET_ERROR_TYPE_BULK)) &&
384 (last_bulk_time.value != 0) &&
385 (0 == strncmp (buf, last_bulk, sizeof (last_bulk))))
388 if ((GNUNET_TIME_absolute_get_duration (last_bulk_time).value >
389 BULK_DELAY_THRESHOLD)
390 || (last_bulk_repeat > BULK_REPEAT_THRESHOLD))
396 strncpy (last_bulk, buf, sizeof (last_bulk));
397 last_bulk_repeat = 0;
398 last_bulk_kind = kind;
399 last_bulk_time = GNUNET_TIME_absolute_get ();
400 strncpy (last_bulk_comp, comp, COMP_TRACK_SIZE);
401 output_message (kind, comp, date, buf);
409 * @param kind how serious is the error?
410 * @param message what is the message (format string)
411 * @param ... arguments for format string
414 GNUNET_log (enum GNUNET_ErrorType kind, const char *message, ...)
417 va_start (va, message);
418 mylog (kind, component, message, va);
424 * Log function that specifies an alternative component.
425 * This function should be used by plugins.
427 * @param kind how serious is the error?
428 * @param comp component responsible for generating the message
429 * @param message what is the message (format string)
430 * @param ... arguments for format string
433 GNUNET_log_from (enum GNUNET_ErrorType kind,
434 const char *comp, const char *message, ...)
437 va_start (va, message);
438 mylog (kind, comp, message, va);
444 * Convert error type to string.
446 * @param kind type to convert
447 * @return string corresponding to the type
450 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind)
452 if ((kind & GNUNET_ERROR_TYPE_ERROR) > 0)
454 if ((kind & GNUNET_ERROR_TYPE_WARNING) > 0)
456 if ((kind & GNUNET_ERROR_TYPE_INFO) > 0)
458 if ((kind & GNUNET_ERROR_TYPE_DEBUG) > 0)
465 * Convert a hash to a string (for printing debug messages).
466 * This is one of the very few calls in the entire API that is
469 * @param hc the hash code
470 * @return string form; will be overwritten by next call to GNUNET_h2s.
473 GNUNET_h2s (const GNUNET_HashCode * hc)
475 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
477 GNUNET_CRYPTO_hash_to_enc (hc, &ret);
478 ret.encoding[8] = '\0';
479 return (const char *) ret.encoding;
483 * Convert a hash to a string (for printing debug messages).
484 * This is one of the very few calls in the entire API that is
487 * @param hc the hash code
488 * @return string form; will be overwritten by next call to GNUNET_h2s_full.
491 GNUNET_h2s_full (const GNUNET_HashCode * hc)
493 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
495 GNUNET_CRYPTO_hash_to_enc (hc, &ret);
496 ret.encoding[sizeof(ret)-1] = '\0';
497 return (const char *) ret.encoding;
501 * Convert a peer identity to a string (for printing debug messages).
502 * This is one of the very few calls in the entire API that is
505 * @param pid the peer identity
506 * @return string form of the pid; will be overwritten by next
507 * call to GNUNET_i2s.
510 GNUNET_i2s (const struct GNUNET_PeerIdentity *pid)
512 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
514 GNUNET_CRYPTO_hash_to_enc (&pid->hashPubKey, &ret);
515 ret.encoding[4] = '\0';
516 return (const char *) ret.encoding;
522 * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
523 * (for printing debug messages). This is one of the very few calls
524 * in the entire API that is NOT reentrant!
526 * @param addr the address
527 * @param addrlen the length of the address
528 * @return nicely formatted string for the address
529 * will be overwritten by next call to GNUNET_a2s.
532 GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen)
534 static char buf[INET6_ADDRSTRLEN + 8];
536 const struct sockaddr_in *v4;
537 const struct sockaddr_un *un;
538 const struct sockaddr_in6 *v6;
542 return _("unknown address");
543 switch (addr->sa_family)
546 if (addrlen != sizeof (struct sockaddr_in))
547 return "<invalid v4 address>";
548 v4 = (const struct sockaddr_in *) addr;
549 inet_ntop (AF_INET, &v4->sin_addr, buf, INET_ADDRSTRLEN);
550 if (0 == ntohs (v4->sin_port))
553 GNUNET_snprintf (b2, sizeof(b2), "%u", ntohs (v4->sin_port));
557 if (addrlen != sizeof (struct sockaddr_in6))
558 return "<invalid v4 address>";
559 v6 = (const struct sockaddr_in6 *) addr;
561 inet_ntop (AF_INET6, &v6->sin6_addr, &buf[1], INET6_ADDRSTRLEN);
562 if (0 == ntohs (v6->sin6_port))
565 GNUNET_snprintf (b2, sizeof(b2), "%u", ntohs (v6->sin6_port));
569 if (addrlen <= sizeof (sa_family_t))
570 return "<unbound UNIX client>";
571 un = (const struct sockaddr_un*) addr;
573 if (un->sun_path[0] == '\0') off++;
577 (off == 1) ? "@" : "",
578 (int) (addrlen - sizeof (sa_family_t) - 1 - off),
582 return _("invalid address");
590 void __attribute__ ((constructor)) GNUNET_util_cl_init ()
592 GNUNET_stderr = stderr;
602 void __attribute__ ((destructor)) GNUNET_util_cl_fini ()
609 /* end of common_logging.c */