LRN: Fix automake deps to allow -j* builds again
[oweals/gnunet.git] / src / util / common_logging.c
index 263aa7bac4a4ad15455c99da73b216323d1a6d48..46393674178cc4d11be0550087e8c5b5ad05a1e6 100644 (file)
@@ -31,7 +31,7 @@
 #include "gnunet_time_lib.h"
 
 /**
- * After how many seconds do we always print
+ * After how many milliseconds do we always print
  * that "message X was repeated N times"?  Use 12h.
  */
 #define BULK_DELAY_THRESHOLD (12 * 60 * 60 * 1000)
  */
 #define BULK_TRACK_SIZE 256
 
+/**
+ * How many characters do we use for matching of
+ * bulk components?
+ */
+#define COMP_TRACK_SIZE 32
+
 /**
  * How many characters can a date/time string
  * be at most?
@@ -99,14 +105,14 @@ static struct GNUNET_TIME_Absolute last_bulk_time;
 static unsigned int last_bulk_repeat;
 
 /**
- * Component when the last bulk was logged.
+ * Component when the last bulk was logged.  Will be 0-terminated.
  */
-static const char *last_bulk_comp;
+static char last_bulk_comp[COMP_TRACK_SIZE+1];
 
 /**
  * Running component.
  */
-static const char *component;
+static char *component;
 
 /**
  * Minimum log level.
@@ -123,12 +129,24 @@ static struct CustomLogger *loggers;
  */
 static unsigned int skip_log;
 
+/**
+ * File descriptor to use for "stderr", or NULL for none.
+ */
 static FILE *GNUNET_stderr;
 
+#ifdef WINDOWS
+/**
+ * Contains the number of performance counts per second.
+ */
+LARGE_INTEGER performance_frequency;
+#endif
+
 /**
  * Convert a textual description of a loglevel
  * to the respective GNUNET_GE_KIND.
- * @returns GNUNET_GE_INVALID if log does not parse
+ *
+ * @param log loglevel to parse
+ * @return GNUNET_GE_INVALID if log does not parse
  */
 static enum GNUNET_ErrorType
 get_type (const char *log)
@@ -141,30 +159,67 @@ get_type (const char *log)
     return GNUNET_ERROR_TYPE_WARNING;
   if (0 == strcasecmp (log, _("ERROR")))
     return GNUNET_ERROR_TYPE_ERROR;
+  if (0 == strcasecmp (log, _("NONE")))
+    return GNUNET_ERROR_TYPE_NONE;
   return GNUNET_ERROR_TYPE_INVALID;
 }
 
+
 /**
  * Setup logging.
  *
  * @param comp default component to use
  * @param loglevel what types of messages should be logged
+ * @param logfile which file to write log messages to (can be NULL)
+ * @return GNUNET_OK on success
  */
 int
 GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile)
 {
   FILE *altlog;
-
-  component = comp;
+  int dirwarn;
+  char *fn;
+  const char *env_loglevel;
+  int env_minlevel = 0;
+  int env_min_force_level = 100000;
+
+#ifdef WINDOWS
+  QueryPerformanceFrequency (&performance_frequency);
+#endif
+  GNUNET_free_non_null (component);
+  GNUNET_asprintf (&component,
+                  "%s-%d",
+                  comp,
+                  getpid());
+  env_loglevel = getenv ("GNUNET_LOGLEVEL");
+  if (env_loglevel != NULL)
+    env_minlevel = get_type (env_loglevel);
+  env_loglevel = getenv ("GNUNET_FORCE_LOGLEVEL");
+  if (env_loglevel != NULL)
+    env_min_force_level = get_type (env_loglevel);
   min_level = get_type (loglevel);
+  if (env_minlevel > min_level)
+    min_level = env_minlevel;
+  if (env_min_force_level < min_level)
+    min_level = env_min_force_level;
   if (logfile == NULL)
     return GNUNET_OK;
-  altlog = fopen (logfile, "a");
+  fn = GNUNET_STRINGS_filename_expand (logfile);
+  if (NULL == fn)    
+    return GNUNET_SYSERR;    
+  dirwarn = (GNUNET_OK !=  GNUNET_DISK_directory_create_for_file (fn));
+  altlog = FOPEN (fn, "a");
   if (altlog == NULL)
     {
-      GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", logfile);
+      GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR, "fopen", fn);
+      if (dirwarn) 
+       GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+                   _("Failed to create or access directory for log file `%s'\n"), 
+                   fn);
+      GNUNET_free (fn);
       return GNUNET_SYSERR;
     }
