Bug #32216281: REMOVE DBUG_OFF AND DBUG_ASSERT

Replace DBUG_OFF with NDEBUG, and DBUG_ASSERT() with assert(). These are
semantically the same (DBUG_ASSERT() has been #defined to assert() for a long
time), but nonstandard.

Whenever a file #included my_dbug.h but no longer use any DBUG_* macros,
we remove said #include and use <assert.h> instead.

The change is mostly automated; the manual changes are to my_dbug.h
itself, to CMake code, and a few added #includes that were neccessary in
files that used to depend on transitive #includes from my_dbug.h
(e.g. #include "my_dbug.h" to get malloc()).

Change-Id: If4271d9f053d3235dd73bcbbae85eaab0d65a724

Author: Steinar H. Gunderson

CMakeLists.txt

@@ -1090,22 +1090,6 @@ IF(WITH_TEST_TRACE_PLUGIN AND NOT CMAKE_BUILD_TYPE_UPPER STREQUAL "DEBUG")
      debug binaries. Set WITH_TEST_TRACE_PLUGIN to OFF or WITH_DEBUG to ON.")
 ENDIF()
 
-# Set DBUG_OFF for non-debug project types.
-FOREACH(BUILD_TYPE RELEASE RELWITHDEBINFO MINSIZEREL)
-  FOREACH(LANG C CXX)
-    STRING_PREPEND(CMAKE_${LANG}_FLAGS_${BUILD_TYPE} "-DDBUG_OFF ")
-  ENDFOREACH()
-ENDFOREACH()
-
-IF(NOT CMAKE_BUILD_TYPE
-    AND NOT CMAKE_GENERATOR MATCHES "Visual Studio" 
-    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)
-ENDIF()
-
 # Add safemutex for debug configurations
 # Enable debug sync for debug builds.
 FOREACH(LANG C CXX)

client/base/abstract_option.h

@@ -25,12 +25,13 @@
 #ifndef ABSTRACT_OPTION_INCLUDED
 #define ABSTRACT_OPTION_INCLUDED
 
+#include <assert.h>
 #include <functional>
 #include <string>
 #include <vector>
 
 #include "client/base/i_option_changed_listener.h"
-#include "my_dbug.h"
+
 #include "my_getopt.h"
 #include "mysql/service_mysql_alloc.h"
 
@@ -178,7 +179,7 @@ my_option Abstract_option<T_type>::get_my_option() {
 template <typename T_type>
 void Abstract_option<T_type>::set_option_changed_listener(
     I_option_changed_listener *listener) {
-  DBUG_ASSERT(this->m_option_changed_listener == nullptr);
+  assert(this->m_option_changed_listener == nullptr);
 
   this->m_option_changed_listener = listener;
 }

client/base/abstract_options_provider.cc

@@ -1,5 +1,5 @@
 /*
-   Copyright (c) 2001, 2019, Oracle and/or its affiliates. All rights reserved.
+   Copyright (c) 2001, 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,
@@ -24,12 +24,13 @@
 
 #include "client/base/abstract_options_provider.h"
 
+#include <assert.h>
 #include <stdlib.h>
 #include <iostream>
 #include <vector>
 
 #include "client/base/i_options_provider.h"
-#include "my_dbug.h"
+
 #include "my_getopt.h"
 
 using std::map;
@@ -133,7 +134,7 @@ Abstract_options_provider::~Abstract_options_provider() {
 
 void Abstract_options_provider::set_option_changed_listener(
     I_option_changed_listener *listener) {
-  DBUG_ASSERT(this->m_option_changed_listener == nullptr);
+  assert(this->m_option_changed_listener == nullptr);
   this->m_option_changed_listener = listener;
 }
 

client/base/composite_options_provider.cc

@@ -1,5 +1,5 @@
 /*
-   Copyright (c) 2001, 2019, Oracle and/or its affiliates. All rights reserved.
+   Copyright (c) 2001, 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,
@@ -24,18 +24,18 @@
 
 #include "client/base/composite_options_provider.h"
 
+#include <assert.h>
 #include <stdarg.h>
 #include <stddef.h>
 #include <vector>
 
 #include "client/base/i_options_provider.h"
-#include "my_dbug.h"
 
 using std::vector;
 using namespace Mysql::Tools::Base::Options;
 
 void Composite_options_provider::add_providers(I_options_provider *first, ...) {
-  DBUG_ASSERT(this->m_options_providers.size() == 0);
+  assert(this->m_options_providers.size() == 0);
 
   va_list options_to_add;
   va_start(options_to_add, first);

client/base/debug_options.cc

@@ -1,5 +1,5 @@
 /*
-   Copyright (c) 2014, 2019, 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,
@@ -54,7 +54,7 @@ Debug_options::Debug_options(Abstract_program *program) : m_program(program) {
 }
 
 void Debug_options::create_options() {
-#ifdef DBUG_OFF
+#ifdef NDEBUG
   this->create_new_disabled_option(
           "debug", "This is a non-debug version. Catch this and exit.")
       ->set_short_character('#');

client/check/mysqlcheck.cc

@@ -1,5 +1,5 @@
 /*
-   Copyright (c) 2001, 2019, Oracle and/or its affiliates. All rights reserved.
+   Copyright (c) 2001, 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,
@@ -124,7 +124,7 @@ static struct my_option my_long_options[] = {
      "tables are given. All name arguments are regarded as database names.",
      &opt_databases, &opt_databases, nullptr, GET_BOOL, NO_ARG, 0, 0, 0,
      nullptr, 0, nullptr},
-#ifdef DBUG_OFF
+#ifdef NDEBUG
     {"debug", '#', "This is a non-debug version. Catch this and exit.", 0, 0, 0,
      GET_DISABLED, OPT_ARG, 0, 0, 0, 0, 0, 0},
     {"debug-check", OPT_DEBUG_CHECK,
@@ -334,8 +334,8 @@ static bool get_one_option(int optid, const struct my_option *opt,
       if (argument == disabled_my_option) {
         // Don't require password
         static char empty_password[] = {'\0'};
-        DBUG_ASSERT(empty_password[0] ==
-                    '\0');  // Check that it has not been overwritten
+        assert(empty_password[0] ==
+               '\0');  // Check that it has not been overwritten
         argument = empty_password;
       }
       if (argument) {

client/mysql.cc

@@ -250,7 +250,7 @@ const char *default_dbug_option = "d:t:o,/tmp/mysql.trace";
 
   For using this feature in test case, we add the option in debug code.
 */
-#ifndef DBUG_OFF
+#ifndef NDEBUG
 static bool opt_build_completion_hash = false;
 #endif
 
@@ -1685,7 +1685,7 @@ static struct my_option my_long_options[] = {
     {"compress", 'C', "Use compression in server/client protocol.",
      &opt_compress, &opt_compress, nullptr, GET_BOOL, NO_ARG, 0, 0, 0, nullptr,
      0, nullptr},
-#ifdef DBUG_OFF
+#ifdef NDEBUG
     {"debug", '#', "This is a non-debug version. Catch this and exit.", 0, 0, 0,
      GET_DISABLED, OPT_ARG, 0, 0, 0, 0, 0, 0},
     {"debug-check", OPT_DEBUG_CHECK,
@@ -1916,7 +1916,7 @@ static struct my_option my_long_options[] = {
      "password sandbox mode.",
      &opt_connect_expired_password, &opt_connect_expired_password, nullptr,
      GET_BOOL, NO_ARG, 0, 0, 0, nullptr, 0, nullptr},
-#ifndef DBUG_OFF
+#ifndef NDEBUG
     {"build-completion-hash", 0,
      "Build completion hash even when it is in batch mode. It is used for "
      "test purpose, so it is just built when DEBUG is on.",
@@ -2047,8 +2047,8 @@ bool get_one_option(int optid,
       if (argument == disabled_my_option) {
         // Don't require password
         static char empty_password[] = {'\0'};
-        DBUG_ASSERT(empty_password[0] ==
-                    '\0');  // Check that it has not been overwritten
+        assert(empty_password[0] ==
+               '\0');  // Check that it has not been overwritten
         argument = empty_password;
       }
       if (argument) {
@@ -2397,7 +2397,7 @@ static COMMANDS *find_command(char *name) {
   char *end;
   DBUG_TRACE;
 
-  DBUG_ASSERT(name != nullptr);
+  assert(name != nullptr);
   DBUG_PRINT("enter", ("name: '%s'", name));
 
   while (my_isspace(charset_info, *name)) name++;
@@ -2830,7 +2830,7 @@ static void build_completion_hash(bool rehash, bool write_info) {
   int i, j, num_fields;
   DBUG_TRACE;
 
-#ifndef DBUG_OFF
+#ifndef NDEBUG
   if (!opt_build_completion_hash)
 #endif
   {
@@ -3724,9 +3724,9 @@ static int get_result_width(MYSQL_RES *result) {
   MYSQL_FIELD *field;
   MYSQL_FIELD_OFFSET offset;
 
-#ifndef DBUG_OFF
+#ifndef NDEBUG
   offset = mysql_field_tell(result);
-  DBUG_ASSERT(offset == 0);
+  assert(offset == 0);
 #else
   offset = 0;
 #endif

client/mysql_config_editor.cc

@@ -133,7 +133,7 @@ struct my_command_data {
 
 /* mysql_config_editor utility options. */
 static struct my_option my_program_long_options[] = {
-#ifdef DBUG_OFF
+#ifdef NDEBUG
     {"debug", '#', "This is a non-debug version. Catch this and exit.", 0, 0, 0,
      GET_DISABLED, OPT_ARG, 0, 0, 0, 0, 0, 0},
 #else

client/mysql_secure_installation.cc

@@ -1,5 +1,5 @@
 /*
-   Copyright (c) 2013, 2019, Oracle and/or its affiliates. All rights reserved.
+   Copyright (c) 2013, 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,
@@ -790,7 +790,7 @@ int main(int argc, char *argv[]) {
 
   if ((rc = my_handle_options(&argc, &argv, my_connection_options,
                               my_arguments_get_one_option, nullptr, true))) {
-    DBUG_ASSERT(0);
+    assert(0);
   }
 
   init_connection_options(&mysql);

client/mysqladmin.cc

@@ -1,5 +1,5 @@
 /*
-   Copyright (c) 2000, 2020, Oracle and/or its affiliates. All rights reserved.
+   Copyright (c) 2000, 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,
@@ -184,7 +184,7 @@ static struct my_option my_long_options[] = {
      "Number of iterations to make. This works with -i (--sleep) only.",
      &nr_iterations, &nr_iterations, nullptr, GET_UINT, REQUIRED_ARG, 0, 0, 0,
      nullptr, 0, nullptr},
-#ifdef DBUG_OFF
+#ifdef NDEBUG
     {"debug", '#', "This is a non-debug version. Catch this and exit.", 0, 0, 0,
      GET_DISABLED, OPT_ARG, 0, 0, 0, 0, 0, 0},
     {"debug-check", OPT_DEBUG_CHECK,
@@ -330,8 +330,8 @@ bool get_one_option(int optid,
       if (argument == disabled_my_option) {
         // Don't require password
         static char empty_password[] = {'\0'};
-        DBUG_ASSERT(empty_password[0] ==
-                    '\0');  // Check that it has not been overwritten
+        assert(empty_password[0] ==
+               '\0');  // Check that it has not been overwritten
         argument = empty_password;
       }
       if (argument) {
@@ -881,7 +881,7 @@ static int execute_commands(MYSQL *mysql, int argc, char **argv) {
           return -1;
         }
 
-        DBUG_ASSERT(mysql_num_rows(res) < MAX_MYSQL_VAR);
+        assert(mysql_num_rows(res) < MAX_MYSQL_VAR);
 
         if (!opt_vertical)
           print_header(res);

client/mysqlbinlog.cc

@@ -225,8 +225,8 @@ class Database_rewrite {
     Rewrite_result rewrite_transaction_payload(
         unsigned char *buffer, std::size_t buffer_capacity,
         binary_log::Format_description_event const &fde) {
-      DBUG_ASSERT(buffer[EVENT_TYPE_OFFSET] ==
-                  binary_log::TRANSACTION_PAYLOAD_EVENT);
+      assert(buffer[EVENT_TYPE_OFFSET] ==
+             binary_log::TRANSACTION_PAYLOAD_EVENT);
       binary_log::Transaction_payload_event tpe((const char *)buffer, &fde);
 
       auto orig_payload{tpe.get_payload()};
@@ -504,7 +504,7 @@ class Database_rewrite {
     dbname_ptr = the_buffer + offset_dbname;
     memcpy(dbname_ptr, to.c_str(), to.size());
 
-    DBUG_ASSERT(to.size() < UINT8_MAX);
+    assert(to.size() < UINT8_MAX);
     dbname_len_ptr = the_buffer + offset_dbname_len;
     *dbname_len_ptr = (char)to.size();
 
@@ -602,7 +602,7 @@ class Database_rewrite {
                              size_t data_size,
                              binary_log::Format_description_event const &fde,
                              bool skip_transaction_payload_event = false) {
-    DBUG_ASSERT(buffer_capacity >= data_size);
+    assert(buffer_capacity >= data_size);
     auto event_type = (Log_event_type)buffer[EVENT_TYPE_OFFSET];
     if (m_dict.empty() || !is_rewrite_needed_for_event(event_type))
       return Rewrite_result{buffer, buffer_capacity, data_size, false};
@@ -698,7 +698,7 @@ static uint opt_protocol = 0;
 static uint opt_compress = 0;
 static FILE *result_file;
 
-#ifndef DBUG_OFF
+#ifndef NDEBUG
 static const char *default_dbug_option = "d:t:o,/tmp/mysqlbinlog.trace";
 #endif
 static const char *load_default_groups[] = {"mysqlbinlog", "client", nullptr};
@@ -1814,7 +1814,7 @@ static struct my_option my_long_options[] = {
      "it can be applied to a new database",
      &rewrite, &rewrite, nullptr, GET_STR_ALLOC, REQUIRED_ARG, 0, 0, 0, nullptr,
      0, nullptr},
-#ifdef DBUG_OFF
+#ifdef NDEBUG
     {"debug", '#', "This is a non-debug version. Catch this and exit.", 0, 0, 0,
      GET_DISABLED, OPT_ARG, 0, 0, 0, 0, 0, 0},
     {"debug-check", OPT_DEBUG_CHECK,
@@ -2174,7 +2174,7 @@ extern "C" bool get_one_option(int optid, const struct my_option *opt,
                                char *argument) {
   bool tty_password = false;
   switch (optid) {
-#ifndef DBUG_OFF
+#ifndef NDEBUG
     case '#':
       DBUG_PUSH(argument ? argument : default_dbug_option);
       break;
@@ -2213,8 +2213,8 @@ extern "C" bool get_one_option(int optid, const struct my_option *opt,
       if (argument == disabled_my_option) {
         // Don't require password
         static char empty_password[] = {'\0'};
-        DBUG_ASSERT(empty_password[0] ==
-                    '\0');  // Check that it has not been overwritten
+        assert(empty_password[0] ==
+               '\0');  // Check that it has not been overwritten
         argument = empty_password;
       }
       if (argument) {
@@ -2383,7 +2383,7 @@ static Exit_status dump_single_log(PRINT_EVENT_INFO *print_event_info,
       rc = dump_remote_log_entries(print_event_info, logname);
       break;
     default:
-      DBUG_ASSERT(0);
+      assert(0);
       break;
   }
   return rc;
@@ -2925,7 +2925,7 @@ class Stdin_binlog_istream : public Basic_seekable_istream,
   }
 
   bool seek(my_off_t position) override {
-    DBUG_ASSERT(position > m_position);
+    assert(position > m_position);
     if (Stdin_istream::skip(position - m_position)) {
       error("Failed to skip %llu bytes from stdin", position - m_position);
       return true;
@@ -2937,7 +2937,7 @@ class Stdin_binlog_istream : public Basic_seekable_istream,
   /* purecov: begin inspected */
   /** Stdin has no length. It should never be called. */
   my_off_t length() override {
-    DBUG_ASSERT(0);
+    assert(0);
     return 0;
   }
   /* purecov: end */