Bug #30303461 REMOVE THE C MACRO ARRAY_ELLEMENTS

Remove the C macro version of array_elements.
Move the C++ template version of array_elements to template_utils.h

Remove usage of DBUG macros from template_utils.h, use the standard
assert() and -DNDEBUG instead.

Remove macros C_MODE_START and C_MODE_END
Most usage was obsolete, all code has been converted from C to C++
Some usage is still needed: in plugins, so use 'extern "C"' instead.

Change-Id: I2b81a6f07cf2e6a56078f4e716e2bdf96510d199

Author: Tor Didriksen

client/dump/sql_formatter_options.h

@@ -1,5 +1,5 @@
 /*
-  Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved.
+  Copyright (c) 2015, 2019, 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,
@@ -29,6 +29,7 @@
 
 #include "client/base/abstract_options_provider.h"
 #include "client/dump/mysql_chain_element_options.h"
+#include "template_utils.h"
 #include "typelib.h"
 
 namespace Mysql {

components/audit_api_message_emit/audit_api_message_emit.cc

@@ -33,14 +33,15 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
 
 #include <ctype.h>
 #include <my_dbug.h>
-#include <my_macros.h>
 #include <mysql/components/component_implementation.h>
 #include <mysql/components/my_service.h>
 #include <mysql/components/service_implementation.h>
 #include <mysql/components/services/audit_api_message_service.h>
 #include <mysql/components/services/udf_registration.h>
 #include <mysql/service_plugin_registry.h>
 #include <mysql_com.h>
+#include "template_utils.h"
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>

components/mysql_server/dynamic_loader.cc

@@ -45,6 +45,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
 #include "rwlock_scoped_lock.h"
 #include "scope_guard.h"
 #include "server_component.h"
+#include "template_utils.h"
 
 /**
   @page PAGE_COMPONENTS Component Subsystem

components/mysql_server/dynamic_loader_scheme_file.cc

@@ -37,6 +37,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
 #include "rwlock_scoped_lock.h"
 #include "scope_guard.h"
 #include "server_component.h"
+#include "template_utils.h"
 
 #ifdef HAVE_DLFCN_H
 #include <dlfcn.h>

components/mysql_server/registry.cc

@@ -32,6 +32,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
 #include "registry.h"
 #include "rwlock_scoped_lock.h"
 #include "server_component.h"
+#include "template_utils.h"
 
 /**
   @page PAGE_COMPONENTS_REGISTRY The Service Registry Service

include/m_ctype.h

@@ -20,14 +20,14 @@
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
 
+#ifndef M_CTYPE_INCLUDED
+#define M_CTYPE_INCLUDED
+
 /**
   @file include/m_ctype.h
   A better implementation of the UNIX ctype(3) library.
 */
 
-#ifndef _m_ctype_h
-#define _m_ctype_h
-
 #ifndef __cplusplus
 #include <stdbool.h>
 #endif
