Bug #32354435 BACKPORT TO 5.7: BUG #32216281 REMOVE DBUG_OFF AND DBUG_ASSERT

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

Manually edited:
dbug/user.r
include/my_dbug.h
libbinlogevents/include/wrapper_functions.h
libmysql/authentication_win/common.h

Everything else is automated: replace DBUG_ASSERT with assert, and
re-indent each region according to appropriate C style in each source
file.

Change-Id: Ib56a4e1f9677c04227ddf618e03c67dee05b98a4

Author: Tor Didriksen

client/base/abstract_option.h

@@ -1,5 +1,5 @@
 /*
-   Copyright (c) 2014, 2015 Oracle and/or its affiliates. All rights reserved.
+   Copyright (c) 2014, 2021, Oracle and/or its affiliates. All rights reserved.
 
    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 @@ 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 == NULL);
+  assert(this->m_option_changed_listener == NULL);
 
   this->m_option_changed_listener= listener;
 }

client/base/abstract_options_provider.cc

@@ -1,5 +1,5 @@
 /*
-   Copyright (c) 2001, 2016, Oracle and/or its affiliates. All rights reserved.
+   Copyright (c) 2001, 2021, Oracle and/or its affiliates. All rights reserved.
 
    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,
@@ -154,7 +154,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 == NULL);
+  assert(this->m_option_changed_listener == NULL);
   this->m_option_changed_listener= listener;
 }
 

client/base/composite_options_provider.cc

@@ -1,5 +1,5 @@
 /*
-   Copyright (c) 2001, 2014, Oracle and/or its affiliates. All rights reserved.
+   Copyright (c) 2001, 2021, Oracle and/or its affiliates. All rights reserved.
 
    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,
@@ -33,7 +33,7 @@ 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/mysql.cc

@@ -1,5 +1,5 @@
 /*
-   Copyright (c) 2000, 2020, Oracle and/or its affiliates.
+   Copyright (c) 2000, 2021, 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,
@@ -2468,7 +2468,7 @@ static COMMANDS *find_command(char *name)
   char *end;
   DBUG_ENTER("find_command");
 
-  DBUG_ASSERT(name != NULL);
+  assert(name != NULL);
   DBUG_PRINT("enter", ("name: '%s'", name));
 
   while (my_isspace(charset_info, *name))
@@ -4103,7 +4103,7 @@ static int get_result_width(MYSQL_RES *result)
 
 #ifndef DBUG_OFF
   offset= mysql_field_tell(result);
-  DBUG_ASSERT(offset == 0);
+  assert(offset == 0);
 #else
   offset= 0;
 #endif

client/mysql_secure_installation.cc

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

client/mysqladmin.cc

@@ -1,5 +1,5 @@
 /*
-   Copyright (c) 2000, 2018, Oracle and/or its affiliates. All rights reserved.
+   Copyright (c) 2000, 2021, Oracle and/or its affiliates. All rights reserved.
 
    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,
@@ -910,7 +910,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

@@ -1,5 +1,5 @@
 /*
-   Copyright (c) 2000, 2018, Oracle and/or its affiliates. All rights reserved.
+   Copyright (c) 2000, 2021, Oracle and/or its affiliates. All rights reserved.
 
    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,
@@ -111,7 +111,7 @@ rewrite_db(char **buf, ulong *buf_size,
   if (new_db_it == map_mysqlbinlog_rewrite_db.end())
     return false;
   const char *new_db=new_db_it->second.c_str();
-  DBUG_ASSERT(new_db && new_db != old_db);
+  assert(new_db && new_db != old_db);
 
   size_t new_db_len= strlen(new_db);
 
@@ -2336,7 +2336,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;
   }
   DBUG_RETURN(rc);
@@ -2605,7 +2605,7 @@ static Exit_status dump_remote_log_entries(PRINT_EVENT_INFO *print_event_info,
     ptr_buffer+= BINLOG_NAME_INFO_SIZE;
 
     command_size= ptr_buffer - command_buffer;
-    DBUG_ASSERT(command_size == (allocation_size - 1));
+    assert(command_size == (allocation_size - 1));
   }
   else
   {
@@ -2647,7 +2647,7 @@ static Exit_status dump_remote_log_entries(PRINT_EVENT_INFO *print_event_info,
     global_sid_lock->unlock();
 
     command_size= ptr_buffer - command_buffer;
-    DBUG_ASSERT(command_size == (allocation_size - 1));
+    assert(command_size == (allocation_size - 1));
   }
 
   if (simple_command(mysql, command, command_buffer, command_size, 1))
@@ -2834,7 +2834,7 @@ static Exit_status dump_remote_log_entries(PRINT_EVENT_INFO *print_event_info,
 
       if (type == binary_log::LOAD_EVENT)
       {
-        DBUG_ASSERT(raw_mode);
+        assert(raw_mode);
         warning("Attempting to load a remote pre-4.0 binary log that contains "
                 "LOAD DATA INFILE statements. The file will not be copied from "
                 "the remote server. ");

client/mysqldump.c

@@ -1,5 +1,5 @@
 /*
-   Copyright (c) 2000, 2020, Oracle and/or its affiliates. All rights reserved.
+   Copyright (c) 2000, 2021, Oracle and/or its affiliates. All rights reserved.
 
    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,
@@ -942,7 +942,7 @@ get_one_option(int optid, const struct my_option *opt MY_ATTRIBUTE((unused)),
         for (ptr= compatible_mode_names; *ptr; ptr++)
           size_for_sql_mode+= strlen(*ptr);
         size_for_sql_mode+= sizeof(compatible_mode_names)-1;
-        DBUG_ASSERT(sizeof(compatible_mode_normal_str)>=size_for_sql_mode);
+        assert(sizeof(compatible_mode_normal_str)>=size_for_sql_mode);
       }
 #endif
       mode= opt_compatible_mode;
@@ -1976,7 +1976,7 @@ static void print_xml_tag(FILE * xml_file, const char* sbeg,
   while (attribute_name != NullS)
   {
     attribute_value= va_arg(arg_list, char *);
-    DBUG_ASSERT(attribute_value != NullS);
+    assert(attribute_value != NullS);
 
     fputc(' ', xml_file);
     fputs(attribute_name, xml_file);    
@@ -4060,9 +4060,9 @@ static void dump_table(char *table, char *db)
                   extended_row.length+= mysql_hex_string(extended_row.str +
                                                          extended_row.length,
                                                          row[i], length);
-                  DBUG_ASSERT(extended_row.length+1 <= extended_row.max_length);
+                  assert(extended_row.length+1 <= extended_row.max_length);
                   /* mysql_hex_string() already terminated string by '\0' */
