add units to time, use configuration time api where appropriate, fixing Mantis #1875
[oweals/gnunet.git] / src / util / common_logging.c
index ccee8e028f4ece1be440a1892ebedf520c21a7a4..e96fb8e7888339929bfcef011e0994766130f156 100644 (file)
@@ -30,6 +30,8 @@
 #include "gnunet_strings_lib.h"
 #include "gnunet_time_lib.h"
 
+#include <regex.h>
+
 /**
  * After how many milliseconds do we always print
  * that "message X was repeated N times"?  Use 12h.
@@ -145,24 +147,19 @@ static FILE *GNUNET_stderr;
 struct LogDef
 {
   /**
-   * Component name. NULL means that this definition matches any component
-   */
-  char *component;
-
-  /**
-   * File name. NULL means that this definition matches any file
+   * Component name regex
    */
-  char *file;
+  regex_t component_regex;
 
   /**
-   * Stores strlen(file)
+   * File name regex
    */
-  int strlen_file;
+  regex_t file_regex;
 
   /**
-   * Function name. NULL means that this definition matches any function
+   * Function name regex
    */
-  char *function;
+  regex_t function_regex;
 
   /**
    * Lowest line at which this definition matches.
@@ -251,6 +248,7 @@ get_type (const char *log)
     return GNUNET_ERROR_TYPE_NONE;
   return GNUNET_ERROR_TYPE_INVALID;
 }
+
 #if !defined(GNUNET_CULL_LOGGING)
 /**
  * Utility function - reallocates logdefs array to be twice as large.
@@ -258,10 +256,24 @@ get_type (const char *log)
 static void
 resize_logdefs ()
 {
-  logdefs_size  = (logdefs_size + 1) * 2;
-  logdefs = GNUNET_realloc (logdefs, logdefs_size * sizeof (struct LogDef));  
+  logdefs_size = (logdefs_size + 1) * 2;
+  logdefs = GNUNET_realloc (logdefs, logdefs_size * sizeof (struct LogDef));
 }
 
+
+/**
+ * Abort the process, generate a core dump if possible.
+ */
+void
+GNUNET_abort ()
+{
+#if WINDOWS
+  DebugBreak();
+#endif
+  abort();
+}
+
+
 /**
  * Utility function - adds a parsed definition to logdefs array.
  *
@@ -272,28 +284,48 @@ resize_logdefs ()
  * @param to_line see struct LogDef
  * @param level see struct LogDef, must be >= 0
  * @param force see struct LogDef
+ * @return 0 on success, regex-specific error otherwise
  */
-static void
-add_definition (char *component, char *file, char *function, int from_line, int to_line, int level, int force)
+static int
+add_definition (char *component, char *file, char *function, int from_line,
+                int to_line, int level, int force)
 {
+  struct LogDef n;
+  int r;
   if (logdefs_size == logdefs_len)
     resize_logdefs ();
-  struct LogDef n;
   memset (&n, 0, sizeof (n));
-  if (strlen (component) > 0 && component[0] != '*')
-    n.component = strdup (component);
-  if (strlen (file) > 0 && file[0] != '*')
-  {
-    n.file = strdup (file);
-    n.strlen_file = strlen (file);
-  }
-  if (strlen (function) > 0 && function[0] != '*')
-    n.function = strdup (function);
+  if (strlen (component) == 0)
+    component = (char *) ".*";
+  r = regcomp (&n.component_regex, (const char *) component, REG_NOSUB);
+  if (r != 0)
+    {
+      return r;
+    }
+  if (strlen (file) == 0)
+    file = (char *) ".*";
+  r = regcomp (&n.file_regex, (const char *) file, REG_NOSUB);
+  if (r != 0)
+    {
+      regfree (&n.component_regex);
+      return r;
+    }
+  if ( (NULL == function) ||
+       (strlen (function) == 0))
+    function = (char *) ".*";
+  r = regcomp (&n.function_regex, (const char *) function, REG_NOSUB);
+  if (r != 0)
+    {
+      regfree (&n.component_regex);
+      regfree (&n.file_regex);
+      return r;
+    }
   n.from_line = from_line;
   n.to_line = to_line;
   n.level = level;
   n.force = force;
   logdefs[logdefs_len++] = n;
+  return 0;
 }
 
 
