[tracker-miners/sam/debug: 1/4] Add TRACKER_DEBUG environment variable, use for miner fs debug

[Sam Thursfield <sthursfield src gnome org>]

commit eca7fbe1422ce50d6d3db9468f1c88e1e21a4065
Author: Sam Thursfield <sam afuera me uk>
Date:   Mon Apr 20 02:13:57 2020 +0200

    Add TRACKER_DEBUG environment variable, use for miner fs debug
    
    This works the same as GTK's GTK_DEBUG variable. It will
    allow us to include more types of optional debugging info
    and will make the default debug output more readlable.

 .gitlab-ci.yml                                |  4 ++
 meson.build                                   | 13 +++++++
 src/libtracker-miner/tracker-miner-fs.c       | 56 ++++++++++++++-------------
 src/libtracker-miners-common/meson.build      |  1 +
 src/libtracker-miners-common/tracker-common.h |  2 +
 5 files changed, 50 insertions(+), 26 deletions(-)
---
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index da3352fc5..f442a392f 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -4,6 +4,8 @@
 variables:
   # These can be used to see verbose log output from the functional-tests.
   # See HACKING.md for more information.
+  G_MESSAGES_DEBUG: "Tracker"
+  TRACKER_DEBUG: ""
   TRACKER_VERBOSITY: "1"
   TRACKER_TESTS_VERBOSE: "no"
 
@@ -40,6 +42,8 @@ stages:
       echo
       echo "Test suite settings:"
       echo
+      echo "G_MESSAGES_DEBUG: ${G_MESSAGES_DEBUG}"
+      echo "TRACKER_DEBUG: ${TRACKER_DEBUG}"
       echo "TRACKER_VERBOSITY: ${TRACKER_VERBOSITY}"
       echo "TRACKER_TESTS_VERBOSE: ${TRACKER_TESTS_VERBOSE}"
       echo "MESON_TEST_EXTRA_ARGS: ${MESON_TEST_EXTRA_ARGS}"
diff --git a/meson.build b/meson.build
index 04b82d9f7..3d8afa9c9 100644
--- a/meson.build
+++ b/meson.build
@@ -120,6 +120,19 @@ add_project_arguments('-Wno-pointer-sign', language: 'c')
 add_project_arguments('-DTRACKER_COMPILATION', language: 'c')
 add_project_arguments('-DG_LOG_DOMAIN="Tracker"', language: 'c')
 
+debug_cflags = []
+buildtype = get_option('buildtype')
+if buildtype.startswith('debug')
+  debug_cflags += '-DG_ENABLE_DEBUG'
+  if buildtype == 'debug'
+    debug_cflags += '-DG_ENABLE_CONSISTENCY_CHECKS'
+  endif
+elif buildtype == 'release'
+  debug_cflags += '-DG_DISABLE_CAST_CHECKS'
+endif
+
+add_project_arguments(debug_cflags, language: 'c')
+
 ##################################################################
 # Check for libtracker-common: battery/mains power detection
 #
diff --git a/src/libtracker-miner/tracker-miner-fs.c b/src/libtracker-miner/tracker-miner-fs.c
index 24e5c405f..0cd4f3177 100644
--- a/src/libtracker-miner/tracker-miner-fs.c
+++ b/src/libtracker-miner/tracker-miner-fs.c
@@ -30,32 +30,6 @@
 #include "tracker-sparql-buffer.h"
 #include "tracker-file-notifier.h"
 
