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;
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 if (0 == strcasecmp (log, _("NONE")))
156 return GNUNET_ERROR_TYPE_NONE;
157 return GNUNET_ERROR_TYPE_INVALID;
164 * @param comp default component to use
165 * @param loglevel what types of messages should be logged
166 * @param logfile which file to write log messages to (can be NULL)
167 * @return GNUNET_OK on success
170 GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile)
176 GNUNET_free_non_null (component);
177 GNUNET_asprintf (&component,
181 min_level = get_type (loglevel);
184 fn = GNUNET_STRINGS_filename_expand (logfile);
186 return GNUNET_SYSERR;
187 dirwarn = (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn));
188 altlog = FOPEN (fn, "a");
191 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", fn);
193 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
194 _("Failed to create or access directory for log file `%s'\n"),
197 return GNUNET_SYSERR;
200 if (GNUNET_stderr != NULL)
201 fclose (GNUNET_stderr);
202 GNUNET_stderr = altlog;
207 * Add a custom logger.
209 * @param logger log function
210 * @param logger_cls closure for logger
213 GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls)
215 struct CustomLogger *entry;
217 entry = GNUNET_malloc (sizeof (struct CustomLogger));
218 entry->logger = logger;
219 entry->logger_cls = logger_cls;
220 entry->next = loggers;
225 * Remove a custom logger.
227 * @param logger log function
228 * @param logger_cls closure for logger
231 GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls)
233 struct CustomLogger *pos;
234 struct CustomLogger *prev;
238 while ((pos != NULL) &&
239 ((pos->logger != logger) || (pos->logger_cls != logger_cls)))
244 GNUNET_assert (pos != NULL);
248 prev->next = pos->next;
254 * Actually output the log message.
256 * @param kind how severe was the issue
257 * @param comp component responsible
258 * @param datestr current date/time
259 * @param msg the actual message
262 output_message (enum GNUNET_ErrorType kind,
263 const char *comp, const char *datestr, const char *msg)
265 struct CustomLogger *pos;
266 if (GNUNET_stderr != NULL)
268 fprintf (GNUNET_stderr, "%s %s %s %s", datestr, comp,
269 GNUNET_error_type_to_string (kind), msg);
270 fflush (GNUNET_stderr);
275 pos->logger (pos->logger_cls, kind, comp, datestr, msg);
282 * Flush an existing bulk report to the output.
284 * @param datestr our current timestamp
287 flush_bulk (const char *datestr)
289 char msg[DATE_STR_SIZE + BULK_TRACK_SIZE + 256];
294 if ((last_bulk_time.abs_value == 0) || (last_bulk_repeat == 0))
297 last = memchr (last_bulk, '\0', BULK_TRACK_SIZE);
299 last = &last_bulk[BULK_TRACK_SIZE - 1];
300 else if (last != last_bulk)
308 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration
310 snprintf (msg, sizeof (msg),
311 _("Message `%.*s' repeated %u times in the last %s\n"),
312 BULK_TRACK_SIZE, last_bulk, last_bulk_repeat, ft);
316 output_message (last_bulk_kind, last_bulk_comp, datestr, msg);
317 last_bulk_time = GNUNET_TIME_absolute_get ();
318 last_bulk_repeat = 0;
323 * Ignore the next n calls to the log function.
325 * @param n number of log calls to ignore
326 * @param check_reset GNUNET_YES to assert that the log skip counter is currently zero
329 GNUNET_log_skip (unsigned int n, int check_reset)
335 ok = (0 == skip_log);
346 * Output a log message using the default mechanism.
348 * @param kind how severe was the issue
349 * @param comp component responsible
350 * @param message the actual message
351 * @param va arguments to the format string "message"
354 mylog (enum GNUNET_ErrorType kind,
355 const char *comp, const char *message, va_list va)
357 char date[DATE_STR_SIZE];
369 if ((kind & (~GNUNET_ERROR_TYPE_BULK)) > min_level)
372 size = VSNPRINTF (NULL, 0, message, vacp) + 1;
377 VSNPRINTF (buf, size, message, va);
379 memset (date, 0, DATE_STR_SIZE);
380 tmptr = localtime (&timetmp);
382 strftime (date, DATE_STR_SIZE, "%b %d %H:%M:%S", tmptr);
384 strcpy (date, "localtime error");
385 if ((0 != (kind & GNUNET_ERROR_TYPE_BULK)) &&
386 (last_bulk_time.abs_value != 0) &&
387 (0 == strncmp (buf, last_bulk, sizeof (last_bulk))))
390 if ((GNUNET_TIME_absolute_get_duration (last_bulk_time).rel_value >
391 BULK_DELAY_THRESHOLD)
392 || (last_bulk_repeat > BULK_REPEAT_THRESHOLD))
398 strncpy (last_bulk, buf, sizeof (last_bulk));
399 last_bulk_repeat = 0;
400 last_bulk_kind = kind;
401 last_bulk_time = GNUNET_TIME_absolute_get ();
402 strncpy (last_bulk_comp, comp, COMP_TRACK_SIZE);
403 output_message (kind, comp, date, buf);
411 * @param kind how serious is the error?
412 * @param message what is the message (format string)
413 * @param ... arguments for format string
416 GNUNET_log (enum GNUNET_ErrorType kind, const char *message, ...)
419 va_start (va, message);
420 mylog (kind, component, message, va);
426 * Log function that specifies an alternative component.
427 * This function should be used by plugins.
429 * @param kind how serious is the error?
430 * @param comp component responsible for generating the message
431 * @param message what is the message (format string)
432 * @param ... arguments for format string
435 GNUNET_log_from (enum GNUNET_ErrorType kind,
436 const char *comp, const char *message, ...)
439 char comp_w_pid[128];
441 va_start (va, message);
442 GNUNET_snprintf (comp_w_pid,
447 mylog (kind, comp_w_pid, message, va);
453 * Convert error type to string.
455 * @param kind type to convert
456 * @return string corresponding to the type
459 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind)
461 if ((kind & GNUNET_ERROR_TYPE_ERROR) > 0)
463 if ((kind & GNUNET_ERROR_TYPE_WARNING) > 0)
465 if ((kind & GNUNET_ERROR_TYPE_INFO) > 0)
467 if ((kind & GNUNET_ERROR_TYPE_DEBUG) > 0)
474 * Convert a hash to a string (for printing debug messages).
475 * This is one of the very few calls in the entire API that is
478 * @param hc the hash code
479 * @return string form; will be overwritten by next call to GNUNET_h2s.
482 GNUNET_h2s (const GNUNET_HashCode * hc)
484 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
486 GNUNET_CRYPTO_hash_to_enc (hc, &ret);
487 ret.encoding[8] = '\0';
488 return (const char *) ret.encoding;
492 * Convert a hash to a string (for printing debug messages).
493 * This is one of the very few calls in the entire API that is
496 * @param hc the hash code
497 * @return string form; will be overwritten by next call to GNUNET_h2s_full.
500 GNUNET_h2s_full (const GNUNET_HashCode * hc)
502 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
504 GNUNET_CRYPTO_hash_to_enc (hc, &ret);
505 ret.encoding[sizeof(ret)-1] = '\0';
506 return (const char *) ret.encoding;
510 * Convert a peer identity to a string (for printing debug messages).
511 * This is one of the very few calls in the entire API that is
514 * @param pid the peer identity
515 * @return string form of the pid; will be overwritten by next
516 * call to GNUNET_i2s.
519 GNUNET_i2s (const struct GNUNET_PeerIdentity *pid)
521 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
523 GNUNET_CRYPTO_hash_to_enc (&pid->hashPubKey, &ret);
524 ret.encoding[4] = '\0';
525 return (const char *) ret.encoding;
531 * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
532 * (for printing debug messages). This is one of the very few calls
533 * in the entire API that is NOT reentrant!
535 * @param addr the address
536 * @param addrlen the length of the address
537 * @return nicely formatted string for the address
538 * will be overwritten by next call to GNUNET_a2s.
541 GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen)
543 static char buf[INET6_ADDRSTRLEN + 8];
545 const struct sockaddr_in *v4;
546 const struct sockaddr_un *un;
547 const struct sockaddr_in6 *v6;
551 return _("unknown address");
552 switch (addr->sa_family)
555 if (addrlen != sizeof (struct sockaddr_in))
556 return "<invalid v4 address>";
557 v4 = (const struct sockaddr_in *) addr;
558 inet_ntop (AF_INET, &v4->sin_addr, buf, INET_ADDRSTRLEN);
559 if (0 == ntohs (v4->sin_port))
562 GNUNET_snprintf (b2, sizeof(b2), "%u", ntohs (v4->sin_port));
566 if (addrlen != sizeof (struct sockaddr_in6))
567 return "<invalid v4 address>";
568 v6 = (const struct sockaddr_in6 *) addr;
570 inet_ntop (AF_INET6, &v6->sin6_addr, &buf[1], INET6_ADDRSTRLEN);
571 if (0 == ntohs (v6->sin6_port))
574 GNUNET_snprintf (b2, sizeof(b2), "%u", ntohs (v6->sin6_port));
578 if (addrlen <= sizeof (sa_family_t))
579 return "<unbound UNIX client>";
580 un = (const struct sockaddr_un*) addr;
582 if (un->sun_path[0] == '\0') off++;
586 (off == 1) ? "@" : "",
587 (int) (addrlen - sizeof (sa_family_t) - 1 - off),
591 return _("invalid address");
599 void __attribute__ ((constructor)) GNUNET_util_cl_init ()
601 GNUNET_stderr = stderr;
611 void __attribute__ ((destructor)) GNUNET_util_cl_fini ()
618 /* end of common_logging.c */