Aligning usage of DBUG_OFF and DBUG_ASSERT with Server.

Server Change:
- Commit: 008c81cb8a19328744ce5f2f87d956440ac8600c
- Summary: Replace DBUG_OFF with NDEBUG, and DBUG_ASSERT() with assert().
- Reason: Bug #32216281: REMOVE DBUG_OFF AND DBUG_ASSERT

008c81cb8a19328744ce5f2f87d956440ac8600c

Change-Id: I3d90c0b00f0a74869c88fca969b4900cd25c6a5a

Author: rennox

CMakeLists.txt

@@ -577,10 +577,10 @@ IF(WIN32)
   ENDIF()
 ENDIF()
 
-# Set DBUG_OFF for non-debug project types.
+# Set NDEBUG for non-debug project types.
 FOREACH(BUILD_TYPE RELEASE RELWITHDEBINFO MINSIZEREL)
   FOREACH(LANG C CXX)
-    SET(CMAKE_${LANG}_FLAGS_${BUILD_TYPE} "${CMAKE_${LANG}_FLAGS_${BUILD_TYPE}} -DDBUG_OFF ")
+    SET(CMAKE_${LANG}_FLAGS_${BUILD_TYPE} "${CMAKE_${LANG}_FLAGS_${BUILD_TYPE}} -DNDEBUG ")
   ENDFOREACH()
 ENDFOREACH()
 
@@ -589,8 +589,8 @@ IF(NOT CMAKE_BUILD_TYPE
     AND NOT CMAKE_GENERATOR MATCHES "Xcode")
     # This is the case of no CMAKE_BUILD_TYPE choosen, typical for VS and Xcode
     # or if custom C flags are set. In VS and Xcode for non-Debug configurations
-    # DBUG_OFF is already correctly set.
-    ADD_DEFINITIONS(-DDBUG_OFF)
+    # NDEBUG is already correctly set.
+    ADD_DEFINITIONS(-DNDEBUG)
 ENDIF()
 
 # Includes common to the whole project

cmake/FindMySQL.cmake

@@ -1,7 +1,7 @@
 # -*- indent-tabs-mode:nil; -*-
 # vim: set expandtab:
 #
-#   Copyright (c) 2008, 2014, Oracle and/or its affiliates. All rights reserved.
+#   Copyright (c) 2008, 2020, Oracle and/or its affiliates.
 #
 #   This program is free software; you can redistribute it and/or modify
 #   it under the terms of the GNU General Public License, version 2.0,
@@ -180,7 +180,7 @@ if(CMAKE_BUILD_TYPE STREQUAL Debug)
 else()
   set(_lib_suffix_dist opt)
   set(_lib_suffix_build Release)
