gallium: add async debug message forwarding helper

v2: use util_vasprintf for Windows portability

Reviewed-by: Marek Olšák <[email protected]> (v1)

4 files changed, 192 insertions, 0 deletions

diff --git a/src/gallium/auxiliary/Makefile.sources b/src/gallium/auxiliary/Makefile.sources
index 6ced02e966c..0502a2c44f8 100644
--- a/src/gallium/auxiliary/Makefile.sources
+++ b/src/gallium/auxiliary/Makefile.sources
@@ -184,6 +184,8 @@ C_SOURCES := \
 	translate/translate_generic.c \
 	translate/translate_sse.c \
 	util/dbghelp.h \
+	util/u_async_debug.h \
+	util/u_async_debug.c \
 	util/u_bitcast.h \
 	util/u_bitmask.c \
 	util/u_bitmask.h \
diff --git a/src/gallium/auxiliary/meson.build b/src/gallium/auxiliary/meson.build
index eed70647927..948fb86b3b2 100644
--- a/src/gallium/auxiliary/meson.build
+++ b/src/gallium/auxiliary/meson.build
@@ -204,6 +204,8 @@ files_libgallium = files(
   'translate/translate_generic.c',
   'translate/translate_sse.c',
   'util/dbghelp.h',
+  'util/u_async_debug.h',
+  'util/u_async_debug.c',
   'util/u_bitcast.h',
   'util/u_bitmask.c',
   'util/u_bitmask.h',
diff --git a/src/gallium/auxiliary/util/u_async_debug.c b/src/gallium/auxiliary/util/u_async_debug.c
new file mode 100644
index 00000000000..13791a578bf
--- /dev/null
+++ b/src/gallium/auxiliary/util/u_async_debug.c
@@ -0,0 +1,114 @@
+/*
+ * Copyright 2017 Advanced Micro Devices, 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
+ * on 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
+ * THE AUTHOR(S) AND/OR THEIR 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 "u_async_debug.h"
+
+#include <stdio.h>
+#include <stdarg.h>
+
+#include "util/u_debug.h"
+#include "util/u_string.h"
+
+static void
+u_async_debug_message(void *data, unsigned *id, enum pipe_debug_type type,
+                      const char *fmt, va_list args)
+{
+   struct util_async_debug_callback *adbg = data;
+   struct util_debug_message *msg;
+   char *text;
+   int r;
+
+   r = util_vasprintf(&text, fmt, args);
+   if (r < 0)
+      return;
+
+   simple_mtx_lock(&adbg->lock);
+   if (adbg->count >= adbg->max) {
+      unsigned new_max = MAX2(16, adbg->max * 2);
+
+      if (new_max < adbg->max ||
+          new_max > SIZE_MAX / sizeof(*adbg->messages)) {
+         free(text);
+         goto out;
+      }
+
+      struct util_debug_message *new_msg =
+         realloc(adbg->messages, new_max * sizeof(*adbg->messages));
+      if (!new_msg) {
+         free(text);
+         goto out;
+      }
+
+      adbg->max = new_max;
+      adbg->messages = new_msg;
+   }
+
+   msg = &adbg->messages[adbg->count++];
+   msg->id = id;
+   msg->type = type;
+   msg->msg = text;
+
+out:
+   simple_mtx_unlock(&adbg->lock);
+}
+
+void
+u_async_debug_init(struct util_async_debug_callback *adbg)
+{
+   memset(adbg, 0, sizeof(*adbg));
+
+   simple_mtx_init(&adbg->lock, mtx_plain);
+   adbg->base.async = true;
+   adbg->base.debug_message = u_async_debug_message;
+   adbg->base.data = adbg;
+}
+
+void
+u_async_debug_cleanup(struct util_async_debug_callback *adbg)
+{
+   simple_mtx_destroy(&adbg->lock);
+
+   for (unsigned i = 0; i < adbg->count; ++i)
+      free(adbg->messages[i].msg);
+   free(adbg->messages);
+}
+
+void
+_u_async_debug_drain(struct util_async_debug_callback *adbg,
+                     struct pipe_debug_callback *dst)
+{
+   simple_mtx_lock(&adbg->lock);
+   for (unsigned i = 0; i < adbg->count; ++i) {
+      const struct util_debug_message *msg = &adbg->messages[i];
+
+      _pipe_debug_message(dst, msg->id, msg->type, "%s", msg->msg);
+
+      free(msg->msg);
+   }
+
+   adbg->count = 0;
+   simple_mtx_unlock(&adbg->lock);
+}
+
diff --git a/src/gallium/auxiliary/util/u_async_debug.h b/src/gallium/auxiliary/util/u_async_debug.h
new file mode 100644
index 00000000000..be783dc87cb
--- /dev/null
+++ b/src/gallium/auxiliary/util/u_async_debug.h
@@ -0,0 +1,74 @@
+/*
+ * Copyright 2017 Advanced Micro Devices, 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
+ * on 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
+ * THE AUTHOR(S) AND/OR THEIR 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.
+ *
+ */
+
+/**
+ * \file u_async_debug.h
+ * Provides a helper implementation of pipe_debug_callback which allows debug
+ * messages from non-application threads to be passed back to the application
+ * thread.
+ */
+
+#ifndef UTIL_ASYNC_DEBUG_H
+#define UTIL_ASYNC_DEBUG_H
+
+#include "pipe/p_state.h"
+
+#include "util/simple_mtx.h"
+
+struct util_debug_message {
+   unsigned *id;
+   enum pipe_debug_type type;
+   char *msg;
+};
+
+struct util_async_debug_callback {
+   struct pipe_debug_callback base;
+
+   simple_mtx_t lock;
+   unsigned count;
+   unsigned max;
+   struct util_debug_message *messages;
+};
+
+void
+u_async_debug_init(struct util_async_debug_callback *adbg);
+void
+u_async_debug_cleanup(struct util_async_debug_callback *adbg);
+
+void
+_u_async_debug_drain(struct util_async_debug_callback *adbg,
+                     struct pipe_debug_callback *dst);
+
+static inline void
+u_async_debug_drain(struct util_async_debug_callback *adbg,
+                    struct pipe_debug_callback *dst)
+{
+   /* Read the count without taking the lock to avoid atomics in the fast path.
+    * We'll re-read the count after taking the lock. */
+   if (adbg->count)
+      _u_async_debug_drain(adbg, dst);
+}
+
+#endif /* UTIL_ASYNC_DEBUG_H */