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 can a date/time string
56 #define DATE_STR_SIZE 64
59 * Linked list of active loggers.
64 * This is a linked list.
66 struct CustomLogger *next;
80 * The last "bulk" error message that we have been logging.
81 * Note that this message maybe truncated to the first BULK_TRACK_SIZE
82 * characters, in which case it is NOT 0-terminated!
84 static char last_bulk[BULK_TRACK_SIZE];
87 * Type of the last bulk message.
89 static enum GNUNET_ErrorType last_bulk_kind;
92 * Time of the last bulk error message (0 for none)
94 static struct GNUNET_TIME_Absolute last_bulk_time;
97 * Number of times that bulk message has been repeated since.
99 static unsigned int last_bulk_repeat;
102 * Component when the last bulk was logged.
104 static const char *last_bulk_comp;
109 static char *component;
114 static enum GNUNET_ErrorType min_level;
117 * Linked list of our custom loggres.
119 static struct CustomLogger *loggers;
122 * Number of log calls to ignore.
124 static unsigned int skip_log;
127 * File descriptor to use for "stderr", or NULL for none.
129 static FILE *GNUNET_stderr;
132 * Convert a textual description of a loglevel
133 * to the respective GNUNET_GE_KIND.
135 * @param log loglevel to parse
136 * @return GNUNET_GE_INVALID if log does not parse
138 static enum GNUNET_ErrorType
139 get_type (const char *log)
141 if (0 == strcasecmp (log, _("DEBUG")))
142 return GNUNET_ERROR_TYPE_DEBUG;
143 if (0 == strcasecmp (log, _("INFO")))
144 return GNUNET_ERROR_TYPE_INFO;
145 if (0 == strcasecmp (log, _("WARNING")))
146 return GNUNET_ERROR_TYPE_WARNING;
147 if (0 == strcasecmp (log, _("ERROR")))
148 return GNUNET_ERROR_TYPE_ERROR;
149 return GNUNET_ERROR_TYPE_INVALID;
156 * @param comp default component to use
157 * @param loglevel what types of messages should be logged
158 * @param logfile which file to write log messages to (can be NULL)
159 * @return GNUNET_OK on success
162 GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile)
166 GNUNET_free_non_null (component);
167 GNUNET_asprintf (&component,
171 min_level = get_type (loglevel);
175 GNUNET_DISK_directory_create_for_file (logfile))
176 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
177 _("Failed to create or access directory for log file `%s'"),
179 altlog = FOPEN (logfile, "a");
182 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", logfile);
183 return GNUNET_SYSERR;
185 if (GNUNET_stderr != NULL)
186 fclose (GNUNET_stderr);
187 GNUNET_stderr = altlog;
192 * Add a custom logger.
194 * @param logger log function
195 * @param logger_cls closure for logger
198 GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls)
200 struct CustomLogger *entry;
202 entry = GNUNET_malloc (sizeof (struct CustomLogger));
203 entry->logger = logger;
204 entry->logger_cls = logger_cls;
205 entry->next = loggers;
210 * Remove a custom logger.
212 * @param logger log function
213 * @param logger_cls closure for logger
216 GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls)
218 struct CustomLogger *pos;
219 struct CustomLogger *prev;
223 while ((pos != NULL) &&
224 ((pos->logger != logger) || (pos->logger_cls != logger_cls)))
229 GNUNET_assert (pos != NULL);
233 prev->next = pos->next;
239 * Actually output the log message.
241 * @param kind how severe was the issue
242 * @param comp component responsible
243 * @param datestr current date/time
244 * @param msg the actual message
247 output_message (enum GNUNET_ErrorType kind,
248 const char *comp, const char *datestr, const char *msg)
250 struct CustomLogger *pos;
251 if (GNUNET_stderr != NULL)
252 fprintf (GNUNET_stderr, "%s %s %s %s", datestr, comp,
253 GNUNET_error_type_to_string (kind), msg);
257 pos->logger (pos->logger_cls, kind, comp, datestr, msg);
264 * Flush an existing bulk report to the output.
266 * @param datestr our current timestamp
269 flush_bulk (const char *datestr)
271 char msg[DATE_STR_SIZE + BULK_TRACK_SIZE + 256];
276 if ((last_bulk_time.value == 0) || (last_bulk_repeat == 0))
279 last = memchr (last_bulk, '\0', BULK_TRACK_SIZE);
281 last = &last_bulk[BULK_TRACK_SIZE - 1];
282 else if (last != last_bulk)
290 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration
292 snprintf (msg, sizeof (msg),
293 _("Message `%.*s' repeated %u times in the last %s\n"),
294 BULK_TRACK_SIZE, last_bulk, last_bulk_repeat, ft);
298 output_message (last_bulk_kind, last_bulk_comp, datestr, msg);
299 last_bulk_time = GNUNET_TIME_absolute_get ();
300 last_bulk_repeat = 0;
305 * Ignore the next n calls to the log function.
307 * @param n number of log calls to ignore
308 * @param check_reset GNUNET_YES to assert that the log skip counter is currently zero
311 GNUNET_log_skip (unsigned int n, int check_reset)
317 ok = (0 == skip_log);
328 * Output a log message using the default mechanism.
330 * @param kind how severe was the issue
331 * @param comp component responsible
332 * @param message the actual message
333 * @param va arguments to the format string "message"
336 mylog (enum GNUNET_ErrorType kind,
337 const char *comp, const char *message, va_list va)
339 char date[DATE_STR_SIZE];
351 if ((kind & (~GNUNET_ERROR_TYPE_BULK)) > min_level)
354 size = VSNPRINTF (NULL, 0, message, vacp) + 1;
359 VSNPRINTF (buf, size, message, va);
361 memset (date, 0, DATE_STR_SIZE);
362 tmptr = localtime (&timetmp);
363 strftime (date, DATE_STR_SIZE, "%b %d %H:%M:%S", tmptr);
364 if ((0 != (kind & GNUNET_ERROR_TYPE_BULK)) &&
365 (last_bulk_time.value != 0) &&
366 (0 == strncmp (buf, last_bulk, sizeof (last_bulk))))
369 if ((GNUNET_TIME_absolute_get_duration (last_bulk_time).value >
370 BULK_DELAY_THRESHOLD)
371 || (last_bulk_repeat > BULK_REPEAT_THRESHOLD))
377 strncpy (last_bulk, buf, sizeof (last_bulk));
378 last_bulk_repeat = 0;
379 last_bulk_kind = kind;
380 last_bulk_time = GNUNET_TIME_absolute_get ();
381 last_bulk_comp = comp;
382 output_message (kind, comp, date, buf);
390 * @param kind how serious is the error?
391 * @param message what is the message (format string)
392 * @param ... arguments for format string
395 GNUNET_log (enum GNUNET_ErrorType kind, const char *message, ...)
398 va_start (va, message);
399 mylog (kind, component, message, va);
405 * Log function that specifies an alternative component.
406 * This function should be used by plugins.
408 * @param kind how serious is the error?
409 * @param comp component responsible for generating the message
410 * @param message what is the message (format string)
411 * @param ... arguments for format string
414 GNUNET_log_from (enum GNUNET_ErrorType kind,
415 const char *comp, const char *message, ...)
418 va_start (va, message);
419 mylog (kind, comp, message, va);
425 * Convert error type to string.
427 * @param kind type to convert
428 * @return string corresponding to the type
431 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind)
433 if ((kind & GNUNET_ERROR_TYPE_ERROR) > 0)
435 if ((kind & GNUNET_ERROR_TYPE_WARNING) > 0)
437 if ((kind & GNUNET_ERROR_TYPE_INFO) > 0)
439 if ((kind & GNUNET_ERROR_TYPE_DEBUG) > 0)
446 * Convert a hash to a string (for printing debug messages).
447 * This is one of the very few calls in the entire API that is
450 * @param hc the hash code
451 * @return string form; will be overwritten by next call to GNUNET_h2s.
454 GNUNET_h2s (const GNUNET_HashCode * hc)
456 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
457 GNUNET_CRYPTO_hash_to_enc (hc, &ret);
458 ret.encoding[8] = '\0';
459 return (const char *) ret.encoding;
464 * Convert a peer identity to a string (for printing debug messages).
465 * This is one of the very few calls in the entire API that is
468 * @param pid the peer identity
469 * @return string form of the pid; will be overwritten by next
470 * call to GNUNET_i2s.
473 GNUNET_i2s (const struct GNUNET_PeerIdentity *pid)
475 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
476 GNUNET_CRYPTO_hash_to_enc (&pid->hashPubKey, &ret);
477 ret.encoding[4] = '\0';
478 return (const char *) ret.encoding;
484 * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
485 * (for printing debug messages). This is one of the very few calls
486 * in the entire API that is NOT reentrant!
488 * @param addr the address
489 * @param addrlen the length of the address
490 * @return nicely formatted string for the address
491 * will be overwritten by next call to GNUNET_a2s.
494 GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen)
496 static char buf[INET6_ADDRSTRLEN + 8];
498 const struct sockaddr_in *v4;
499 const struct sockaddr_in6 *v6;
502 return _("unknown address");
503 switch (addr->sa_family)
506 v4 = (const struct sockaddr_in *) addr;
507 inet_ntop (AF_INET, &v4->sin_addr, buf, INET_ADDRSTRLEN);
508 if (0 == ntohs (v4->sin_port))
511 sprintf (b2, "%u", ntohs (v4->sin_port));
515 v6 = (const struct sockaddr_in6 *) addr;
517 inet_ntop (AF_INET6, &v6->sin6_addr, &buf[1], INET6_ADDRSTRLEN);
518 if (0 == ntohs (v6->sin6_port))
521 sprintf (b2, "%u", ntohs (v6->sin6_port));
525 return _("invalid address");
533 void __attribute__ ((constructor)) GNUNET_util_cl_init ()
535 GNUNET_stderr = stderr;
538 /* end of common_logging.c */