-/* If defined will print push/pop actions on queues */
-#ifdef EVENT_QUEUE_ENABLE_TRACE
-#warning Event Queue traces enabled
-#define EVENT_QUEUE_LOG_PREFIX "[Event Queues] "
-#define EVENT_QUEUE_STATUS_TIMEOUT_SECS 30
-#define trace_eq(message, ...) g_message (EVENT_QUEUE_LOG_PREFIX message, ##__VA_ARGS__)
-#define trace_eq_event(event) \
-       do { \
-               const gchar *event_type_name[] = { "CREATED", "UPDATED", "DELETED", "MOVED" }; \
-               gchar *uri1 = g_file_get_uri (event->file); \
-               gchar *uri2 = event->dest_file ? g_file_get_uri (event->dest_file) : NULL; \
-               g_message ("%s New %s event: %s%s%s%s", \
-                          EVENT_QUEUE_LOG_PREFIX, \
-                          event_type_name[event->type], \
-                          event->attributes_update ? "(attributes only) " : "", \
-                          uri1, \
-                          uri2 ? "->" : "", \
-                          uri2 ? uri2 : ""); \
-               g_free (uri1); \
-               g_free (uri2); \
-       } while (0)
-#else
-#define trace_eq(...)
-#define trace_eq_event(...)
-#endif /* EVENT_QUEUE_ENABLE_TRACE */
-
 /* Default processing pool limits to be set */
 #define DEFAULT_WAIT_POOL_LIMIT 1
 #define DEFAULT_READY_POOL_LIMIT 1
@@ -299,6 +273,36 @@ G_DEFINE_ABSTRACT_TYPE_WITH_CODE (TrackerMinerFS, tracker_miner_fs, TRACKER_TYPE
                                   G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE,
                                                          miner_fs_initable_iface_init));
 
+/* For TRACKER_DEBUG=miner-fs-events */
+#ifdef G_ENABLE_DEBUG
+#define EVENT_QUEUE_LOG_PREFIX "[Event Queues] "
+#define EVENT_QUEUE_STATUS_TIMEOUT_SECS 30
+
+static void
+debug_print_event (QueueEvent *event)
+{
+       const gchar *event_type_name[] = { "CREATED", "UPDATED", "DELETED", "MOVED" };
+       gchar *uri1 = g_file_get_uri (event->file);
+       gchar *uri2 = event->dest_file ? g_file_get_uri (event->dest_file) : NULL;
+       g_message ("%s New %s event: %s%s%s%s",
+                   EVENT_QUEUE_LOG_PREFIX,
+                   event_type_name[event->type],
+                   event->attributes_update ? "(attributes only) " : "",
+                   uri1,
+                   uri2 ? "->" : "",
+                   uri2 ? uri2 : "");
+       g_free (uri1);
+       g_free (uri2);
+}
+
+#define trace_eq(message, ...) TRACKER_NOTE (MINER_FS_EVENTS, g_message (EVENT_QUEUE_LOG_PREFIX message, 
##__VA_ARGS__))
+#define trace_eq_event(event) TRACKER_NOTE (MINER_FS_EVENTS, debug_print_event (event));
+
+#else
+#define trace_eq(...)
+#define trace_eq_event(...)
+#endif /* G_ENABLE_DEBUG */
+
 static void
 tracker_miner_fs_class_init (TrackerMinerFSClass *klass)
 {
diff --git a/src/libtracker-miners-common/meson.build b/src/libtracker-miners-common/meson.build
index 1c29eef1b..ee0674262 100644
--- a/src/libtracker-miners-common/meson.build
+++ b/src/libtracker-miners-common/meson.build
@@ -10,6 +10,7 @@ tracker_miners_common_sources = [
   'tracker-date-time.c',
   'tracker-dbus.c',
   'tracker-domain-ontology.c',
+  'tracker-debug.c',
   'tracker-file-utils.c',
   'tracker-fts-config.c',
   'tracker-ioprio.c',
diff --git a/src/libtracker-miners-common/tracker-common.h b/src/libtracker-miners-common/tracker-common.h
index 062e73141..3723c2838 100644
--- a/src/libtracker-miners-common/tracker-common.h
+++ b/src/libtracker-miners-common/tracker-common.h
@@ -30,7 +30,9 @@
 
 #include "tracker-date-time.h"
 #include "tracker-dbus.h"
+#include "tracker-debug.h"
 #include "tracker-domain-ontology.h"
+#include "tracker-enums.h"
 #include "tracker-file-utils.h"
 #include "tracker-fts-config.h"
 #include "tracker-ioprio.h"