ng

1 files changed, 401 insertions, 0 deletions

diff --git a/src/util/common_logging.c b/src/util/common_logging.c
new file mode 100644
index 000000000..4068ed94b
--- /dev/null
+++ b/src/util/common_logging.c
@@ -0,0 +1,401 @@
+/*
+     This file is part of GNUnet.
+     (C) 2006, 2008, 2009 Christian Grothoff (and other contributing authors)
+
+     GNUnet is free software; you can redistribute it and/or modify
+     it under the terms of the GNU General Public License as published
+     by the Free Software Foundation; either version 2, or (at your
+     option) any later version.
+
+     GNUnet is distributed in the hope that it will be useful, but
+     WITHOUT ANY WARRANTY; without even the implied warranty of
+     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+     General Public License for more details.
+
+     You should have received a copy of the GNU General Public License
+     along with GNUnet; see the file COPYING.  If not, write to the
+     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+     Boston, MA 02111-1307, USA.
+*/
+
+/**
+ * @file util/common_logging.c
+ * @brief error handling API
+ *
+ * @author Christian Grothoff
+ */
+#include "platform.h"
+#include "gnunet_common.h"
+#include "gnunet_crypto_lib.h"
+#include "gnunet_strings_lib.h"
+#include "gnunet_time_lib.h"
+
+/**
+ * After how many seconds do we always print
+ * that "message X was repeated N times"?  Use 12h.
+ */
+#define BULK_DELAY_THRESHOLD (12 * 60 * 60 * 1000)
+
+/**
+ * After how many repetitions do we always print
+ * that "message X was repeated N times"? (even if
+ * we have not yet reached the delay threshold)
+ */
+#define BULK_REPEAT_THRESHOLD 1000
+
+/**
+ * How many characters do we use for matching of
+ * bulk messages?
+ */
+#define BULK_TRACK_SIZE 256
+
+/**
+ * How many characters can a date/time string
+ * be at most?
+ */
+#define DATE_STR_SIZE 64
+
+/**
+ * Linked list of active loggers.
+ */
+struct CustomLogger
+{
+  /**
+   * This is a linked list.
+   */
+  struct CustomLogger *next;
+
+  /**
+   * Log function.
+   */
+  GNUNET_Logger logger;
+
+  /**
+   * Closure for logger.
+   */
+  void *logger_cls;
+};
+
+/**
+ * The last "bulk" error message that we have been logging.
+ * Note that this message maybe truncated to the first BULK_TRACK_SIZE
+ * characters, in which case it is NOT 0-terminated!
+ */
+static char last_bulk[BULK_TRACK_SIZE];
+
+/**
+ * Type of the last bulk message.
+ */
+static enum GNUNET_ErrorType last_bulk_kind;
+
+/**
+ * Time of the last bulk error message (0 for none)
+ */
+static struct GNUNET_TIME_Absolute last_bulk_time;
+
+/**
+ * Number of times that bulk message has been repeated since.
+ */
+static unsigned int last_bulk_repeat;
+
+/**
+ * Component when the last bulk was logged.
+ */
+static const char *last_bulk_comp;
+
+/**
+ * Running component.
+ */
+static const char *component;
+
+/**
+ * Minimum log level.
+ */
+static enum GNUNET_ErrorType min_level;
+
+/**
+ * Linked list of our custom loggres.
+ */
+static struct CustomLogger *loggers;
+
+/**
+ * Number of log calls to ignore.
+ */
+static unsigned int skip_log;
+
+/**
+ * Convert a textual description of a loglevel
+ * to the respective GNUNET_GE_KIND.
+ * @returns GNUNET_GE_INVALID if log does not parse
+ */
+static enum GNUNET_ErrorType
+get_type (const char *log)
+{
+  if (0 == strcasecmp (log, _("DEBUG")))
+    return GNUNET_ERROR_TYPE_DEBUG;
+  if (0 == strcasecmp (log, _("INFO")))
+    return GNUNET_ERROR_TYPE_INFO;
+  if (0 == strcasecmp (log, _("WARNING")))
+    return GNUNET_ERROR_TYPE_WARNING;
+  if (0 == strcasecmp (log, _("ERROR")))
+    return GNUNET_ERROR_TYPE_ERROR;
+  return GNUNET_ERROR_TYPE_INVALID;
+}
+
+/**
+ * Setup logging.
+ *
+ * @param comp default component to use
+ * @param loglevel what types of messages should be logged
+ */
+int
+GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile)
+{
+  FILE *altlog;
+
+  component = comp;
+  min_level = get_type (loglevel);
+  if (logfile == NULL)
+    return GNUNET_OK;
+  altlog = fopen (logfile, "a");
+  if (altlog == NULL)
+    {
+      GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", logfile);
+      return GNUNET_SYSERR;
+    }
+  if (stderr != NULL)
+    fclose (stderr);
+  stderr = altlog;
+  return GNUNET_OK;
+}
+
+/**
+ * Add a custom logger.
+ *
+ * @param logger log function
+ * @param logger_cls closure for logger
+ */
+void
+GNUNET_logger_add (GNUNET_Logger logger, void *logger_cls)
+{
+  struct CustomLogger *entry;
+
+  entry = GNUNET_malloc (sizeof (struct CustomLogger));
+  entry->logger = logger;
+  entry->logger_cls = logger_cls;
+  entry->next = loggers;
+  loggers = entry;
+}
+
+/**
+ * Remove a custom logger.
+ *
+ * @param logger log function
+ * @param logger_cls closure for logger
+ */
+void
+GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls)
+{
+  struct CustomLogger *pos;
+  struct CustomLogger *prev;
+
+  prev = NULL;
+  pos = loggers;
+  while ((pos != NULL) &&
+         ((pos->logger != logger) || (pos->logger_cls != logger_cls)))
+    {
+      prev = pos;
+      pos = pos->next;
+    }
+  GNUNET_assert (pos != NULL);
+  if (prev == NULL)
+    loggers = pos->next;
+  else
+    prev->next = pos->next;
+  GNUNET_free (pos);
+}
+
+static void
+output_message (enum GNUNET_ErrorType kind,
+                const char *comp, const char *datestr, const char *msg)
+{
+  struct CustomLogger *pos;
+  if (stderr != NULL)
+    fprintf (stderr, "%s %s %s %s", datestr, comp,
+             GNUNET_error_type_to_string (kind), msg);
+  pos = loggers;
+  while (pos != NULL)
+    {
+      pos->logger (pos->logger_cls, kind, comp, datestr, msg);
+      pos = pos->next;
+    }
+}
+
+static void
+flush_bulk (const char *datestr)
+{
+  char msg[DATE_STR_SIZE + BULK_TRACK_SIZE + 256];
+  int rev;
+  char *last;
+  char *ft;
+
+  if ((last_bulk_time.value == 0) || (last_bulk_repeat == 0))
+    return;
+  rev = 0;
+  last = memchr (last_bulk, '\0', BULK_TRACK_SIZE);
+  if (last == NULL)
+    last = &last_bulk[BULK_TRACK_SIZE - 1];
+  else if (last != last_bulk)
+    last--;
+  if (last[0] == '\n')
+    {
+      rev = 1;
+      last[0] = '\0';
+    }
+  ft =
+    GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_duration
+                                            (last_bulk_time));
+  snprintf (msg, sizeof (msg),
+            _("Message `%.*s' repeated %u times in the last %s\n"),
+            BULK_TRACK_SIZE, last_bulk, last_bulk_repeat, ft);
+  GNUNET_free (ft);
+  if (rev == 1)
+    last[0] = '\n';
+  output_message (last_bulk_kind, last_bulk_comp, datestr, msg);
+  last_bulk_time = GNUNET_TIME_absolute_get ();
+  last_bulk_repeat = 0;
+}
+
+
+/**
+ * Ignore the next n calls to the log function.
+ *
+ * @param n number of log calls to ignore
+ */
+void
+GNUNET_log_skip (unsigned int n)
+{
+  int ok;
+
+  if (n == 0)
+    {
+      ok = (0 == skip_log);
+      skip_log = 0;
+      GNUNET_assert (ok);
+    }
+  skip_log += n;
+}
+
+
+static void
+mylog (enum GNUNET_ErrorType kind,
+       const char *comp, const char *message, va_list va)
+{
+  char date[DATE_STR_SIZE];
+  time_t timetmp;
+  struct tm *tmptr;
+  size_t size;
+  char *buf;
+  va_list vacp;
+
+  if (skip_log > 0)
+    {
+      skip_log--;
+      return;
+    }
+  if ((kind & (~GNUNET_ERROR_TYPE_BULK)) > min_level)
+    return;
+  va_copy (vacp, va);
+  size = VSNPRINTF (NULL, 0, message, vacp) + 1;
+  va_end (vacp);
+  buf = malloc (size);
+  if (buf == NULL)
+    return;                     /* oops */
+  VSNPRINTF (buf, size, message, va);
+  time (&timetmp);
+  memset (date, 0, DATE_STR_SIZE);
+  tmptr = localtime (&timetmp);
+  strftime (date, DATE_STR_SIZE, "%b %d %H:%M:%S", tmptr);
+  if ((0 != (kind & GNUNET_ERROR_TYPE_BULK)) &&
+      (last_bulk_time.value != 0) &&
+      (0 == strncmp (buf, last_bulk, sizeof (last_bulk))))
+    {
+      last_bulk_repeat++;
+      if ((GNUNET_TIME_absolute_get_duration (last_bulk_time).value >
+           BULK_DELAY_THRESHOLD)
+          || (last_bulk_repeat > BULK_REPEAT_THRESHOLD))
+        flush_bulk (date);
+      free (buf);
+      return;
+    }
+  flush_bulk (date);
+  strncpy (last_bulk, buf, sizeof (last_bulk));
+  last_bulk_repeat = 0;
+  last_bulk_kind = kind;
+  last_bulk_time = GNUNET_TIME_absolute_get ();
+  last_bulk_comp = comp;
+  output_message (kind, comp, date, buf);
+  free (buf);
+}
+
+
+void
+GNUNET_log (enum GNUNET_ErrorType kind, const char *message, ...)
+{
+  va_list va;
+  va_start (va, message);
+  mylog (kind, component, message, va);
+  va_end (va);
+}
+
+
+void
+GNUNET_log_from (enum GNUNET_ErrorType kind,
+                 const char *comp, const char *message, ...)
+{
+  va_list va;
+  va_start (va, message);
+  mylog (kind, comp, message, va);
+  va_end (va);
+}
+
+
+/**
+ * Convert KIND to String
+ */
+const char *
+GNUNET_error_type_to_string (enum GNUNET_ErrorType kind)
+{
+  if ((kind & GNUNET_ERROR_TYPE_ERROR) > 0)
+    return _("ERROR");
+  if ((kind & GNUNET_ERROR_TYPE_WARNING) > 0)
+    return _("WARNING");
+  if ((kind & GNUNET_ERROR_TYPE_INFO) > 0)
+    return _("INFO");
+  if ((kind & GNUNET_ERROR_TYPE_DEBUG) > 0)
+    return _("DEBUG");
+  return _("INVALID");
+}
+
+
+/**
+ * Convert a peer identity to a string (for printing debug messages).
+ * This is one of the very few calls in the entire API that is
+ * NOT reentrant!
+ *
+ * @param pid the peer identity
+ * @return string form of the pid; will be overwritten by next
+ *         call to GNUNET_i2s.
+ */
+const char *
+GNUNET_i2s (const struct GNUNET_PeerIdentity *pid)
+{
+  static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
+  GNUNET_CRYPTO_hash_to_enc (&pid->hashPubKey, &ret);
+  ret.encoding[4] = '\0';
+  return (const char *) ret.encoding;
+}
+
+
+
+/* end of common_logging.c */