-  add_definitions(-DDBUG_OFF)   # FIXME what?!
+  add_definitions(-DNDEBUG)   # FIXME what?!
 endif()
 
 set(_exe_fallback_path

modules/adminapi/common/instance_pool.cc

@@ -631,7 +631,7 @@ std::shared_ptr<Instance> Instance_pool::connect_unchecked(
 
   const Cluster_metadata *cluster =
       m_mdcache->try_get_cluster(node->cluster_id);
-  DBUG_ASSERT(cluster);
+  assert(cluster);
   if (!cluster) {
     throw shcore::Exception::logic_error("Invalid node " + node->label);
   }
@@ -714,7 +714,7 @@ std::shared_ptr<Instance> Instance_pool::connect_primary(
 
   const Cluster_metadata *cluster =
       m_mdcache->try_get_cluster(node->cluster_id);
-  DBUG_ASSERT(cluster);
+  assert(cluster);
   if (!cluster) {
     throw shcore::Exception::logic_error("Invalid cluster " + node->label);
   }

modules/adminapi/common/star_global_topology_manager.cc

@@ -30,6 +30,7 @@
 
 #include "modules/adminapi/common/star_global_topology_manager.h"
 
+#include <assert.h>
 #include <list>
 #include <numeric>
 #include <string>
@@ -40,7 +41,6 @@
 #include "modules/adminapi/common/global_topology_check.h"
 #include "modules/adminapi/common/instance_pool.h"
 #include "modules/adminapi/common/validations.h"
-#include "my_dbug.h"
 #include "mysqlshdk/include/scripting/types.h"
 #include "mysqlshdk/include/shellcore/console.h"
 #include "mysqlshdk/libs/mysql/async_replication.h"
@@ -555,7 +555,7 @@ void Star_global_topology_manager::validate_active_unavailable() {
   // Find the primary master cluster according to the MD
   primary_master = m_topology->get_primary_master_node();
 
-  DBUG_ASSERT(primary_master);
+  assert(primary_master);
 
   log_info("Status of PRIMARY node %s is %s", primary_master->label.c_str(),
            to_string(primary_master->status()).c_str());

mysqlshdk/libs/utils/debug.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017, 2020, Oracle and/or its affiliates.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License, version 2.0,
@@ -196,7 +196,7 @@ bool debug_object_dump_report(bool verbose);
 
 // Right now, this is in mysql-trunk only, remove once DBUG_TRACE hits
 // our target branch
-#if !defined(DBUG_PRETTY_FUNCTION) && !defined(DBUG_OFF)
+#if !defined(DBUG_PRETTY_FUNCTION) && !defined(NDEBUG)
 
 #if defined(__GNUC__)
 // GCC, Clang, and compatible compilers.
@@ -260,7 +260,7 @@ class AutoDebugTrace {
 
 #endif
 
-#if !defined(DBUG_OFF)
+#if !defined(NDEBUG)
 
 // workaround for BUG30071277
 
@@ -276,6 +276,6 @@ class AutoDebugTrace {
     }                                        \
   } while (0)
 
-#endif  // !DBUG_OFF
+#endif  // !NDEBUG
 
 #endif  // MYSQLSHDK_LIBS_UTILS_DEBUG_H_

mysqlshdk/libs/utils/fault_injection.cc

@@ -248,7 +248,7 @@ void FI::trigger_trap(Type_id type, const Trap_options &input) {
 
 void FI::set_trap(const std::string &type, const Conditions &conds,
                   const Trap_options &options) {
-#ifdef DBUG_OFF
+#ifdef NDEBUG
   throw std::logic_error("FI not enabled in this build");
 #endif
   bool flag = false;

mysqlshdk/libs/utils/fault_injection.h

@@ -52,7 +52,7 @@ namespace utils {
  *
  * An injector is a custom routine that executes a custom action, like throwing
  * an exception or calling abort(). That can be done with the FI_DEFINE()
- * macro, which is only enabled if DBUG_OFF is NOT defined.
+ * macro, which is only enabled if NDEBUG is NOT defined.
  *
  * These injectors must then be invoked by the code to be tested (e.g. right
  * before SQL is executed, to simulate client or server DB errors) by using
@@ -194,7 +194,7 @@ class FI {
    * context, which should be used to trigger faults.
    *
    * Use the FI_DEFINE() macro instead of calling directly, which becomes
-   * a no-op in DBUG_OFF builds.
+   * a no-op in NDEBUG builds.
    */
   static Type_id add_injector(const std::string &type,
                               const std::function<void(const Args &)> &handler);
@@ -205,7 +205,7 @@ class FI {
    * This function may not return.
    *
    * Use the FI_TRIGGER_TRAP() macro instead of calling directly, which becomes
-   * a no-op in DBUG_OFF builds.
+   * a no-op in NDEBUG builds.
    */
   static void trigger_trap(Type_id type, const Trigger_options &input);
 
@@ -229,7 +229,7 @@ class FI {
   static void reset_traps(const std::string &type = "");
 };
 
-#ifdef DBUG_OFF
+#ifdef NDEBUG
 
 #define FI_DEFINE(type, injector) struct dummy_fi_##type
 

mysqlshdk/shellcore/shell_options.cc

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2014, 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2014, 2020, Oracle and/or its affiliates.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License, version 2.0,
@@ -566,7 +566,7 @@ Shell_options::Shell_options(int argc, char **argv,
       })
       (cmdline("--debug=<control>"),
       [this](const std::string &, const char* value) {
-#ifdef DBUG_OFF
+#ifdef NDEBUG
         // If DBUG is disabled, we just print a warning saying the option won't
         // do anything. This is to keep options compatible between build types
         std::cout << "WARNING: This build of mysqlsh has the DBUG feature "

unittest/shell_script_tester.cc

@@ -1661,7 +1661,7 @@ void Shell_script_tester::set_defaults() {
   def_var("__with_oci", "0");
 #endif
 
-#ifdef DBUG_OFF
+#ifdef NDEBUG
   // TODO(.) - remove __dbug_off and replace all uses with __dbug
   def_var("__dbug_off", "1");
   // dbug tests should only run in direct mode, so that traces aren't affected

unittest/test_utils/mod_testutils.cc

@@ -373,11 +373,11 @@ void Testutils::bp(bool flag) {
 void Testutils::set_trap(const std::string &type,
                          const shcore::Array_t &conditions,
                          const shcore::Dictionary_t &options) {
-#ifdef DBUG_OFF
+#ifdef NDEBUG
   (void)type;
   (void)conditions;
   (void)options;
-  throw std::logic_error("set_trap() not available in DBUG_OFF builds");
+  throw std::logic_error("set_trap() not available in NDEBUG builds");
 #else
   mysqlshdk::utils::FI::Conditions conds;
 
@@ -399,18 +399,18 @@ void Testutils::set_trap(const std::string &type,
 }
 
 void Testutils::clear_traps(const std::string &type) {
-#ifdef DBUG_OFF
+#ifdef NDEBUG
   (void)type;
-  throw std::logic_error("clear_traps() not available in DBUG_OFF builds");
+  throw std::logic_error("clear_traps() not available in NDEBUG builds");
 #else
   mysqlshdk::utils::FI::clear_traps(type);
 #endif
 }
 
 void Testutils::reset_traps(const std::string &type) {
-#ifdef DBUG_OFF
+#ifdef NDEBUG
   (void)type;
-  throw std::logic_error("reset_traps() not available in DBUG_OFF builds");
+  throw std::logic_error("reset_traps() not available in NDEBUG builds");
 #else
   mysqlshdk::utils::FI::reset_traps(type);
 #endif