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 const 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 * Convert a textual description of a loglevel
128 * to the respective GNUNET_GE_KIND.
129 * @returns GNUNET_GE_INVALID if log does not parse
131 static enum GNUNET_ErrorType
132 get_type (const char *log)
134 if (0 == strcasecmp (log, _("DEBUG")))
135 return GNUNET_ERROR_TYPE_DEBUG;
136 if (0 == strcasecmp (log, _("INFO")))
137 return GNUNET_ERROR_TYPE_INFO;
138 if (0 == strcasecmp (log, _("WARNING")))
139 return GNUNET_ERROR_TYPE_WARNING;
140 if (0 == strcasecmp (log, _("ERROR")))
141 return GNUNET_ERROR_TYPE_ERROR;
142 return GNUNET_ERROR_TYPE_INVALID;
148 * @param comp default component to use
149 * @param loglevel what types of messages should be logged
152 GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile)
157 min_level = get_type (loglevel);
160 altlog = fopen (logfile, "a");
163 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", logfile);
164 return GNUNET_SYSERR;
173 * Add a custom logger.
175 * @param logger log function
176 * @param logger_cls closure for logger
179 GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls)
181 struct CustomLogger *entry;
183 entry = GNUNET_malloc (sizeof (struct CustomLogger));
184 entry->logger = logger;
185 entry->logger_cls = logger_cls;
186 entry->next = loggers;
191 * Remove a custom logger.
193 * @param logger log function
194 * @param logger_cls closure for logger
197 GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls)
199 struct CustomLogger *pos;
200 struct CustomLogger *prev;
204 while ((pos != NULL) &&
205 ((pos->logger != logger) || (pos->logger_cls != logger_cls)))
210 GNUNET_assert (pos != NULL);
214 prev->next = pos->next;
219 output_message (enum GNUNET_ErrorType kind,
220 const char *comp, const char *datestr, const char *msg)
222 struct CustomLogger *pos;
224 fprintf (stderr, "%s %s %s %s", datestr, comp,
225 GNUNET_error_type_to_string (kind), msg);
229 pos->logger (pos->logger_cls, kind, comp, datestr, msg);
235 flush_bulk (const char *datestr)
237 char msg[DATE_STR_SIZE + BULK_TRACK_SIZE + 256];
242 if ((last_bulk_time.value == 0) || (last_bulk_repeat == 0))
245 last = memchr (last_bulk, '\0', BULK_TRACK_SIZE);
247 last = &last_bulk[BULK_TRACK_SIZE - 1];
248 else if (last != last_bulk)
256 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration
258 snprintf (msg, sizeof (msg),
259 _("Message `%.*s' repeated %u times in the last %s\n"),
260 BULK_TRACK_SIZE, last_bulk, last_bulk_repeat, ft);
264 output_message (last_bulk_kind, last_bulk_comp, datestr, msg);
265 last_bulk_time = GNUNET_TIME_absolute_get ();
266 last_bulk_repeat = 0;
271 * Ignore the next n calls to the log function.
273 * @param n number of log calls to ignore
276 GNUNET_log_skip (unsigned int n)
282 ok = (0 == skip_log);
291 mylog (enum GNUNET_ErrorType kind,
292 const char *comp, const char *message, va_list va)
294 char date[DATE_STR_SIZE];
306 if ((kind & (~GNUNET_ERROR_TYPE_BULK)) > min_level)
309 size = VSNPRINTF (NULL, 0, message, vacp) + 1;
314 VSNPRINTF (buf, size, message, va);
316 memset (date, 0, DATE_STR_SIZE);
317 tmptr = localtime (&timetmp);
318 strftime (date, DATE_STR_SIZE, "%b %d %H:%M:%S", tmptr);
319 if ((0 != (kind & GNUNET_ERROR_TYPE_BULK)) &&
320 (last_bulk_time.value != 0) &&
321 (0 == strncmp (buf, last_bulk, sizeof (last_bulk))))
324 if ((GNUNET_TIME_absolute_get_duration (last_bulk_time).value >
325 BULK_DELAY_THRESHOLD)
326 || (last_bulk_repeat > BULK_REPEAT_THRESHOLD))
332 strncpy (last_bulk, buf, sizeof (last_bulk));
333 last_bulk_repeat = 0;
334 last_bulk_kind = kind;
335 last_bulk_time = GNUNET_TIME_absolute_get ();
336 last_bulk_comp = comp;
337 output_message (kind, comp, date, buf);
343 GNUNET_log (enum GNUNET_ErrorType kind, const char *message, ...)
346 va_start (va, message);
347 mylog (kind, component, message, va);
353 GNUNET_log_from (enum GNUNET_ErrorType kind,
354 const char *comp, const char *message, ...)
357 va_start (va, message);
358 mylog (kind, comp, message, va);
364 * Convert KIND to String
367 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind)
369 if ((kind & GNUNET_ERROR_TYPE_ERROR) > 0)
371 if ((kind & GNUNET_ERROR_TYPE_WARNING) > 0)
373 if ((kind & GNUNET_ERROR_TYPE_INFO) > 0)
375 if ((kind & GNUNET_ERROR_TYPE_DEBUG) > 0)
382 * Convert a peer identity to a string (for printing debug messages).
383 * This is one of the very few calls in the entire API that is
386 * @param pid the peer identity
387 * @return string form of the pid; will be overwritten by next
388 * call to GNUNET_i2s.
391 GNUNET_i2s (const struct GNUNET_PeerIdentity *pid)
393 static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
394 GNUNET_CRYPTO_hash_to_enc (&pid->hashPubKey, &ret);
395 ret.encoding[4] = '\0';
396 return (const char *) ret.encoding;
401 /* end of common_logging.c */