-                  DBUG_ASSERT(extended_row.str[extended_row.length] == '\0');
+                  assert(extended_row.str[extended_row.length] == '\0');
                 }
                 else
                 {
@@ -4665,7 +4665,7 @@ static int dump_all_databases()
       db_cnt++;
     }
   }
-  DBUG_ASSERT(mysql_db_found);
+  assert(mysql_db_found);
   memset(database_list, 0, sizeof(*database_list));
   my_free(database_list);
 
@@ -5107,7 +5107,7 @@ static char *get_actual_table_name(const char *old_table_name, MEM_ROOT *root)
   DBUG_ENTER("get_actual_table_name");
 
   /* Check memory for quote_for_like() */
-  DBUG_ASSERT(2*sizeof(old_table_name) < sizeof(show_name_buff));
+  assert(2*sizeof(old_table_name) < sizeof(show_name_buff));
   my_snprintf(query, sizeof(query), "SHOW TABLES LIKE %s",
               quote_for_like(old_table_name, show_name_buff));
 
@@ -5670,7 +5670,7 @@ char check_if_ignore_table(const char *table_name, char *table_type)
   DBUG_ENTER("check_if_ignore_table");
 
   /* Check memory for quote_for_like() */
-  DBUG_ASSERT(2*sizeof(table_name) < sizeof(show_name_buff));
+  assert(2*sizeof(table_name) < sizeof(show_name_buff));
   my_snprintf(buff, sizeof(buff), "show table status like %s",
               quote_for_like(table_name, show_name_buff));
   if (mysql_query_with_error_report(mysql, &res, buff))

client/mysqlslap.cc

@@ -1,5 +1,5 @@
 /*
-   Copyright (c) 2005, 2018, Oracle and/or its affiliates. All rights reserved.
+   Copyright (c) 2005, 2021, Oracle and/or its affiliates. All rights reserved.
 
    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,
@@ -1990,13 +1990,13 @@ extern "C" void *run_task(void *p)
           Just in case someone runs this under an experimental engine we don't
           want a crash so the if() is placed here.
         */
