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);
174 altlog = FOPEN (logfile, "a");
177 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", logfile);
178 return GNUNET_SYSERR;
180 if (GNUNET_stderr != NULL)
181 fclose (GNUNET_stderr);
182 GNUNET_stderr = altlog;
187 * Add a custom logger.
189 * @param logger log function
190 * @param logger_cls closure for logger
193 GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls)
195 struct CustomLogger *entry;
197 entry = GNUNET_malloc (sizeof (struct CustomLogger));
198 entry->logger = logger;
199 entry->logger_cls = logger_cls;
200 entry->next = loggers;
205 * Remove a custom logger.
207 * @param logger log function
208 * @param logger_cls closure for logger
211 GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls)
213 struct CustomLogger *pos;
214 struct CustomLogger *prev;
218 while ((pos != NULL) &&
219 ((pos->logger != logger) || (pos->logger_cls != logger_cls)))
224 GNUNET_assert (pos != NULL);
228 prev->next = pos->next;
234 * Actually output the log message.
236 * @param kind how severe was the issue
237 * @param comp component responsible
238 * @param datestr current date/time
239 * @param msg the actual message
242 output_message (enum GNUNET_ErrorType kind,
243 const char *comp, const char *datestr, const char *msg)
245 struct CustomLogger *pos;
246 if (GNUNET_stderr != NULL)
247 fprintf (GNUNET_stderr, "%s %s %s %s", datestr, comp,
248 GNUNET_error_type_to_string (kind), msg);
252 pos->logger (pos->logger_cls, kind, comp, datestr, msg);
259 * Flush an existing bulk report to the output.
261 * @param datestr our current timestamp
264 flush_bulk (const char *datestr)
266 char msg[DATE_STR_SIZE + BULK_TRACK_SIZE + 256];
271 if ((last_bulk_time.value == 0) || (last_bulk_repeat == 0))
274 last = memchr (last_bulk, '\0', BULK_TRACK_SIZE);
276 last = &last_bulk[BULK_TRACK_SIZE - 1];
277 else if (last != last_bulk)
285 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration
287 snprintf (msg, sizeof (msg),
288 _("Message `%.*s' repeated %u times in the last %s\n"),
289 BULK_TRACK_SIZE, last_bulk, last_bulk_repeat, ft);
293 output_message (last_bulk_kind, last_bulk_comp, datestr, msg);
294 last_bulk_time = GNUNET_TIME_absolute_get ();
295 last_bulk_repeat = 0;
300 * Ignore the next n calls to the log function.
302 * @param n number of log calls to ignore
303 * @param check_reset GNUNET_YES to assert that the log skip counter is currently zero
306 GNUNET_log_skip (unsigned int n, int check_reset)
312 ok = (0 == skip_log);
323 * Output a log message using the default mechanism.
325 * @param kind how severe was the issue
326 * @param comp component responsible
327 * @param message the actual message
328 * @param va arguments to the format string "message"
331 mylog (enum GNUNET_ErrorType kind,
332 const char *comp, const char *message, va_list va)
334 char date[DATE_STR_SIZE];
346 if ((kind & (~GNUNET_ERROR_TYPE_BULK)) > min_level)
349 size = VSNPRINTF (NULL, 0, message, vacp) + 1;
354 VSNPRINTF (buf, size, message, va);
356 memset (date, 0, DATE_STR_SIZE);
357 tmptr = localtime (&timetmp);
358 strftime (date, DATE_STR_SIZE, "%b %d %H:%M:%S", tmptr);
359 if ((0 != (kind & GNUNET_ERROR_TYPE_BULK)) &&
360 (last_bulk_time.value != 0) &&
361 (0 == strncmp (buf, last_bulk, sizeof (last_bulk))))
364 if ((GNUNET_TIME_absolute_get_duration (last_bulk_time).value >
365 BULK_DELAY_THRESHOLD)
366 || (last_bulk_repeat > BULK_REPEAT_THRESHOLD))
372 strncpy (last_bulk, buf, sizeof (last_bulk));
373 last_bulk_repeat = 0;
374 last_bulk_kind = kind;
375 last_bulk_time = GNUNET_TIME_absolute_get ();
376 last_bulk_comp = comp;
377 output_message (kind, comp, date, buf);
385 * @param kind how serious is the error?
386 * @param message what is the message (format string)
387 * @param ... arguments for format string
390 GNUNET_log (enum GNUNET_ErrorType kind, const char *message, ...)
393 va_start (va, message);
394 mylog (kind, component, message, va);
400 * Log function that specifies an alternative component.
401 * This function should be used by plugins.
403 * @param kind how serious is the error?
404 * @param comp component responsible for generating the message
405 * @param message what is the message (format string)
406 * @param ... arguments for format string
409 GNUNET_log_from (enum GNUNET_ErrorType kind,
410 const char *comp, const char *message, ...)
413 va_start (va, message);
414 mylog (kind, comp, message, va);
420 * Convert error type to string.
422 * @param kind type to convert
423 * @return string corresponding to the type
426 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind)
428 if ((kind & GNUNET_ERROR_TYPE_ERROR) > 0)
430 if ((kind & GNUNET_ERROR_TYPE_WARNING) > 0)
432 if ((kind & GNUNET_ERROR_TYPE_INFO) > 0)
434 if ((kind & GNUNET_ERROR_TYPE_DEBUG) > 0)
441 * Convert a hash to a string (for printing debug messages).
442 * This is one of the very few calls in the entire API that is
445 * @param hc the hash code
446 * @return string form; will be overwritten by next call to GNUNET_h2s.
449 GNUNET_h2s (const GNUNET_HashCode * hc)
451 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
452 GNUNET_CRYPTO_hash_to_enc (hc, &ret);
453 ret.encoding[8] = '\0';
454 return (const char *) ret.encoding;
459 * Convert a peer identity to a string (for printing debug messages).
460 * This is one of the very few calls in the entire API that is
463 * @param pid the peer identity
464 * @return string form of the pid; will be overwritten by next
465 * call to GNUNET_i2s.
468 GNUNET_i2s (const struct GNUNET_PeerIdentity *pid)
470 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
471 GNUNET_CRYPTO_hash_to_enc (&pid->hashPubKey, &ret);
472 ret.encoding[4] = '\0';
473 return (const char *) ret.encoding;
479 * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
480 * (for printing debug messages). This is one of the very few calls
481 * in the entire API that is NOT reentrant!
483 * @param addr the address
484 * @param addrlen the length of the address
485 * @return nicely formatted string for the address
486 * will be overwritten by next call to GNUNET_a2s.
489 GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen)
491 static char buf[INET6_ADDRSTRLEN + 8];
493 const struct sockaddr_in *v4;
494 const struct sockaddr_in6 *v6;
497 return _("unknown address");
498 switch (addr->sa_family)
501 v4 = (const struct sockaddr_in *) addr;
502 inet_ntop (AF_INET, &v4->sin_addr, buf, INET_ADDRSTRLEN);
503 if (0 == ntohs (v4->sin_port))
506 sprintf (b2, "%u", ntohs (v4->sin_port));
510 v6 = (const struct sockaddr_in6 *) addr;
512 inet_ntop (AF_INET6, &v6->sin6_addr, &buf[1], INET6_ADDRSTRLEN);
513 if (0 == ntohs (v6->sin6_port))
516 sprintf (b2, "%u", ntohs (v6->sin6_port));
520 return _("invalid address");
528 void __attribute__ ((constructor)) GNUNET_util_cl_init ()
530 GNUNET_stderr = stderr;
533 /* end of common_logging.c */