[Spice-devel] [PATCH spice-gtk v2] Remove unnecessary debug check from SPICE_DEBUG

[Jonathon Jongsma]

Calling spice_util_get_debug() from the SPICE_DEBUG() macro is
unnecessary since g_log() will already check whether the message will
actually be printed. The only benefit to calling this function from
SPICE_DEBUG() is that it ensures that the SPICE_DEBUG environment
variable gets read the very first time we try to log something with
this macro. To solve this problem we instead use a constructor function
to ensure that the env var is read at startup.

Signed-off-by: Jonathon Jongsma <jjongsma at redhat.com>
---
Changes since v1:
 - moved include down below system includes
 - removed GOnce
 - moved contents of getenv_debug() within constructor and removed that
   function.

 src/spice-util.c | 29 ++++++++++-------------------
 src/spice-util.h |  7 ++-----
 2 files changed, 12 insertions(+), 24 deletions(-)

diff --git a/src/spice-util.c b/src/spice-util.c
index 86377b6..df8c1de 100644
--- a/src/spice-util.c
+++ b/src/spice-util.c
@@ -24,6 +24,7 @@
 #include <glib.h>
 #include <glib-object.h>
 #include <spice/macros.h>
+#include "common/macros.h"
 #include "spice-util-priv.h"
 #include "spice-util.h"
 #include "spice-util-priv.h"
@@ -39,7 +40,7 @@
  * Various functions for debugging and informational purposes.
  */
 
-static GOnce debug_once = G_ONCE_INIT;
+static gboolean debug_enabled = FALSE;
 
 static void spice_util_enable_debug_messages(void)
 {
@@ -63,36 +64,26 @@ static void spice_util_enable_debug_messages(void)
  **/
 void spice_util_set_debug(gboolean enabled)
 {
-    /* Make sure debug_once has been initialised
-     * with the value of SPICE_DEBUG already, otherwise
-     * spice_util_get_debug() may overwrite the value
-     * that was just set using spice_util_set_debug()
-     */
-    spice_util_get_debug();
-
     if (enabled) {
         spice_util_enable_debug_messages();
     }
 
-    debug_once.retval = GINT_TO_POINTER(enabled);
+    debug_enabled = enabled;
 }
 
-static gpointer getenv_debug(gpointer data)
+/* Make sure debug_once has been initialised with the value of SPICE_DEBUG at
+ * startup, otherwise spice_util_get_debug() may overwrite the value that is
+ * set using spice_util_set_debug() */
+SPICE_CONSTRUCTOR_FUNC(spice_log_init)
 {
-    gboolean debug;
-
-    debug = (g_getenv("SPICE_DEBUG") != NULL);
-    if (debug)
+    debug_enabled = (g_getenv("SPICE_DEBUG") != NULL);
+    if (debug_enabled)
         spice_util_enable_debug_messages();
-
-    return GINT_TO_POINTER(debug);
 }
 
 gboolean spice_util_get_debug(void)
 {
-    g_once(&debug_once, getenv_debug, NULL);
-
-    return GPOINTER_TO_INT(debug_once.retval);
+    return debug_enabled;
 }
 
 /**
diff --git a/src/spice-util.h b/src/spice-util.h
index a2a7683..7a95a9e 100644
--- a/src/spice-util.h
+++ b/src/spice-util.h
@@ -32,11 +32,8 @@ gulong spice_g_signal_connect_object(gpointer instance,
                                      GConnectFlags connect_flags);
 gchar* spice_uuid_to_string(const guint8 uuid[16]);
 
-#define SPICE_DEBUG(fmt, ...)                                   \
-    do {                                                        \
-        if (G_UNLIKELY(spice_util_get_debug()))                 \
-            g_debug(G_STRLOC " " fmt, ## __VA_ARGS__);          \
-    } while (0)
+#define SPICE_DEBUG(fmt, ...) \
+    g_debug(G_STRLOC " " fmt, ## __VA_ARGS__)
 
 #define SPICE_RESERVED_PADDING (10 * sizeof(void*))
 
-- 
2.9.4