@@ -310,13 +342,13 @@ add_definition (char *component, char *file, char *function, int from_line, int
  * @param line line at which the call is made, usually __LINE__
  * @return 0 to disallow the call, 1 to allow it
  */
-int 
-GNUNET_get_log_call_status (int caller_level, const char *comp, const char *file, const char *function, int line)
+int
+GNUNET_get_log_call_status (int caller_level, const char *comp,
+                            const char *file, const char *function, int line)
 {
   struct LogDef *ld;
   int i;
   int force_only;
-  size_t strlen_file;
 
   if (comp == NULL)
     /* Use default component */
@@ -330,22 +362,18 @@ GNUNET_get_log_call_status (int caller_level, const char *comp, const char *file
 
   /* Only look for forced definitions? */
   force_only = min_level >= 0;
-  strlen_file = strlen (file);
   for (i = 0; i < logdefs_len; i++)
   {
-    ld = &logdefs[i];
-    if ((!force_only || ld->force) &&
-        (line >= ld->from_line && line <= ld->to_line) &&
-        (ld->component == NULL || strcmp (comp, ld->component) == 0) &&
-        (ld->file == NULL ||
-         (ld->strlen_file <= strlen_file &&
-          strcmp (&file[strlen_file - ld->strlen_file], ld->file) == 0)) &&
-        (ld->function == NULL || strcmp (function, ld->function) == 0)
-       )
-    {
-      /* We're finished */
-      return caller_level <= ld->level;
-    }
+      ld = &logdefs[i];
+      if ((!force_only || ld->force) &&
+         (line >= ld->from_line && line <= ld->to_line) &&
+         (regexec (&ld->component_regex, comp, 0, NULL, 0) == 0) &&
+         (regexec (&ld->file_regex, file, 0, NULL, 0) == 0) &&
+         (regexec (&ld->function_regex, function, 0, NULL, 0) == 0))
+       {
+         /* We're finished */
+         return caller_level <= ld->level;
+       }
   }
   /* No matches - use global level, if defined */
   if (min_level >= 0)
@@ -396,90 +424,93 @@ parse_definitions (const char *constname, int force)
   int from_line, to_line;
   int counter = 0;
   int keep_looking = 1;
+
   tmp = getenv (constname);
   if (tmp == NULL)
     return 0;
-  def = strdup (tmp);
+  def = GNUNET_strdup (tmp);
   level = -1;
   from_line = 0;
   to_line = INT_MAX;
   for (p = def, state = 0, start = def; keep_looking; p++)
   {
-    switch (p[0])
-    {
-    case ';': /* found a field separator */
-      p[0] = '\0';
-      switch (state)
-      {
-      case 0: /* within a component name */
-        comp = start;
-        break;
-      case 1: /* within a file name */
-        file = start;
-        break;
-      case 2: /* within a function name */
-        /* after a file name there must be a function name */
-        function = start;
-        break;
-      case 3: /* within a from-to line range */
-        if (strlen (start) > 0)
-        {
-          errno = 0;
-          from_line = strtol (start, &t, 10);
-          if (errno != 0 || from_line < 0)
-          {
-            free (def);
-            return counter;
-          }
-          if (t < p && t[0] == '-')
-          {
-            errno = 0;
-            start = t + 1;
-            to_line = strtol (start, &t, 10);
-            if (errno != 0 || to_line < 0 || t != p)
-            {
-              free (def);
-              return counter;
-            }
-          }
-          else /* one number means "match this line only" */
-            to_line = from_line;
-        }
-        else /* default to 0-max */
-        {
-          from_line = 0;
-          to_line = INT_MAX;
-        }
-        break;
-      }
-      start = p + 1;
-      state += 1;
-      break;
-    case '\0': /* found EOL */
-      keep_looking = 0;
-      /* fall through to '/' */
-    case '/': /* found a definition separator */
-      switch (state)
-      {
-      case 4: /* within a log level */
-        p[0] = '\0';
-        state = 0;
-        level = get_type ((const char *) start);
-        if (level == GNUNET_ERROR_TYPE_INVALID || level == GNUNET_ERROR_TYPE_UNSPECIFIED)
-        {
-          free (def);
-          return counter;
-        }
-        add_definition (comp, file, function, from_line, to_line, level, force);
-        counter += 1;
-        start = p + 1;
-        break;
-      default:
-        break;
-      }
-    default:
-      break;
-    }
+      switch (p[0])
+       {
+       case ';':               /* found a field separator */
+         p[0] = '\0';
+         switch (state)
+           {
+           case 0:             /* within a component name */
+             comp = start;
+             break;
+           case 1:             /* within a file name */
+             file = start;
+             break;
+           case 2:             /* within a function name */
+             /* after a file name there must be a function name */
+             function = start;
+             break;
+           case 3:             /* within a from-to line range */
+             if (strlen (start) > 0)
+               {
+                 errno = 0;
+                 from_line = strtol (start, &t, 10);
+                 if (errno != 0 || from_line < 0)
+                   {
+                     free (def);
+                     return counter;
+                   }
+                 if (t < p && t[0] == '-')
+                   {
+                     errno = 0;
+                     start = t + 1;
+                     to_line = strtol (start, &t, 10);
+                     if (errno != 0 || to_line < 0 || t != p)
+                       {
+                         free (def);
+                         return counter;
+                       }
+                   }
+                 else          /* one number means "match this line only" */
+                   to_line = from_line;
+               }
+             else              /* default to 0-max */
+               {
+                 from_line = 0;
+                 to_line = INT_MAX;
+               }
+             break;
+           }
+         start = p + 1;
+         state += 1;
+         break;
+       case '\0':              /* found EOL */
+         keep_looking = 0;
+         /* fall through to '/' */
+       case '/':               /* found a definition separator */
+         switch (state)
+           {
+           case 4:             /* within a log level */
+             p[0] = '\0';
+             state = 0;
+             level = get_type ((const char *) start);
+             if (level == GNUNET_ERROR_TYPE_INVALID
+                 || level == GNUNET_ERROR_TYPE_UNSPECIFIED
+                 || 0 != add_definition (comp, file, function, from_line,
+                                          to_line, level, force))
+               {
+                 free (def);
+                 return counter;
+               }
+             counter += 1;
+             start = p + 1;
+             break;
+           default:
+             break;
+           }
+       default:
+         break;
+       }
   }
   free (def);
   return counter;
@@ -495,7 +526,8 @@ parse_all_definitions ()
     parse_definitions ("GNUNET_LOG", 0);
   gnunet_log_parsed = GNUNET_YES;
   if (gnunet_force_log_parsed == GNUNET_NO)
-    gnunet_force_log_present = parse_definitions ("GNUNET_FORCE_LOG", 1) > 0 ? GNUNET_YES : GNUNET_NO;
+    gnunet_force_log_present =
+        parse_definitions ("GNUNET_FORCE_LOG", 1) > 0 ? GNUNET_YES : GNUNET_NO;
   gnunet_force_log_parsed = GNUNET_YES;
 }
 #endif
@@ -525,10 +557,11 @@ GNUNET_log_setup (const char *comp, const char *loglevel, const char *logfile)
   GNUNET_free_non_null (component);
   GNUNET_asprintf (&component, "%s-%d", comp, getpid ());
   GNUNET_free_non_null (component_nopid);
-  component_nopid = strdup (comp);
+  component_nopid = GNUNET_strdup (comp);
 
   env_logfile = getenv ("GNUNET_FORCE_LOGFILE");
-  if (env_logfile != NULL)
+  if ( (env_logfile != NULL) &&
+       (strlen (env_logfile) > 0) )
     logfile = env_logfile;
 
   if (logfile == NULL)
@@ -712,56 +745,56 @@ mylog (enum GNUNET_ErrorType kind, const char *comp, const char *message,
   struct timeval timeofday;
   struct tm *tmptr;
   size_t size;
-  char *buf;
   va_list vacp;
 
   va_copy (vacp, va);
   size = VSNPRINTF (NULL, 0, message, vacp) + 1;
+  GNUNET_assert (0 != size);
   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);
-  gettimeofday (&timeofday, NULL);
-  if (NULL != tmptr)
   {
+    char buf[size];
+
+    VSNPRINTF (buf, size, message, va);
+    time (&timetmp);
+    memset (date, 0, DATE_STR_SIZE);
+    tmptr = localtime (&timetmp);
+    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)));
+      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);
+      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.abs_value != 0) &&
+        (0 == strncmp (buf, last_bulk, sizeof (last_bulk))))
+    {
+      last_bulk_repeat++;
+      if ((GNUNET_TIME_absolute_get_duration (last_bulk_time).rel_value >
+           BULK_DELAY_THRESHOLD) || (last_bulk_repeat > BULK_REPEAT_THRESHOLD))
+        flush_bulk (date);
+      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 ();
+    strncpy (last_bulk_comp, comp, COMP_TRACK_SIZE);
+    output_message (kind, comp, date, buf);
   }
-  else
-    strcpy (date, "localtime error");
-  if ((0 != (kind & GNUNET_ERROR_TYPE_BULK)) && (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).rel_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 ();
-  strncpy (last_bulk_comp, comp, COMP_TRACK_SIZE);
-  output_message (kind, comp, date, buf);
-  free (buf);
 }
 
 
@@ -794,7 +827,7 @@ GNUNET_log_nocheck (enum GNUNET_ErrorType kind, const char *message, ...)
  */
 void
 GNUNET_log_from_nocheck (enum GNUNET_ErrorType kind, const char *comp,
-                 const char *message, ...)
+                         const char *message, ...)
 {
   va_list va;
   char comp_w_pid[128];