PS-9148 feature: 8.4-specific DEBUG_SYNC improvements

https://perconadev.atlassian.net/browse/PS-9148

'DBUG_EXECUTE_IF()' / 'DEBUG_SYNC()' calls reworked with
'mysql_debug_keyword_service' / 'mysql_debug_sync_service' mysql service
calls (added in 8.4).

Author: percona-ysorokin

Diff for: components/masking_functions/src/component.cpp

@@ -24,7 +24,6 @@
 
 #include <boost/preprocessor/stringize.hpp>
 
-#include <my_dbug.h>
 #include <my_inttypes.h>
 #include <mysqld_error.h>
 
@@ -37,6 +36,10 @@
 #include <mysql/components/services/log_builtins.h>
 #include <mysql/components/services/mysql_command_services.h>  // IWYU pragma: keep
 #include <mysql/components/services/mysql_current_thread_reader.h>  // IWYU pragma: keep
+#ifndef NDEBUG
+#include <mysql/components/services/mysql_debug_keyword_service.h>
+#include <mysql/components/services/mysql_debug_sync_service.h>
+#endif
 #include <mysql/components/services/mysql_runtime_error.h>
 #include <mysql/components/services/mysql_string.h>  // IWYU pragma: keep
 #include <mysql/components/services/psi_thread.h>
@@ -46,8 +49,6 @@
 
 #include <mysqlpp/udf_error_reporter.hpp>
 
-#include "sql/debug_sync.h"  // IWYU pragma: keep
-
 #include "masking_functions/command_service_tuple.hpp"
 #include "masking_functions/component_sys_variable_service_tuple.hpp"
 #include "masking_functions/default_sql_context_builder.hpp"
@@ -101,6 +102,11 @@ REQUIRES_SERVICE_PLACEHOLDER(log_builtins_string);
 
 REQUIRES_SERVICE_PLACEHOLDER(mysql_runtime_error);
 
+#ifndef NDEBUG
+REQUIRES_SERVICE_PLACEHOLDER(mysql_debug_keyword_service);
+REQUIRES_SERVICE_PLACEHOLDER(mysql_debug_sync_service);
+#endif
+
 SERVICE_TYPE(log_builtins) * log_bi;
 SERVICE_TYPE(log_builtins_string) * log_bs;
 
