Mesa (main): egl: add config debug printout

GitLab Mirror gitlab-mirror at kemper.freedesktop.org
Sat Dec 11 00:54:07 UTC 2021


Module: Mesa
Branch: main
Commit: c02b75d22e6f3cdb82c4fbcb88e18d55aa9bb414
URL:    http://cgit.freedesktop.org/mesa/mesa/commit/?id=c02b75d22e6f3cdb82c4fbcb88e18d55aa9bb414

Author: Silvestrs Timofejevs <silvestrs.timofejevs at imgtec.com>
Date:   Tue Apr  2 16:36:22 2019 +0100

egl: add config debug printout

Feature to print out EGL returned configs for debug purposes.

'eglChooseConfig' and 'eglGetConfigs' debug information printout is
enabled when the log level equals '_EGL_DEBUG'. The configs are
printed, and if any of them are "chosen" they are marked with their
index in the chosen configs array.

v2:
   a) re-factor the code in line with review comments
   b) rename function _snprintfStrcat, split it out and put into the
      src/util/u_string.h, make it a separate patch.
v3:
   remove unnecessary 'const' qualifiers from the function prototype
v4:
   a) re-factor the code in line with review comments
   b) move util_strnappend from utils back to eglconfigdebug.c. In my
      opinion this function is the best way of achieving the desired
      result, so it still used but made private to eglconfigdebug.c.
v5:
   a) drop unused parameter from function signature
   b) more const annotations
   c) directly access config parameters instead of going
      through _eglGetConfigKey

Signed-off-by: Silvestrs Timofejevs <silvestrs.timofejevs at imgtec.com>
Signed-off-by: Lucas Stach <l.stach at pengutronix.de>
Reviewed-by: Eric Engestrom <eric at engestrom.ch>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/13705>

---

 src/egl/main/eglconfig.c      |  18 +++-
 src/egl/main/eglconfigdebug.c | 201 ++++++++++++++++++++++++++++++++++++++++++
 src/egl/main/eglconfigdebug.h |  47 ++++++++++
 src/egl/meson.build           |   2 +
 4 files changed, 264 insertions(+), 4 deletions(-)

diff --git a/src/egl/main/eglconfig.c b/src/egl/main/eglconfig.c
index 17d8f3555d4..eff7733c071 100644
--- a/src/egl/main/eglconfig.c
+++ b/src/egl/main/eglconfig.c
@@ -40,6 +40,7 @@
 #include "util/macros.h"
 
 #include "eglconfig.h"
+#include "eglconfigdebug.h"
 #include "egldisplay.h"
 #include "eglcurrent.h"
 #include "egllog.h"
@@ -794,14 +795,20 @@ _eglChooseConfig(_EGLDisplay *disp, const EGLint *attrib_list,
                  EGLConfig *configs, EGLint config_size, EGLint *num_configs)
 {
    _EGLConfig criteria;
+   EGLBoolean result;
 
    if (!_eglParseConfigAttribList(&criteria, disp, attrib_list))
       return _eglError(EGL_BAD_ATTRIBUTE, "eglChooseConfig");
 
-   return _eglFilterConfigArray(disp->Configs,
-         configs, config_size, num_configs,
-         _eglFallbackMatch, _eglFallbackCompare,
-         (void *) &criteria);
+   result = _eglFilterConfigArray(disp->Configs,
+                                  configs, config_size, num_configs,
+                                  _eglFallbackMatch, _eglFallbackCompare,
+                                  (void *) &criteria);
+
+   if (result && (_eglGetLogLevel() == _EGL_DEBUG))
+      eglPrintConfigDebug(disp, configs, *num_configs, EGL_TRUE);
+
+   return result;
 }
 
 
@@ -851,5 +858,8 @@ _eglGetConfigs(_EGLDisplay *disp, EGLConfig *configs,
    *num_config = _eglFlattenArray(disp->Configs, (void *) configs,
          sizeof(configs[0]), config_size, _eglFlattenConfig);
 
+   if (_eglGetLogLevel() == _EGL_DEBUG)
+      eglPrintConfigDebug(disp, configs, *num_config, EGL_FALSE);
+
    return EGL_TRUE;
 }