+  GNUNET_free (fn);
   if (GNUNET_stderr != NULL)
     fclose (GNUNET_stderr);
   GNUNET_stderr = altlog;
@@ -217,14 +272,26 @@ GNUNET_logger_remove (GNUNET_Logger logger, void *logger_cls)
   GNUNET_free (pos);
 }
 
+
+/**
+ * Actually output the log message.
+ *
+ * @param kind how severe was the issue
+ * @param comp component responsible
+ * @param datestr current date/time
+ * @param msg the actual message
+ */
 static void
 output_message (enum GNUNET_ErrorType kind,
                 const char *comp, const char *datestr, const char *msg)
 {
   struct CustomLogger *pos;
   if (GNUNET_stderr != NULL)
-    fprintf (GNUNET_stderr, "%s %s %s %s", datestr, comp,
-             GNUNET_error_type_to_string (kind), msg);
+    {
+      fprintf (GNUNET_stderr, "%s %s %s %s", datestr, comp, 
+              GNUNET_error_type_to_string (kind), msg);
+      fflush (GNUNET_stderr);
+    }
   pos = loggers;
   while (pos != NULL)
     {
@@ -233,6 +300,12 @@ output_message (enum GNUNET_ErrorType kind,
     }
 }
 
+
+/**
+ * Flush an existing bulk report to the output.
+ *
+ * @param datestr our current timestamp
+ */
 static void
 flush_bulk (const char *datestr)
 {
@@ -241,7 +314,7 @@ flush_bulk (const char *datestr)
   char *last;
   char *ft;
 
-  if ((last_bulk_time.value == 0) || (last_bulk_repeat == 0))
+  if ((last_bulk_time.abs_value == 0) || (last_bulk_repeat == 0))
     return;
   rev = 0;
   last = memchr (last_bulk, '\0', BULK_TRACK_SIZE);
@@ -279,6 +352,10 @@ void
 GNUNET_log_skip (unsigned int n, int check_reset)
 {
   if (n == 0)
+    {
+      int ok;
+
+      ok = (0 == skip_log);
       skip_log = 0;
       if (check_reset)
         GNUNET_assert (ok);
@@ -288,12 +365,22 @@ GNUNET_log_skip (unsigned int n, int check_reset)
 }
 
 
+/**
+ * Output a log message using the default mechanism.
+ *
+ * @param kind how severe was the issue
+ * @param comp component responsible
+ * @param message the actual message
+ * @param va arguments to the format string "message"
+ */
 static void
 mylog (enum GNUNET_ErrorType kind,
        const char *comp, const char *message, va_list va)
 {
   char date[DATE_STR_SIZE];
+  char date2[DATE_STR_SIZE];
   time_t timetmp;
+  struct timeval timeofday;
   struct tm *tmptr;
   size_t size;
   char *buf;
@@ -316,13 +403,28 @@ mylog (enum GNUNET_ErrorType kind,
   time (&timetmp);
   memset (date, 0, DATE_STR_SIZE);
   tmptr = localtime (&timetmp);
-  strftime (date, DATE_STR_SIZE, "%b %d %H:%M:%S", tmptr);
+  gettimeofday(&timeofday, NULL);
+  if (NULL != tmptr)
+  {
+#ifdef WINDOWS
+    LARGE_INTEGER pc;
+    pc.QuadPart = 0;
+    QueryPerformanceCounter (&pc);
+    strftime (date2, DATE_STR_SIZE, "%b %d %H:%M:%S-%%020llu", tmptr);
+    snprintf (date, sizeof (date), date2, (long long) (pc.QuadPart / (performance_frequency.QuadPart / 1000)));
+#else
+    strftime (date2, DATE_STR_SIZE, "%b %d %H:%M:%S-%%06u", tmptr);
+    snprintf (date, sizeof (date), date2, timeofday.tv_usec);
+#endif
+  }
+  else
+    strcpy (date, "localtime error");
   if ((0 != (kind & GNUNET_ERROR_TYPE_BULK)) &&
-      (last_bulk_time.value != 0) &&
+      (last_bulk_time.abs_value != 0) &&
       (0 == strncmp (buf, last_bulk, sizeof (last_bulk))))
     {
       last_bulk_repeat++;
-      if ((GNUNET_TIME_absolute_get_duration (last_bulk_time).value >
+      if ((GNUNET_TIME_absolute_get_duration (last_bulk_time).rel_value >
            BULK_DELAY_THRESHOLD)
           || (last_bulk_repeat > BULK_REPEAT_THRESHOLD))
         flush_bulk (date);
@@ -334,12 +436,19 @@ mylog (enum GNUNET_ErrorType kind,
   last_bulk_repeat = 0;
   last_bulk_kind = kind;
   last_bulk_time = GNUNET_TIME_absolute_get ();
-  last_bulk_comp = comp;
+  strncpy (last_bulk_comp, comp, COMP_TRACK_SIZE);
   output_message (kind, comp, date, buf);
   free (buf);
 }
 
 
+/**
+ * Main log function.
+ *
+ * @param kind how serious is the error?
+ * @param message what is the message (format string)
+ * @param ... arguments for format string
+ */
 void
 GNUNET_log (enum GNUNET_ErrorType kind, const char *message, ...)
 {
@@ -350,19 +459,38 @@ GNUNET_log (enum GNUNET_ErrorType kind, const char *message, ...)
 }
 
 
+/**
+ * Log function that specifies an alternative component.
+ * This function should be used by plugins.
+ *
+ * @param kind how serious is the error?
+ * @param comp component responsible for generating the message
+ * @param message what is the message (format string)
+ * @param ... arguments for format string
+ */
 void
 GNUNET_log_from (enum GNUNET_ErrorType kind,
                  const char *comp, const char *message, ...)
 {
   va_list va;
+  char comp_w_pid[128];
+
   va_start (va, message);
-  mylog (kind, comp, message, va);
+  GNUNET_snprintf (comp_w_pid,
+                  sizeof (comp_w_pid),
+                  "%s-%d",
+                  comp,
+                  getpid());
+  mylog (kind, comp_w_pid, message, va);
   va_end (va);
 }
 
 
 /**
- * Convert KIND to String
+ * Convert error type to string.
+ *
+ * @param kind type to convert
+ * @return string corresponding to the type
  */
 const char *
 GNUNET_error_type_to_string (enum GNUNET_ErrorType kind)
@@ -384,18 +512,36 @@ GNUNET_error_type_to_string (enum GNUNET_ErrorType kind)
  * This is one of the very few calls in the entire API that is
  * NOT reentrant!
  *
- * @param pid the peer identity
+ * @param hc the hash code
  * @return string form; will be overwritten by next call to GNUNET_h2s.
  */
 const char *
-GNUNET_h2s (const GNUNET_HashCode *pid)
+GNUNET_h2s (const GNUNET_HashCode * hc)
 {
   static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
-  GNUNET_CRYPTO_hash_to_enc (pid, &ret);
+
+  GNUNET_CRYPTO_hash_to_enc (hc, &ret);
   ret.encoding[8] = '\0';
   return (const char *) ret.encoding;
 }
 
+/**
+ * Convert a hash to a string (for printing debug messages).
+ * This is one of the very few calls in the entire API that is
+ * NOT reentrant!
+ *
+ * @param hc the hash code
+ * @return string form; will be overwritten by next call to GNUNET_h2s_full.
+ */
+const char *
+GNUNET_h2s_full (const GNUNET_HashCode * hc)
+{
+  static struct GNUNET_CRYPTO_HashAsciiEncoded ret;
+
+  GNUNET_CRYPTO_hash_to_enc (hc, &ret);
+  ret.encoding[sizeof(ret)-1] = '\0';
+  return (const char *) ret.encoding;
+}
 
 /**
  * Convert a peer identity to a string (for printing debug messages).
@@ -410,6 +556,7 @@ 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;
@@ -427,37 +574,56 @@ GNUNET_i2s (const struct GNUNET_PeerIdentity *pid)
  * @return nicely formatted string for the address
  *  will be overwritten by next call to GNUNET_a2s.
  */
-const char *GNUNET_a2s (const struct sockaddr *addr,
-                       socklen_t addrlen)
+const char *
+GNUNET_a2s (const struct sockaddr *addr, socklen_t addrlen)
 {
-  static char buf[INET6_ADDRSTRLEN+8];
+  static char buf[INET6_ADDRSTRLEN + 8];
   static char b2[6];
-  const struct sockaddr_in * v4;
+  const struct sockaddr_in *v4;
+  const struct sockaddr_un *un;
   const struct sockaddr_in6 *v6;
+  unsigned int off;
 
   if (addr == NULL)
     return _("unknown address");
   switch (addr->sa_family)
     {
     case AF_INET:
-      v4 = (const struct sockaddr_in*)addr;
-      inet_ntop(AF_INET, &v4->sin_addr, buf, INET_ADDRSTRLEN);
-      if (0 == ntohs(v4->sin_port))
-       return buf;     
+      if (addrlen != sizeof (struct sockaddr_in))
+       return "<invalid v4 address>";
+      v4 = (const struct sockaddr_in *) addr;
+      inet_ntop (AF_INET, &v4->sin_addr, buf, INET_ADDRSTRLEN);
+      if (0 == ntohs (v4->sin_port))
+        return buf;
       strcat (buf, ":");
-      sprintf (b2, "%u", ntohs(v4->sin_port));
+      GNUNET_snprintf (b2, sizeof(b2), "%u", ntohs (v4->sin_port));
       strcat (buf, b2);
       return buf;
     case AF_INET6:
-      v6 = (const struct sockaddr_in6*)addr;
+      if (addrlen != sizeof (struct sockaddr_in6))
+       return "<invalid v4 address>";
+      v6 = (const struct sockaddr_in6 *) addr;
       buf[0] = '[';
-      inet_ntop(AF_INET6, &v6->sin6_addr, &buf[1], INET6_ADDRSTRLEN);
-      if (0 == ntohs(v6->sin6_port))
-       return &buf[1]; 
+      inet_ntop (AF_INET6, &v6->sin6_addr, &buf[1], INET6_ADDRSTRLEN);
+      if (0 == ntohs (v6->sin6_port))
+        return &buf[1];
       strcat (buf, "]:");
-      sprintf (b2, "%u", ntohs(v6->sin6_port));
+      GNUNET_snprintf (b2, sizeof(b2), "%u", ntohs (v6->sin6_port));
       strcat (buf, b2);
-      return buf;      
+      return buf;
+    case AF_UNIX:
+      if (addrlen <= sizeof (sa_family_t))
+       return "<unbound UNIX client>";
+      un = (const struct sockaddr_un*) addr;
+      off = 0;
+      if (un->sun_path[0] == '\0') off++;
+      snprintf (buf, 
+               sizeof (buf),
+               "%s%.*s", 
+               (off == 1) ? "@" : "",
+               (int) (addrlen - sizeof (sa_family_t) - 1 - off),
+               &un->sun_path[off]);
+      return buf;
     default:
       return _("invalid address");
     }
@@ -467,10 +633,23 @@ const char *GNUNET_a2s (const struct sockaddr *addr,
 /**
  * Initializer
  */
-void __attribute__ ((constructor))
-GNUNET_util_cl_init()
+void __attribute__ ((constructor)) GNUNET_util_cl_init ()
 {
   GNUNET_stderr = stderr;
+#ifdef MINGW
+  GNInitWinEnv (NULL);
+#endif
+}
+
+
+/**
+ * Destructor
+ */
+void __attribute__ ((destructor)) GNUNET_util_cl_fini ()
+{
+#ifdef MINGW
+  GNShutdownWinEnv ();
+#endif
 }
 
 /* end of common_logging.c */