@@ -213,13 +219,20 @@ mysql_service_status_t component_init() {
           masking_functions::dictionary_flusher_thread_ptr>::instance() =
           std::move(flusher);
 
-      // NOLINTNEXTLINE(cppcoreguidelines-avoid-do-while)
-      DBUG_EXECUTE_IF("enable_masking_functions_flusher_create_sync", {
-        MYSQL_THD extracted_thd{nullptr};
-        mysql_service_mysql_current_thread_reader->get(&extracted_thd);
-        assert(extracted_thd != nullptr);
-        DEBUG_SYNC(extracted_thd, "masking_functions_after_flusher_create");
-      });
+      // not using 'DBUG_EXECUTE_IF()' macro from the
+      // 'mysql/components/util/debug_execute_if.h' and 'DEBUG_SYNC()' macro
+      // fromthe 'mysql/components/util/debug_sync.h' as they are not supposed
+      // to be used in namespaces (including anonymous)
+#ifndef NDEBUG
+      if (mysql_service_mysql_debug_keyword_service->lookup_debug_keyword(
+              "enable_masking_functions_flusher_create_sync") != 0) {
+        MYSQL_THD current_thd{nullptr};
+        mysql_service_mysql_current_thread_reader->get(&current_thd);
+        assert(current_thd != nullptr);
+        mysql_service_mysql_debug_sync_service->debug_sync(
+            current_thd, "masking_functions_after_flusher_create");
+      }
+#endif
     }
 
     LogComponentErr(INFORMATION_LEVEL, ER_LOG_PRINTF_MSG,
@@ -320,6 +333,12 @@ BEGIN_COMPONENT_REQUIRES(CURRENT_COMPONENT_NAME)
   REQUIRES_SERVICE(log_builtins_string),
 
   REQUIRES_SERVICE(mysql_runtime_error),
+
+#ifndef NDEBUG
+  REQUIRES_SERVICE(mysql_debug_keyword_service),
+  REQUIRES_SERVICE(mysql_debug_sync_service),
+#endif
+
 END_COMPONENT_REQUIRES();
 
 BEGIN_COMPONENT_METADATA(CURRENT_COMPONENT_NAME)

Diff for: components/masking_functions/src/masking_functions/dictionary_flusher_thread.cpp

@@ -28,7 +28,6 @@
 #include <thread>
 #include <utility>
 
-#include <my_dbug.h>
 #include <my_sys.h>
 #include <my_thread.h>
 #include <mysqld_error.h>
@@ -40,6 +39,10 @@
 
 #include <mysql/components/services/log_builtins.h>
 #include <mysql/components/services/mysql_current_thread_reader.h>
+#ifndef NDEBUG
+#include <mysql/components/services/mysql_debug_keyword_service.h>
+#include <mysql/components/services/mysql_debug_sync_service.h>
+#endif
 
 #include <mysql/components/services/bits/my_thread_bits.h>
 #include <mysql/components/services/bits/psi_bits.h>
@@ -58,9 +61,11 @@
 #endif
 #include "masking_functions/static_sql_context_builder.hpp"
 
-#include "sql/debug_sync.h"  // IWYU pragma: keep
-
 extern REQUIRES_SERVICE_PLACEHOLDER(mysql_current_thread_reader);
+#ifndef NDEBUG
+extern REQUIRES_SERVICE_PLACEHOLDER(mysql_debug_keyword_service);
+extern REQUIRES_SERVICE_PLACEHOLDER(mysql_debug_sync_service);
+#endif
 
 namespace {
 
@@ -294,25 +299,32 @@ void dictionary_flusher_thread::do_periodic_reload() {
     }
     cache = std::make_unique<term_cache>(cache_core_, sql_ctx_builder);
 
-    // NOLINTNEXTLINE(cppcoreguidelines-avoid-do-while)
-    DBUG_EXECUTE_IF("enable_masking_functions_flush_thread_sync", {
+    // not using 'DBUG_EXECUTE_IF()' macro from the
+    // 'mysql/components/util/debug_execute_if.h' and 'DEBUG_SYNC()' macro
+    // fromthe 'mysql/components/util/debug_sync.h' as they are not supposed
+    // to be used in namespaces (including anonymous)
+#ifndef NDEBUG
+    if (mysql_service_mysql_debug_keyword_service->lookup_debug_keyword(
+            "enable_masking_functions_flush_thread_sync") != 0) {
       const sql_context_ptr sql_ctx{sql_ctx_builder->build()};
       std::string wait_action{
           "SET debug_sync = 'masking_functions_before_cache_reload WAIT_FOR "
           "masking_functions_before_cache_reload_signal"};
       std::string signal_action{
           "SET debug_sync = 'masking_functions_after_cache_reload SIGNAL "
           "masking_functions_after_cache_reload_signal"};
-      DBUG_EXECUTE_IF("enable_masking_functions_flush_thread_double_pass", {
+      if (mysql_service_mysql_debug_keyword_service->lookup_debug_keyword(
+              "enable_masking_functions_flush_thread_double_pass") != 0) {
         wait_action += " EXECUTE 2";
         signal_action += " EXECUTE 2";
-      });
+      }
       wait_action += '\'';
       signal_action += '\'';
 
       sql_ctx->execute_dml(wait_action);
       sql_ctx->execute_dml(signal_action);
-    });
+    }
+#endif
   } catch (const std::exception &e) {
     failure_message.emplace(
         "Exception during flusher thread initialization - ");
@@ -352,10 +364,13 @@ void dictionary_flusher_thread::do_periodic_reload() {
   auto expires_at{std::chrono::steady_clock::now()};
   while (!is_terminated_lambda()) {
     if (std::chrono::steady_clock::now() >= expires_at) {
-      // NOLINTNEXTLINE(cppcoreguidelines-avoid-do-while)
-      DBUG_EXECUTE_IF("enable_masking_functions_flush_thread_sync", {
-        DEBUG_SYNC(extracted_thd, "masking_functions_before_cache_reload");
-      });
+#ifndef NDEBUG
+      if (mysql_service_mysql_debug_keyword_service->lookup_debug_keyword(
+              "enable_masking_functions_flush_thread_sync") != 0) {
+        mysql_service_mysql_debug_sync_service->debug_sync(
+            extracted_thd, "masking_functions_before_cache_reload");
+      }
+#endif
 
       failure_message.reset();
       try {
@@ -373,10 +388,13 @@ void dictionary_flusher_thread::do_periodic_reload() {
                         failure_message->c_str());
       }
 
-      // NOLINTNEXTLINE(cppcoreguidelines-avoid-do-while)
-      DBUG_EXECUTE_IF("enable_masking_functions_flush_thread_sync", {
-        DEBUG_SYNC(extracted_thd, "masking_functions_after_cache_reload");
-      });
+#ifndef NDEBUG
+      if (mysql_service_mysql_debug_keyword_service->lookup_debug_keyword(
+              "enable_masking_functions_flush_thread_sync") != 0) {
+        mysql_service_mysql_debug_sync_service->debug_sync(
+            extracted_thd, "masking_functions_after_cache_reload");
+      }
+#endif
 
       expires_at = std::chrono::steady_clock::now() + flush_interval_duration;
     } else {