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)
184 QueryPerformanceFrequency (&performance_frequency);
186 GNUNET_free_non_null (component);
187 GNUNET_asprintf (&component,
191 min_level = get_type (loglevel);
194 fn = GNUNET_STRINGS_filename_expand (logfile);
196 return GNUNET_SYSERR;
197 dirwarn = (GNUNET_OK != GNUNET_DISK_directory_create_for_file (fn));
198 altlog = FOPEN (fn, "a");
201 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", fn);
203 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
204 _("Failed to create or access directory for log file `%s'\n"),
207 return GNUNET_SYSERR;
210 if (GNUNET_stderr != NULL)
211 fclose (GNUNET_stderr);
212 GNUNET_stderr = altlog;
217 * Add a custom logger.
219 * @param logger log function
220 * @param logger_cls closure for logger
223 GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls)
225 struct CustomLogger *entry;
227 entry = GNUNET_malloc (sizeof (struct CustomLogger));
228 entry->logger = logger;
229 entry->logger_cls = logger_cls;
230 entry->next = loggers;
235 * Remove a custom logger.
237 * @param logger log function
238 * @param logger_cls closure for logger
241 GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls)
243 struct CustomLogger *pos;
244 struct CustomLogger *prev;
248 while ((pos != NULL) &&
249 ((pos->logger != logger) || (pos->logger_cls != logger_cls)))
254 GNUNET_assert (pos != NULL);
258 prev->next = pos->next;
264 * Actually output the log message.
266 * @param kind how severe was the issue
267 * @param comp component responsible
268 * @param datestr current date/time
269 * @param msg the actual message
272 output_message (enum GNUNET_ErrorType kind,
273 const char *comp, const char *datestr, const char *msg)
275 struct CustomLogger *pos;
276 if (GNUNET_stderr != NULL)
278 fprintf (GNUNET_stderr, "%s %s %s %s", datestr, comp,
279 GNUNET_error_type_to_string (kind), msg);
280 fflush (GNUNET_stderr);
285 pos->logger (pos->logger_cls, kind, comp, datestr, msg);
292 * Flush an existing bulk report to the output.
294 * @param datestr our current timestamp
297 flush_bulk (const char *datestr)
299 char msg[DATE_STR_SIZE + BULK_TRACK_SIZE + 256];
304 if ((last_bulk_time.abs_value == 0) || (last_bulk_repeat == 0))
307 last = memchr (last_bulk, '\0', BULK_TRACK_SIZE);
309 last = &last_bulk[BULK_TRACK_SIZE - 1];
310 else if (last != last_bulk)
318 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration
320 snprintf (msg, sizeof (msg),
321 _("Message `%.*s' repeated %u times in the last %s\n"),
322 BULK_TRACK_SIZE, last_bulk, last_bulk_repeat, ft);
326 output_message (last_bulk_kind, last_bulk_comp, datestr, msg);
327 last_bulk_time = GNUNET_TIME_absolute_get ();
328 last_bulk_repeat = 0;
333 * Ignore the next n calls to the log function.
335 * @param n number of log calls to ignore
336 * @param check_reset GNUNET_YES to assert that the log skip counter is currently zero
339 GNUNET_log_skip (unsigned int n, int check_reset)
345 ok = (0 == skip_log);
356 * Output a log message using the default mechanism.
358 * @param kind how severe was the issue
359 * @param comp component responsible
360 * @param message the actual message
361 * @param va arguments to the format string "message"
364 mylog (enum GNUNET_ErrorType kind,
365 const char *comp, const char *message, va_list va)
367 char date[DATE_STR_SIZE];
368 char date2[DATE_STR_SIZE];
370 struct timeval timeofday;
381 if ((kind & (~GNUNET_ERROR_TYPE_BULK)) > min_level)
384 size = VSNPRINTF (NULL, 0, message, vacp) + 1;
389 VSNPRINTF (buf, size, message, va);
391 memset (date, 0, DATE_STR_SIZE);
392 tmptr = localtime (&timetmp);
393 gettimeofday(&timeofday, NULL);
399 QueryPerformanceCounter (&pc);
400 strftime (date2, DATE_STR_SIZE, "%b %d %H:%M:%S-%%020llu", tmptr);
401 snprintf (date, sizeof (date), date2, (long long) (pc.QuadPart / (performance_frequency.QuadPart / 1000)));
403 strftime (date2, DATE_STR_SIZE, "%b %d %H:%M:%S-%%06u", tmptr);
404 snprintf (date, sizeof (date), date2, timeofday.tv_usec);
408 strcpy (date, "localtime error");
409 if ((0 != (kind & GNUNET_ERROR_TYPE_BULK)) &&
410 (last_bulk_time.abs_value != 0) &&
411 (0 == strncmp (buf, last_bulk, sizeof (last_bulk))))
414 if ((GNUNET_TIME_absolute_get_duration (last_bulk_time).rel_value >
415 BULK_DELAY_THRESHOLD)
416 || (last_bulk_repeat > BULK_REPEAT_THRESHOLD))
422 strncpy (last_bulk, buf, sizeof (last_bulk));
423 last_bulk_repeat = 0;
424 last_bulk_kind = kind;
425 last_bulk_time = GNUNET_TIME_absolute_get ();
426 strncpy (last_bulk_comp, comp, COMP_TRACK_SIZE);
427 output_message (kind, comp, date, buf);
435 * @param kind how serious is the error?
436 * @param message what is the message (format string)
437 * @param ... arguments for format string
440 GNUNET_log (enum GNUNET_ErrorType kind, const char *message, ...)
443 va_start (va, message);
444 mylog (kind, component, message, va);
450 * Log function that specifies an alternative component.
451 * This function should be used by plugins.
453 * @param kind how serious is the error?
454 * @param comp component responsible for generating the message
455 * @param message what is the message (format string)
456 * @param ... arguments for format string
459 GNUNET_log_from (enum GNUNET_ErrorType kind,
460 const char *comp, const char *message, ...)
463 char comp_w_pid[128];
465 va_start (va, message);
466 GNUNET_snprintf (comp_w_pid,
471 mylog (kind, comp_w_pid, message, va);
477 * Convert error type to string.
479 * @param kind type to convert
480 * @return string corresponding to the type
483 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind)
485 if ((kind & GNUNET_ERROR_TYPE_ERROR) > 0)
487 if ((kind & GNUNET_ERROR_TYPE_WARNING) > 0)
489 if ((kind & GNUNET_ERROR_TYPE_INFO) > 0)
491 if ((kind & GNUNET_ERROR_TYPE_DEBUG) > 0)
498 * Convert a hash to a string (for printing debug messages).
499 * This is one of the very few calls in the entire API that is
502 * @param hc the hash code
503 * @return string form; will be overwritten by next call to GNUNET_h2s.
506 GNUNET_h2s (const GNUNET_HashCode * hc)
508 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
510 GNUNET_CRYPTO_hash_to_enc (hc, &ret);
511 ret.encoding[8] = '\0';
512 return (const char *) ret.encoding;
516 * Convert a hash to a string (for printing debug messages).
517 * This is one of the very few calls in the entire API that is
520 * @param hc the hash code
521 * @return string form; will be overwritten by next call to GNUNET_h2s_full.
524 GNUNET_h2s_full (const GNUNET_HashCode * hc)
526 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
528 GNUNET_CRYPTO_hash_to_enc (hc, &ret);
529 ret.encoding[sizeof(ret)-1] = '\0';
530 return (const char *) ret.encoding;
534 * Convert a peer identity to a string (for printing debug messages).
535 * This is one of the very few calls in the entire API that is
538 * @param pid the peer identity
539 * @return string form of the pid; will be overwritten by next
540 * call to GNUNET_i2s.
543 GNUNET_i2s (const struct GNUNET_PeerIdentity *pid)
545 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
547 GNUNET_CRYPTO_hash_to_enc (&pid->hashPubKey, &ret);
548 ret.encoding[4] = '\0';
549 return (const char *) ret.encoding;
555 * Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string
556 * (for printing debug messages). This is one of the very few calls
557 * in the entire API that is NOT reentrant!
559 * @param addr the address
560 * @param addrlen the length of the address
561 * @return nicely formatted string for the address
562 * will be overwritten by next call to GNUNET_a2s.
565 GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen)
567 static char buf[INET6_ADDRSTRLEN + 8];
569 const struct sockaddr_in *v4;
570 const struct sockaddr_un *un;
571 const struct sockaddr_in6 *v6;
575 return _("unknown address");
576 switch (addr->sa_family)
579 if (addrlen != sizeof (struct sockaddr_in))
580 return "<invalid v4 address>";
581 v4 = (const struct sockaddr_in *) addr;
582 inet_ntop (AF_INET, &v4->sin_addr, buf, INET_ADDRSTRLEN);
583 if (0 == ntohs (v4->sin_port))
586 GNUNET_snprintf (b2, sizeof(b2), "%u", ntohs (v4->sin_port));
590 if (addrlen != sizeof (struct sockaddr_in6))
591 return "<invalid v4 address>";
592 v6 = (const struct sockaddr_in6 *) addr;
594 inet_ntop (AF_INET6, &v6->sin6_addr, &buf[1], INET6_ADDRSTRLEN);
595 if (0 == ntohs (v6->sin6_port))
598 GNUNET_snprintf (b2, sizeof(b2), "%u", ntohs (v6->sin6_port));
602 if (addrlen <= sizeof (sa_family_t))
603 return "<unbound UNIX client>";
604 un = (const struct sockaddr_un*) addr;
606 if (un->sun_path[0] == '\0') off++;
610 (off == 1) ? "@" : "",
611 (int) (addrlen - sizeof (sa_family_t) - 1 - off),
615 return _("invalid address");
623 void __attribute__ ((constructor)) GNUNET_util_cl_init ()
625 GNUNET_stderr = stderr;
635 void __attribute__ ((destructor)) GNUNET_util_cl_fini ()
642 /* end of common_logging.c */