init

src/util/u_debug.c

@@ -0,0 +1,539 @@
+/**************************************************************************
+ *
+ * Copyright 2008 VMware, Inc.
+ * Copyright (c) 2008 VMware, Inc.
+ * All Rights Reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sub license, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the
+ * next paragraph) shall be included in all copies or substantial portions
+ * of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
+ * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
+ * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ **************************************************************************/
+
+#include "util/u_atomic.h"
+#include "util/u_debug.h"
+#include "util/u_string.h"
+#include "util/u_math.h"
+#include "c11/threads.h"
+#include <inttypes.h>
+
+#include <stdio.h>
+#include <limits.h> /* CHAR_BIT */
+#include <ctype.h> /* isalnum */
+
+#ifdef _WIN32
+#include <windows.h>
+#include <stdlib.h>
+#endif
+
+
+void
+_debug_vprintf(const char *format, va_list ap)
+{
+   static char buf[4096] = {'\0'};
+#if DETECT_OS_WINDOWS
+   /* We buffer until we find a newline. */
+   size_t len = strlen(buf);
+   int ret = vsnprintf(buf + len, sizeof(buf) - len, format, ap);
+   if (ret > (int)(sizeof(buf) - len - 1) || strchr(buf + len, '\n')) {
+      os_log_message(buf);
+      buf[0] = '\0';
+   }
+#else
+   vsnprintf(buf, sizeof(buf), format, ap);
+   os_log_message(buf);
+#endif
+}
+
+
+void
+_util_debug_message(struct util_debug_callback *cb,
+                    unsigned *id,
+                    enum util_debug_type type,
+                    const char *fmt, ...)
+{
+   if (!cb || !cb->debug_message)
+      return;
+   va_list args;
+   va_start(args, fmt);
+   cb->debug_message(cb->data, id, type, fmt, args);
+   va_end(args);
+}
+
+
+#ifdef _WIN32
+void
+debug_disable_win32_error_dialogs(void)
+{
+   /* When Windows' error message boxes are disabled for this process (as is
+    * typically the case when running tests in an automated fashion) we disable
+    * CRT message boxes too.
+    */
+   UINT uMode = SetErrorMode(0);
+   SetErrorMode(uMode);
+#ifndef _GAMING_XBOX
+   if (uMode & SEM_FAILCRITICALERRORS) {
+      /* Disable assertion failure message box.
+       * http://msdn.microsoft.com/en-us/library/sas1dkb2.aspx
+       */
+      _set_error_mode(_OUT_TO_STDERR);
+#ifdef _MSC_VER
+      /* Disable abort message box.
+       * http://msdn.microsoft.com/en-us/library/e631wekh.aspx
+       */
+      _set_abort_behavior(0, _WRITE_ABORT_MSG | _CALL_REPORTFAULT);
+#endif
+   }
+#endif /* _GAMING_XBOX */
+}
+#endif /* _WIN32 */
+
+bool
+debug_parse_bool_option(const char *str, bool dfault)
+{
+   bool result;
+
+   if (str == NULL)
+      result = dfault;
+   else if (!strcmp(str, "0"))
+      result = false;
+   else if (!strcasecmp(str, "n"))
+      result = false;
+   else if (!strcasecmp(str, "no"))
+      result = false;
+   else if (!strcasecmp(str, "f"))
+      result = false;
+   else if (!strcasecmp(str, "false"))
+      result = false;
+   else if (!strcmp(str, "1"))
+      result = true;
+   else if (!strcasecmp(str, "y"))
+      result = true;
+   else if (!strcasecmp(str, "yes"))
+      result = true;
+   else if (!strcasecmp(str, "t"))
+      result = true;
+   else if (!strcasecmp(str, "true"))
+      result = true;
+   else
+      result = dfault;
+   return result;
+}
+
+static bool
+debug_get_option_should_print(void)
+{
+   static bool initialized = false;
+   static bool value = false;
+
+   if (unlikely(!p_atomic_read_relaxed(&initialized))) {
+      bool parsed_value = debug_parse_bool_option(os_get_option("GALLIUM_PRINT_OPTIONS"), false);
+      p_atomic_set(&value, parsed_value);
+      p_atomic_set(&initialized, true);
+   }
+
+   /* We do not print value of GALLIUM_PRINT_OPTIONS intentionally. */
+   return value;
+}
+
+
+const char *
+debug_get_option(const char *name, const char *dfault)
+{
+   const char *result;
+
+   result = os_get_option(name);
+   if (!result)
+      result = dfault;
+
+   if (debug_get_option_should_print())
+      debug_printf("%s: %s = %s\n", __func__, name,
+                   result ? result : "(null)");
+
+   return result;
+}
+
+
+const char *
+debug_get_option_cached(const char *name, const char *dfault)
+{
+   const char *result;
+
+   result = os_get_option_cached(name);
+   if (!result)
+      result = dfault;
+
+   if (debug_get_option_should_print())
+      debug_printf("%s: %s = %s\n", __FUNCTION__, name,
+                   result ? result : "(null)");
+
+   return result;
+}
+
+
+/**
+ * Reads an environment variable and interprets its value as a boolean.
+ * Recognizes 0/n/no/f/false case insensitive as false.
+ * Recognizes 1/y/yes/t/true case insensitive as true.
+ * Other values result in the default value.
+ */
+bool
+debug_get_bool_option(const char *name, bool dfault)
+{
+   bool result = debug_parse_bool_option(os_get_option(name), dfault);
+   if (debug_get_option_should_print())
+      debug_printf("%s: %s = %s\n", __func__, name,
+                   result ? "TRUE" : "FALSE");
+
+   return result;
+}
+
+
+int64_t
+debug_parse_num_option(const char *str, int64_t dfault)
+{
+   int64_t result;
+   if (!str) {
+      result = dfault;
+   } else {
+      char *endptr;
+
+      result = strtoll(str, &endptr, 0);
+      if (str == endptr) {
+         /* Restore the default value when no digits were found. */
+         result = dfault;
+      }
+   }
+   return result;
+}
+
+int64_t
+debug_get_num_option(const char *name, int64_t dfault)
+{
+   int64_t result = debug_parse_num_option(os_get_option(name), dfault);
+
+   if (debug_get_option_should_print())
+      debug_printf("%s: %s = %"PRId64"\n", __func__, name, result);
+
+   return result;
+}
+
+void
+debug_get_version_option(const char *name, unsigned *major, unsigned *minor)
+{
+   const char *str;
+
+   str = os_get_option(name);
+   if (str) {
+      unsigned v_maj, v_min;
+      int n;
+
+      n = sscanf(str, "%u.%u", &v_maj, &v_min);
+      if (n != 2) {
+         debug_printf("Illegal version specified for %s : %s\n", name, str);
+         return;
+      }
+      *major = v_maj;
+      *minor = v_min;
+   }
+
+   if (debug_get_option_should_print())
+      debug_printf("%s: %s = %u.%u\n", __func__, name, *major, *minor);
+
+   return;
+}
+
+static bool
+str_has_option(const char *str, const char *name)
+{
+   /* Empty string. */
+   if (!*str) {
+      return false;
+   }
+
+   /* OPTION=all */
+   if (!strcmp(str, "all")) {
+      return true;
+   }
+
+   /* Find 'name' in 'str' surrounded by non-alphanumeric characters. */
+   {
+      const char *start = str;
+      unsigned name_len = strlen(name);
+
+      /* 'start' is the beginning of the currently-parsed word,
+       * we increment 'str' each iteration.
+       * if we find either the end of string or a non-alphanumeric character,
+       * we compare 'start' up to 'str-1' with 'name'. */
+
+      while (1) {
+         if (!*str || !(isalnum(*str) || *str == '_')) {
+            if (str-start == name_len &&
+                !memcmp(start, name, name_len)) {
+               return true;
+            }
+
+            if (!*str) {
+               return false;
+            }
+
+            start = str+1;
+         }
+
+         str++;
+      }
+   }
+
+   return false;
+}
+
+
+uint64_t
+debug_parse_flags_option(const char *name,
+                         const char *str,
+                         const struct debug_named_value *flags,
+                         uint64_t dfault)
+{
+   uint64_t result;
+   const struct debug_named_value *orig = flags;
+   unsigned namealign = 0;
+
+   if (!str)
+      result = dfault;
+   else if (!strcmp(str, "help")) {
+      result = dfault;
+      _debug_printf("%s: help for %s:\n", __func__, name);
+      for (; flags->name; ++flags)
+         namealign = MAX2(namealign, strlen(flags->name));
+      for (flags = orig; flags->name; ++flags)
+         _debug_printf("| %*s [0x%0*"PRIx64"]%s%s\n", namealign, flags->name,
+                      (int)sizeof(uint64_t)*CHAR_BIT/4, flags->value,
+                      flags->desc ? " " : "", flags->desc ? flags->desc : "");
+   }
+   else {
+      result = 0;
+      while (flags->name) {
+         if (str_has_option(str, flags->name))
+            result |= flags->value;
+         ++flags;
+      }
+   }
+
+   return result;
+}
+
+uint64_t
+debug_get_flags_option(const char *name,
+                       const struct debug_named_value *flags,
+                       uint64_t dfault)
+{
+   const char *str = os_get_option(name);
+   uint64_t result = debug_parse_flags_option(name, str, flags, dfault);
+
+   if (debug_get_option_should_print()) {
+      if (str) {
+         debug_printf("%s: %s = 0x%"PRIx64" (%s)\n",
+                      __func__, name, result, str);
+      } else {
+         debug_printf("%s: %s = 0x%"PRIx64"\n", __func__, name, result);
+      }
+   }
+
+   return result;
+}
+
+
+const char *
+debug_dump_enum(const struct debug_named_value *names,
+                uint64_t value)
+{
+   static char rest[64];
+
+   while (names->name) {
+      if (names->value == value)
+         return names->name;
+      ++names;
+   }
+
+   snprintf(rest, sizeof(rest), "0x%08"PRIx64, value);
+   return rest;
+}
+
+
+const char *
+debug_dump_flags(const struct debug_named_value *names, uint64_t value)
+{
+   static thread_local char output[4096];
+   static thread_local char rest[256];
+   int first = 1;
+
+   output[0] = '\0';
+
+   while (names->name) {
+      if ((names->value & value) == names->value) {
+         if (!first)
+            strncat(output, "|", sizeof(output) - strlen(output) - 1);
+         else
+            first = 0;
+         strncat(output, names->name, sizeof(output) - strlen(output) - 1);
+         output[sizeof(output) - 1] = '\0';
+         value &= ~names->value;
+      }
+      ++names;
+   }
+
+   if (value) {
+      if (!first)
+         strncat(output, "|", sizeof(output) - strlen(output) - 1);
+      else
+         first = 0;
+
+      snprintf(rest, sizeof(rest), "0x%08"PRIx64, value);
+      strncat(output, rest, sizeof(output) - strlen(output) - 1);
+      output[sizeof(output) - 1] = '\0';
+   }
+
+   if (first)
+      return "0";
+
+   return output;
+}
+
+
+uint64_t
+parse_debug_string(const char *debug,
+                   const struct debug_control *control)
+{
+   uint64_t flag = 0;
+
+   if (debug != NULL) {
+      for (; control->string != NULL; control++) {
+         const char *s = debug;
+         unsigned n;
+
+         for (; n = strcspn(s, ", \n"), *s; s += MAX2(1, n)) {
+            if (!n)
+               continue;
+
+            if (!strncmp("all", s, n) ||
+                (strlen(control->string) == n &&
+                !strncmp(control->string, s, n)))
+               flag |= control->flag;
+         }
+      }
+   }
+
+   return flag;
+}
+
+
+uint64_t
+parse_enable_string(const char *debug,
+                    uint64_t default_value,
+                    const struct debug_control *control)
+{
+   uint64_t flag = default_value;
+
+   if (debug != NULL) {
+      const char *s = debug;
+      unsigned n;
+
+      for (; n = strcspn(s, ", \n"), *s; s += MAX2(1, n)) {
+         bool enable;
+         if (s[0] == '+') {
+            enable = true;
+            s++; n--;
+         } else if (s[0] == '-') {
+            enable = false;
+            s++; n--;
+         } else {
+            enable = true;
+         }
+         if (!strncmp(s, "all", 3)) {
+            if (enable)
+               flag = ~0ull;
+            else
+               flag = 0;
+         } else {
+            for (const struct debug_control *c = control; c->string != NULL; c++) {
+               if (strlen(c->string) == n &&
+                   !strncmp(c->string, s, n)) {
+                  if (enable)
+                     flag |= c->flag;
+                  else
+                     flag &= ~c->flag;
+               }
+            }
+         }
+      }
+   }
+
+   return flag;
+}
+
+
+bool
+comma_separated_list_contains(const char *list, const char *s)
+{
+   assert(list);
+   const size_t len = strlen(s);
+
+   for (unsigned n; n = strcspn(list, ","), *list; list += MAX2(1, n)) {
+      if (n == len && !strncmp(list, s, n))
+         return true;
+   }
+
+   return false;
+}
+
+void
+dump_debug_control_string(char *output,
+                          size_t max_size,
+                          const struct debug_control *control,
+                          uint64_t flags)
+{
+   size_t pos = 0;
+   int ret;
+   bool first = true;
+
+   for (const struct debug_control *c = control; c->string != NULL; c++) {
+      if (!(flags & c->flag))
+         continue;
+      ret = snprintf(output + pos, max_size - pos,
+                     first ? "%s" : "|%s", c->string);
+      if (ret < 0 || ret >= max_size - pos) {
+         output[max_size-3] = output[max_size-2] = '.';
+         output[max_size-1] = '\0';
+         return;
+      }
+
+      pos += ret;
+      first = false;
+      flags &= ~(c->flag);
+   }
+
+   if (flags) {
+      ret = snprintf(output + pos, max_size - pos,
+                     first ? "0x%" PRIx64 : "|0x%" PRIx64, flags);
+      if (ret < 0 || ret >= max_size - pos) {
+         output[max_size-3] = output[max_size-2] = '.';
+         output[max_size-1] = '\0';
+      }
+   }
+}