@@ -410,9 +410,7 @@ struct CHARSET_INFO {
 */
 
 extern MYSQL_PLUGIN_IMPORT CHARSET_INFO my_charset_bin;
-C_MODE_START
 extern MYSQL_PLUGIN_IMPORT CHARSET_INFO my_charset_latin1;
-C_MODE_END
 extern MYSQL_PLUGIN_IMPORT CHARSET_INFO my_charset_filename;
 extern MYSQL_PLUGIN_IMPORT CHARSET_INFO my_charset_utf8mb4_0900_ai_ci;
 extern MYSQL_PLUGIN_IMPORT CHARSET_INFO my_charset_utf8mb4_0900_bin;
@@ -745,4 +743,4 @@ static inline uint my_ismbchar(const CHARSET_INFO *cs, const uchar *str,
   ((s)->cset->strntoull((s), (a), (b), (c), (d), (e)))
 #define my_strntod(s, a, b, c, d) ((s)->cset->strntod((s), (a), (b), (c), (d)))
 
-#endif /* _m_ctype_h */
+#endif  // M_CTYPE_INCLUDED

include/m_string.h

@@ -21,8 +21,8 @@
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
 
-#ifndef _m_string_h
-#define _m_string_h
+#ifndef M_STRING_INCLUDED
+#define M_STRING_INCLUDED
 
 /**
   @file include/m_string.h
@@ -280,9 +280,7 @@ static constexpr int FLOATING_POINT_BUFFER{311 + DECIMAL_NOT_SPECIFIED};
   (DBL_DIG + 4 + MY_MAX(5, MAX_DECPT_FOR_F_FORMAT))
 
 extern char *int2str(long val, char *dst, int radix, int upcase);
-C_MODE_START
 extern char *int10_to_str(long val, char *dst, int radix);
-C_MODE_END
 extern const char *str2int(const char *src, int radix, long lower, long upper,
                            long *val);
 longlong my_strtoll10(const char *nptr, const char **endptr, int *error);
@@ -367,4 +365,4 @@ static inline void lex_cstring_set(LEX_CSTRING *lex_str, const char *c_str) {
   lex_str->length = strlen(c_str);
 }
 
-#endif
+#endif  // M_STRING_INCLUDED

include/my_byteorder.h

@@ -32,6 +32,8 @@
 
 #include "my_config.h"
 
+#include "my_compiler.h"
+
 #include <string.h>
 #include <sys/types.h>
 

include/my_macros.h

@@ -1,5 +1,5 @@
 /*
-   Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+   Copyright (c) 2016, 2019, 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,
@@ -30,19 +30,6 @@
   with code from \<algorithm\> or similar.
 */
 
-#ifndef MYSQL_ABI_CHECK
-#include <stddef.h>
-#endif
-
-/* Macros to make switching between C and C++ mode easier */
-#ifdef __cplusplus
-#define C_MODE_START extern "C" {
-#define C_MODE_END }
-#else
-#define C_MODE_START
-#define C_MODE_END
-#endif
-
 /* Make it easier to add conditional code in _expressions_ */
 #ifdef _WIN32
 #define IF_WIN(A, B) A
@@ -70,20 +57,4 @@
   } while (0)
 #define test_all_bits(a, b) (((a) & (b)) == (b))
 
-/* Bug in developerstudio: use the C version */
-#if defined(__cplusplus) && !defined(__SUNPRO_CC)
-
-template <class T, size_t N>
-constexpr size_t array_elements(T (&)[N]) noexcept {
-  return N;
-}
-
-#else
-
-// Less type-safe version that e.g. allows sending in pointers
-// or STL containers without an error.
-#define array_elements(A) ((size_t)(sizeof(A) / sizeof(A[0])))
-
-#endif
-
 #endif  // MY_MACROS_INCLUDED

include/sslopt-vars.h

@@ -32,6 +32,7 @@
 #include "m_string.h"
 #include "my_inttypes.h"
 #include "mysql.h"
+#include "template_utils.h"
 #include "typelib.h"
 
 #if defined(HAVE_OPENSSL)

include/template_utils.h

@@ -23,9 +23,9 @@
 #ifndef TEMPLATE_UTILS_INCLUDED
 #define TEMPLATE_UTILS_INCLUDED
 
+#include <assert.h>
 #include <stddef.h>
-
-#include "my_dbug.h"
+#include <type_traits>
 
 /**
   @file include/template_utils.h
@@ -89,7 +89,7 @@ inline const T pointer_cast(const void *p) {
 */
 template <typename Target, typename Source>
 inline Target down_cast(Source *arg) {
-  DBUG_ASSERT(NULL != dynamic_cast<Target>(arg));
+  assert(nullptr != dynamic_cast<Target>(arg));
   return static_cast<Target>(arg);
 }
 
@@ -109,8 +109,8 @@ inline Target down_cast(Source &arg) {
   // We still use the pointer version of dynamic_cast, as the
   // reference-accepting version throws exceptions, and we don't want to deal
   // with that.
-  DBUG_ASSERT(dynamic_cast<typename std::remove_reference<Target>::type *>(
-                  &arg) != nullptr);
+  assert(dynamic_cast<typename std::remove_reference<Target>::type *>(&arg) !=
+         nullptr);
   return static_cast<Target>(arg);
 }
 
@@ -144,4 +144,12 @@ struct ReturnValueOrError {
   bool error;
 };
 
+/**
+   Number of elements in a constant C array.
+ */
+template <class T, size_t N>
+constexpr size_t array_elements(T (&)[N]) noexcept {
+  return N;
+}
+
 #endif  // TEMPLATE_UTILS_INCLUDED

libmysql/errmsg.cc

@@ -30,6 +30,7 @@
 
 #include "errmsg.h"
 #include "my_sys.h"
+#include "template_utils.h"
 
 const char *client_errors[] = {
     "Unknown MySQL error",

mysys/stacktrace.cc

@@ -46,6 +46,7 @@
 #include "my_inttypes.h"
 #include "my_macros.h"
 #include "my_stacktrace.h"
+#include "template_utils.h"
 
 #ifndef _WIN32
 #include <signal.h>

mysys/thr_lock.cc

@@ -107,6 +107,7 @@ lock at the same time as multiple read locks.
 #include "mysql/psi/psi_stage.h"
 #include "mysql/psi/psi_table.h"
 #include "mysys/mysys_priv.h"
+#include "template_utils.h"
 #include "thr_lock.h"
 #include "thr_mutex.h"
 

plugin/group_replication/libmysqlgcs/src/interface/gcs_psi.cc

@@ -25,6 +25,7 @@
 
 #include "mysql/psi/mysql_memory.h"
 #include "mysql/psi/mysql_thread.h"
+#include "template_utils.h"
 
 PSI_thread_key key_GCS_THD_Gcs_ext_logger_impl_m_consumer,
     key_GCS_THD_Gcs_xcom_engine_m_engine_thread,

plugin/x/tests/driver/connector/session_holder.cc

@@ -25,6 +25,7 @@
 #include "plugin/x/tests/driver/connector/session_holder.h"
 
 #include "my_dbug.h"
+#include "template_utils.h"
 
 #include "plugin/x/tests/driver/connector/mysqlx_all_msgs.h"
 

sql-common/client_plugin.cc

@@ -61,6 +61,7 @@
 #include "mysql/psi/mysql_mutex.h"
 #include "mysql/service_mysql_alloc.h"
 #include "sql_common.h"
+#include "template_utils.h"
 
 #ifdef HAVE_DLFCN_H
 #include <dlfcn.h>

sql-common/compression.cc

@@ -22,6 +22,7 @@
 
 #include "compression.h"
 #include "m_ctype.h"
+#include "my_dbug.h"
 #include "my_sys.h"
 #include "mysqld_error.h"
 

sql/derror.cc

@@ -33,7 +33,6 @@
 #include "my_inttypes.h"
 #include "my_io.h"
 #include "my_loglevel.h"
-#include "my_macros.h"
 #include "my_sys.h"
 #include "mysql/components/services/log_builtins.h"
 #include "mysql/psi/mysql_file.h"
@@ -139,8 +138,6 @@ static const char *error_message_fetch(int mysql_errno) {
   return nullptr;
 }
 
-C_MODE_START
-
 /**
   Get the error-message corresponding to the given MySQL error-code,
   or nullptr if no message is available for that code (this may indicate
@@ -179,7 +176,6 @@ const char *error_message_for_client(int mysql_errno) {
 
   return error_message_fetch(mysql_errno);
 }
-C_MODE_END
 
 bool init_errmessage() {
   DBUG_TRACE;

sql/derror.h

@@ -27,7 +27,6 @@
 #include <sys/types.h>
 
 #include "my_inttypes.h"
-#include "my_macros.h"
 
 #ifdef EXTRA_CODE_FOR_UNIT_TESTING
 #include "mysqld_error.h"
@@ -109,10 +108,8 @@ const char *ER_THD(const THD *thd, int mysql_errno);
 const char *ER_DEFAULT_NONCONST(int mysql_errno);
 const char *ER_THD_NONCONST(const THD *thd, int mysql_errno);
 
-C_MODE_START
 const char *error_message_for_error_log(int mysql_errno);
 const char *error_message_for_client(int mysql_errno);
-C_MODE_END
 
 const char *mysql_errno_to_symbol(int mysql_errno);
 int mysql_symbol_to_errno(const char *error_symbol);

sql/gen_keyword_list.cc

@@ -30,7 +30,8 @@
 #include <map>
 #include <set>
 
-#include "lex.h"                       // symbols[]
+#include "lex.h"  // symbols[]
+#include "template_utils.h"
 #include "welcome_copyright_notice.h"  // ORACLE_WELCOME_COPYRIGHT_NOTICE
 
 using icu::RegexMatcher;

sql/gen_lex_hash.cc

@@ -1,5 +1,5 @@
 /*
-   Copyright (c) 2000, 2018, Oracle and/or its affiliates. All rights reserved.
+   Copyright (c) 2000, 2019, 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,
@@ -92,9 +92,9 @@ So, we can read full search-structure as 32-bit word
 #include <utility>
 
 #include "my_inttypes.h"
-#include "my_macros.h"
 #include "sql/lex.h"
 #include "sql/lex_symbol.h"
+#include "template_utils.h"
 #include "welcome_copyright_notice.h" /* ORACLE_WELCOME_COPYRIGHT_NOTICE */
 
 static bool check_duplicates(uint group_mask);

sql/mysqld.cc

@@ -9609,8 +9609,6 @@ bool mysqld_get_one_option(int optid,
 
 /** Handle arguments for multiple key caches. */
 
-C_MODE_START
-
 static void *mysql_getopt_value(const char *keyname, size_t key_length,
                                 const struct my_option *option, int *error) {
   if (error) *error = 0;
@@ -9639,8 +9637,6 @@ static void *mysql_getopt_value(const char *keyname, size_t key_length,
   return option->value;
 }
 
-C_MODE_END
-
 /**
   Get server options from the command line,
   and perform related server initializations.

sql/psi_memory_key.cc

@@ -22,12 +22,12 @@
 
 #include "sql/psi_memory_key.h"
 
-#include "my_macros.h"
 #include "my_psi_config.h"
 #include "mysql/components/services/psi_memory_bits.h"
 #include "mysql/psi/mysql_memory.h"
 #include "mysql/psi/psi_base.h"  // PSI_FLAG_ONLY_GLOBAL_STAT
 #include "mysql/psi/psi_memory.h"
+#include "template_utils.h"
 
 /*
   MAINTAINER: Please keep this list in order, to limit merge collisions.

sql/stream_cipher.cc

@@ -23,6 +23,7 @@
 #include "sql/stream_cipher.h"
 #include <algorithm>
 #include "my_byteorder.h"
+#include "my_dbug.h"
 
 #define HAVE_BYTESTOKEY_SHA512_HANDLING
 #define HAVE_DECRYPTION_INTO_SAME_SOURCE_BUFFER