diff --git a/src/egl/main/eglconfigdebug.c b/src/egl/main/eglconfigdebug.c
new file mode 100644
index 00000000000..2e179936b9c
--- /dev/null
+++ b/src/egl/main/eglconfigdebug.c
@@ -0,0 +1,201 @@
+/*
+ * Copyright 2019 Imagination Technologies.
+ * All Rights Reserved.
+ *
+ * Based on eglinfo, which has copyright:
+ * Copyright (C) 2005  Brian Paul   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, sublicense,
+ * 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 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 NONINFRINGEMENT.  IN NO EVENT SHALL
+ * BRIAN PAUL 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 <stdlib.h>
+#include <string.h>
+#include <stdio.h>
+#include <stdarg.h>
+
+#include "eglarray.h"
+#include "eglconfig.h"
+#include "eglconfigdebug.h"
+#include "egldisplay.h"
+#include "egllog.h"
+#include "egltypedefs.h"
+#include "util/macros.h"
+
+/* Max debug message length */
+#define CONFIG_DEBUG_MSG_MAX 1000
+
+/*
+ * These are X visual types, so if you're running eglinfo under
+ * something not X, they probably don't make sense.
+ */
+static const char *const vnames[] = { "SG", "GS", "SC", "PC", "TC", "DC" };
+
+static void
+_printHeaderFormat(void)
+{
+   /*
+    * EGL configuration output legend:
+    *
+    * chosen --------------- eglChooseConfig returned config priority,
+    *                        only relevant when eglChooseConfig is called.
+    * id ------------------- EGL_CONFIG_ID
+    * bfsz ----------------- EGL_BUFFER_SIZE
+    * lvl ------------------ EGL_LEVEL
+    *
+    * colourbuffer
+    * r -------------------- EGL_RED_SIZE
+    * g -------------------- EGL_GREEN_SIZE
+    * b -------------------- EGL_BLUE_SIZE
+    * a -------------------- EGL_ALPHA_SIZE
+    * dpth ----------------- EGL_DEPTH_SIZE
+    * stcl ----------------- EGL_STENCIL_SIZE
+    *
+    * multisample
+    * ns ------------------- EGL_SAMPLES
+    * b -------------------- EGL_SAMPLE_BUFFERS
+    * visid ---------------- EGL_NATIVE_VISUAL_ID/EGL_NATIVE_VISUAL_TYPE
+    * caveat --------------- EGL_CONFIG_CAVEAT
+    * bind ----------------- EGL_BIND_TO_TEXTURE_RGB/EGL_BIND_TO_TEXTURE_RGBA
+    *
+    * renderable
+    * gl, es, es2, es3, vg - EGL_RENDERABLE_TYPE
+    *
+    * supported
+    * surfaces ------------- EGL_SURFACE_TYPE
+    */
+   _eglLog(_EGL_DEBUG, "---------------");
+   _eglLog(_EGL_DEBUG, "Configurations:");
+   _eglLog(_EGL_DEBUG, "cho       bf lv colourbuffer dp st  ms           vis  cav  bi     renderable           supported");
+   _eglLog(_EGL_DEBUG, "sen    id sz  l  r  g  b  a  th cl ns b           id  eat  nd  gl es es2 es3 vg         surfaces");
+   _eglLog(_EGL_DEBUG, "---------------");
+}
+
+/* Append a formatted string to the buffer, up to the buffer size */
+static inline void
+_strnAppend(char *const buf, const int bufSize, const char *fmt, ...)
+{
+   int maxAllowed;
+   va_list args;
+   size_t bufLen = strlen(buf);
+
+   maxAllowed = bufSize - bufLen;
+   assert(maxAllowed >= 0);
+
+   va_start(args, fmt);
+   (void) vsnprintf(&buf[bufLen], maxAllowed, fmt, args);
+   va_end(args);
+}
+
+static void
+_eglPrintConfig(_EGLConfig *const conf, const int chosenIndex)
+{
+   const char padding[] = "   ";
+   char printMsg[CONFIG_DEBUG_MSG_MAX] = "";
+   char surfString[32] = "";
+   EGLint renderable, surfaces, vtype, bindRgb, bindRgba;
+
+   vtype = conf->NativeVisualType;
+   surfaces = conf->SurfaceType;
+
+   STATIC_ASSERT(sizeof(surfString) >= sizeof("win,pb,pix,str,prsv"));
+
+   if (surfaces & EGL_WINDOW_BIT)
+      strcat(surfString, "win,");
+   if (surfaces & EGL_PBUFFER_BIT)
+      strcat(surfString, "pb,");
+   if (surfaces & EGL_PIXMAP_BIT)
+      strcat(surfString, "pix,");
+   if (surfaces & EGL_STREAM_BIT_KHR)
+      strcat(surfString, "str,");
+   if (surfaces & EGL_SWAP_BEHAVIOR_PRESERVED_BIT)
+      strcat(surfString, "prsv");
+
+   /* If one of chosen configs, print its index in the returned config array */
+   if (chosenIndex >= 0)
+      _strnAppend(printMsg, sizeof(printMsg), "%*d ", strlen(padding),
+                  chosenIndex);
+   else
+      _strnAppend(printMsg, sizeof(printMsg), "%s ", &padding[0]);
+
+   _strnAppend(printMsg, sizeof(printMsg),
+               "0x%03x %2d %2d %2d %2d %2d %2d  %2d %2d %2d%2d 0x%08x%2s     ",
+               conf->ConfigID, conf->BufferSize, conf->Level,
+               conf->RedSize, conf->GreenSize, conf->BlueSize, conf->AlphaSize,
+               conf->DepthSize, conf->StencilSize,
+               conf->Samples, conf->SampleBuffers, conf->NativeVisualID,
+               vtype < 6 ? vnames[vtype] : "--");
+
+   bindRgb = conf->BindToTextureRGB;
+   bindRgba = conf->BindToTextureRGBA;
+   renderable = conf->RenderableType;
+
+   _strnAppend(printMsg, sizeof(printMsg),
+               "%c  %c   %c  %c   %c   %c   %c %15s",
+               (conf->ConfigCaveat != EGL_NONE) ? 'y' : ' ',
+               (bindRgba) ? 'a' : (bindRgb) ? 'y' : ' ',
+               (renderable & EGL_OPENGL_BIT) ? 'y' : ' ',
+               (renderable & EGL_OPENGL_ES_BIT) ? 'y' : ' ',
+               (renderable & EGL_OPENGL_ES2_BIT) ? 'y' : ' ',
+               (renderable & EGL_OPENGL_ES3_BIT) ? 'y' : ' ',
+               (renderable & EGL_OPENVG_BIT) ? 'y' : ' ',
+               surfString);
+
+   _eglLog(_EGL_DEBUG, printMsg);
+}
+
+void eglPrintConfigDebug(const _EGLDisplay *const disp,
+                         const EGLConfig *const configs,
+                         const EGLint numConfigs, const EGLBoolean printChosen)
+{
+   EGLint numConfigsToPrint;
+   _EGLConfig **configsToPrint;
+   _EGLConfig **chosenConfigs;
+
+   if (!numConfigs || !configs) {
+      _eglLog(_EGL_DEBUG, "%s: nothing to print", __func__);
+      return;
+   }
+
+   /*
+    * If the printout request came from the 'eglChooseConfig', all
+    * configs are printed, and the "chosen" configs are marked.
+    */
+   if (printChosen) {
+      configsToPrint = (_EGLConfig **) disp->Configs->Elements;
+      numConfigsToPrint = disp->Configs->Size;
+      chosenConfigs = (_EGLConfig **) configs;
+   } else {
+      configsToPrint = (_EGLConfig **) configs;
+      numConfigsToPrint = numConfigs;
+      chosenConfigs = NULL;
+   }
+
+   _printHeaderFormat();
+   for (EGLint i = 0; i < numConfigsToPrint; i++) {
+      _EGLConfig *configToPrint = configsToPrint[i];
+      EGLint chosenIndex = -1;
+
+      /* See if the current config to print is one of the chosen configs */
+      if (chosenConfigs)
+         for (EGLint j = 0; j < numConfigs; j++)
+            if (configToPrint == chosenConfigs[j])
+               chosenIndex = j;
+
+      _eglPrintConfig(configToPrint, chosenIndex);
+   }
+}
diff --git a/src/egl/main/eglconfigdebug.h b/src/egl/main/eglconfigdebug.h
new file mode 100644
index 00000000000..929e5c4fb12
--- /dev/null
+++ b/src/egl/main/eglconfigdebug.h
@@ -0,0 +1,47 @@
+/**************************************************************************
+ * Copyright 2017 Imagination Technologies.
+ * 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 NONINFRINGEMENT.  IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS 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.
+ *
+ **************************************************************************/
+
+#ifndef EGLCONFIGDEBUG_INCLUDED
+#define EGLCONFIGDEBUG_INCLUDED
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include "egltypedefs.h"
+
+/**
+ * Print the list of configs and the associated attributes.
+ */
+void eglPrintConfigDebug(const _EGLDisplay *const disp,
+                         const EGLConfig *const configs,
+                         EGLint numConfigs, EGLBoolean printChosen);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* EGLCONFIGDEBUG_INCLUDED */
diff --git a/src/egl/meson.build b/src/egl/meson.build
index 65faf607705..315a95013f3 100644
--- a/src/egl/meson.build
+++ b/src/egl/meson.build
@@ -31,6 +31,8 @@ files_egl = files(
   'main/eglapi.c',
   'main/eglarray.c',
   'main/eglarray.h',
+  'main/eglconfigdebug.c',
+  'main/eglconfigdebug.h',
   'main/eglconfig.c',
   'main/eglconfig.h',
   'main/eglcontext.c',



More information about the mesa-commit mailing list