-        DBUG_ASSERT(primary_keys_number_of);
+        assert(primary_keys_number_of);
         if (primary_keys_number_of)
         {
           key_val= (unsigned int)(random() % primary_keys_number_of);
           key= primary_keys[key_val];
 
-          DBUG_ASSERT(key);
+          assert(key);
 
           length= snprintf(buffer, HUGE_STRING_LENGTH, "%.*s '%s'", 
                            (int)ptr->length, ptr->string, key);

client/mysqltest.cc

@@ -1,4 +1,4 @@
-/* Copyright (c) 2000, 2020, Oracle and/or its affiliates.
+/* Copyright (c) 2000, 2021, 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,
@@ -754,11 +754,11 @@ class LogFile {
   void write(DYNAMIC_STRING* ds)
   {
     DBUG_ENTER("LogFile::write");
-    DBUG_ASSERT(m_file);
+    assert(m_file);
 
     if (ds->length == 0)
       DBUG_VOID_RETURN;
-    DBUG_ASSERT(ds->str);
+    assert(ds->str);
 
     if (fwrite(ds->str, 1, ds->length, m_file) != ds->length)
       die("Failed to write %lu bytes to '%s', errno: %d",
@@ -919,7 +919,7 @@ extern "C" void *connection_thread(void *arg)
         cn->result= mysql_read_query_result(&cn->mysql);
         break;
       default:
-        DBUG_ASSERT(0);
+        assert(0);
     }
     cn->command= 0;
     native_mutex_lock(&cn->result_mutex);
@@ -937,7 +937,7 @@ extern "C" void *connection_thread(void *arg)
 
 static void wait_query_thread_done(struct st_connection *con)
 {
-  DBUG_ASSERT(con->has_thread);
+  assert(con->has_thread);
   if (!con->query_done)
   {
     native_mutex_lock(&con->result_mutex);
@@ -950,7 +950,7 @@ static void wait_query_thread_done(struct st_connection *con)
 
 static void signal_connection_thd(struct st_connection *cn, int command)
 {
-  DBUG_ASSERT(cn->has_thread);
+  assert(cn->has_thread);
   cn->query_done= 0;
   cn->command= command;
   native_mutex_lock(&cn->query_mutex);
@@ -978,7 +978,7 @@ static int do_send_query(struct st_connection *cn, const char *q, size_t q_len)
 
 static int do_read_query_result(struct st_connection *cn)
 {
-  DBUG_ASSERT(cn->has_thread);
+  assert(cn->has_thread);
   wait_query_thread_done(cn);
   signal_connection_thd(cn, EMB_READ_QUERY_RESULT);
   wait_query_thread_done(cn);
@@ -1302,7 +1302,7 @@ void check_command_args(struct st_command *command,
       break;
 
     default:
-      DBUG_ASSERT("Unknown argument type");
+      assert("Unknown argument type");
       break;
     }
 
@@ -1491,7 +1491,7 @@ static void cleanup_and_exit(int exit_code)
     break;
     default:
       printf("unknown exit code: %d\n", exit_code);
-      DBUG_ASSERT(0);
+      assert(0);
     }
   }
 
@@ -2110,7 +2110,7 @@ void check_result()
   const char* mess= "Result content mismatch\n";
 
   DBUG_ENTER("check_result");
-  DBUG_ASSERT(result_file_name);
+  assert(result_file_name);
   DBUG_PRINT("enter", ("result_file_name: %s", result_file_name));
 
   switch (compare_files(log_file.file_name(), result_file_name)) {
@@ -2428,7 +2428,7 @@ void var_set(const char *var_name, const char *var_name_end,
       v->str_val_len= strlen(v->str_val);
     }
     /* setenv() expects \0-terminated strings */
-    DBUG_ASSERT(v->name[v->name_len] == 0);
+    assert(v->name[v->name_len] == 0);
     setenv(v->name, v->str_val, 1);
   }
   DBUG_VOID_RETURN;
@@ -7278,7 +7278,7 @@ get_one_option(int optid, const struct my_option *opt, char *argument)
       argument= buff;
     }
     fn_format(buff, argument, "", "", MY_UNPACK_FILENAME);
-    DBUG_ASSERT(cur_file == file_stack && cur_file->file == 0);
+    assert(cur_file == file_stack && cur_file->file == 0);
     if (!(cur_file->file=
           fopen(buff, "rb")))
       die("Could not open '%s' for reading, errno: %d", buff, errno);
@@ -7902,7 +7902,7 @@ int append_warnings(DYNAMIC_STRING *ds, MYSQL* mysql)
     through PS API we should not issue SHOW WARNINGS until
     we have not read all results...
   */
-  DBUG_ASSERT(!mysql_more_results(mysql));
+  assert(!mysql_more_results(mysql));
 
   if (mysql_real_query(mysql, "SHOW WARNINGS", 13))
     die("Error running query \"SHOW WARNINGS\": %s", mysql_error(mysql));
@@ -8043,7 +8043,7 @@ void run_query_normal(struct st_connection *cn, struct st_command *command,
 		 mysql_sqlstate(mysql), ds);
     goto end;
   }
-  DBUG_ASSERT(err == -1); /* Successful and there are no more results */
+  assert(err == -1); /* Successful and there are no more results */
 
   /* If we come here the query is both executed and read successfully */
   handle_no_error(command);
@@ -10301,7 +10301,7 @@ void replace_strings_append(REPLACE *rep, DYNAMIC_STRING* ds,
       DBUG_PRINT("exit", ("Found end of from string"));
       DBUG_VOID_RETURN;
     }
-    DBUG_ASSERT(from <= str+len);
+    assert(from <= str+len);
     start= from;
     rep_pos=rep;
   }

dbug/user.r

@@ -867,14 +867,6 @@ EX:\fC
 .SP 1
 .LI DBUG_UNLOCK_FILE\ 
 Unlocks DBUG_FILE stream, that was locked with a DBUG_LOCK_FILE.
-.LI DBUG_ASSERT\ 
-This macro just does a regular assert(). The difference is that it will be
-disabled by DBUG_OFF togeher with the
-.I dbug
-library. So there will be no need to disable asserts separately with NDEBUG.
-.SP 1
-EX:\ \fCDBUG_ASSERT(\ a\ >\ 0\ );\fR
-.SP 1
 .LI DBUG_ABORT\ 
 This macro could be used instead of abort(). It flushes DBUG_FILE stream
 to ensure that no