Bug #26781567: REMOVE C LEGACY [noclose]

Rename st_mem_root to MEM_ROOT (with no typedef), which means we no longer need
to jump through hoops with a separate .h file to forward-declare it.

Change-Id: I672415c4821f4feccbb93eeea789ee1218931dbd

Author: Steinar H. Gunderson

include/CMakeLists.txt

@@ -21,7 +21,6 @@
 # automatically generated.
 SET(HEADERS
   errmsg.h
-  mem_root_fwd.h
   my_command.h
   my_list.h
   mysql.h

include/mem_root_fwd.h

@@ -21,8 +21,6 @@
 #ifndef _my_alloc_h
 #define _my_alloc_h
 
-#include <stdbool.h>
-
 /*
   How much overhead does malloc have. The code often allocates
   something like 1024-MALLOC_OVERHEAD bytes
@@ -35,19 +33,18 @@
 #define ALLOC_MAX_BLOCK_TO_DROP			4096
 #define ALLOC_MAX_BLOCK_USAGE_BEFORE_DROP	10
 
+#include <stdbool.h>
 #include <string.h>
 #include <sys/types.h>
 
+#include <memory>
+#include <new>
+
 #include "my_compiler.h"
 #include "my_inttypes.h"
 #include "mysql/psi/psi_memory.h"
 
-#include "mem_root_fwd.h"  // Contains the typedef to MEM_ROOT. IWYU pragma: keep
-
-#ifdef __cplusplus
-
-#include <memory>
-#include <new>
+struct MEM_ROOT;
 
 extern "C" {
 
@@ -59,8 +56,6 @@ extern void init_alloc_root(PSI_memory_key key,
 
 }
 
-#endif
-
 typedef struct st_used_mem
 {				   /* struct for once_alloc (block) */
   struct st_used_mem *next;	   /* Next block in use */
@@ -69,29 +64,28 @@ typedef struct st_used_mem
 } USED_MEM;
 
 
-struct st_mem_root
+struct MEM_ROOT
 {
-#ifdef __cplusplus
-  st_mem_root() :
+  MEM_ROOT() :
     free(nullptr), used(nullptr), pre_alloc(nullptr),
     min_malloc(0) // for alloc_root_inited()
   {}
 
-  st_mem_root(PSI_memory_key key, size_t block_size, size_t pre_alloc_size)
+  MEM_ROOT(PSI_memory_key key, size_t block_size, size_t pre_alloc_size)
   {
     init_alloc_root(key, this, block_size, pre_alloc_size);
   }
 
   // Make the class movable but not copyable.
-  st_mem_root(const st_mem_root &) = delete;
-  st_mem_root(st_mem_root &&other) noexcept {
+  MEM_ROOT(const MEM_ROOT &) = delete;
+  MEM_ROOT(MEM_ROOT &&other) noexcept {
     memcpy(this, &other, sizeof(*this));
     other.free= other.used= other.pre_alloc= nullptr;
     other.min_malloc= 0;
   }
 
-  st_mem_root& operator= (const st_mem_root &) = delete;
-  st_mem_root& operator= (st_mem_root &&other) noexcept {
+  MEM_ROOT& operator= (const MEM_ROOT &) = delete;
+  MEM_ROOT& operator= (MEM_ROOT &&other) noexcept {
     memcpy(this, &other, sizeof(*this));
     other.free= other.used= other.pre_alloc= nullptr;
     other.min_malloc= 0;
@@ -103,13 +97,11 @@ struct st_mem_root
     It's harmless to call free_root() multiple times, and thus also to call
     free_root() on a to-be-destructed object.
   */
-  ~st_mem_root()
+  ~MEM_ROOT()
   {
     free_root(this, MYF(0));
   }
 
-#endif
-
   USED_MEM *free;                  /* blocks with free memory in it */
   USED_MEM *used;                  /* blocks almost without free memory */
   USED_MEM *pre_alloc;             /* preallocated block */
@@ -141,7 +133,6 @@ struct st_mem_root
   PSI_memory_key m_psi_key;
 };
 
-#ifdef __cplusplus
 /**
   Allocate an object of the given type. Use like this:
 
@@ -200,6 +191,4 @@ class Destroy_only
 template<class T>
 using unique_ptr_destroy_only = std::unique_ptr<T, Destroy_only<T>>;
 
-#endif  // __cplusplus
-
 #endif

include/my_alloc.h

@@ -23,7 +23,6 @@
 #include <stddef.h>
 #include <sys/types.h>
 
-#include "mem_root_fwd.h"
 #include "my_alloc.h"           /* MEM_ROOT */
 #include "my_base.h"		/* get 'enum ha_rkey_function' */
 #include "my_inttypes.h"

include/my_tree.h

@@ -66,7 +66,6 @@ typedef int my_socket;
 
 
 #include "binary_log_types.h"
-#include "mem_root_fwd.h"
 #include "my_list.h"
 #include "mysql_com.h"
 
@@ -147,11 +146,13 @@ typedef struct st_mysql_rows {
 
 typedef MYSQL_ROWS *MYSQL_ROW_OFFSET;	/* offset to current row */
 
+struct MEM_ROOT;
+
 typedef struct embedded_query_result EMBEDDED_QUERY_RESULT;
 typedef struct st_mysql_data {
   MYSQL_ROWS *data;
   struct embedded_query_result *embedded_info;
-  MEM_ROOT *alloc;
+  struct MEM_ROOT *alloc;
   my_ulonglong rows;
   unsigned int fields;
   /* extra info for embedded library */
@@ -281,7 +282,7 @@ typedef struct st_mysql
   char          *info, *db;
   struct charset_info_st *charset;
   MYSQL_FIELD	*fields;
-  MEM_ROOT	*field_alloc;
+  struct MEM_ROOT *field_alloc;
   my_ulonglong affected_rows;
   my_ulonglong insert_id;		/* id if insert on table with NEXTNR */
   my_ulonglong extra_info;		/* Not used */
@@ -329,7 +330,7 @@ typedef struct st_mysql_res {
   const struct st_mysql_methods *methods;
   MYSQL_ROW	row;			/* If unbuffered read */
   MYSQL_ROW	current_row;		/* buffer to current row */
-  MEM_ROOT	*field_alloc;
+  struct MEM_ROOT *field_alloc;
   unsigned int	field_count, current_field;
   bool	eof;			        /* Used by mysql_fetch_row */
   /* mysql_stmt_close() had to cancel this result */
@@ -655,7 +656,7 @@ struct st_mysql_stmt_extension;
 /* statement handler */
 typedef struct st_mysql_stmt
 {
-  MEM_ROOT       *mem_root;             /* root allocations */
+  struct MEM_ROOT *mem_root;             /* root allocations */
   LIST           list;                 /* list to keep track of all stmts */
   MYSQL          *mysql;               /* connection handle */
   MYSQL_BIND     *params;              /* input parameters */

include/mysql.h

@@ -26,9 +26,6 @@
   MYSQL_TYPE_STRING=254,
   MYSQL_TYPE_GEOMETRY=255
 } enum_field_types;
-#include "mem_root_fwd.h"
-struct st_mem_root;
-typedef struct st_mem_root MEM_ROOT;
 #include "my_list.h"
 typedef struct st_list {
   struct st_list *prev,*next;
@@ -348,11 +345,12 @@
   unsigned long length;
 } MYSQL_ROWS;
 typedef MYSQL_ROWS *MYSQL_ROW_OFFSET;
+struct MEM_ROOT;
 typedef struct embedded_query_result EMBEDDED_QUERY_RESULT;
 typedef struct st_mysql_data {
   MYSQL_ROWS *data;
   struct embedded_query_result *embedded_info;
-  MEM_ROOT *alloc;
+  struct MEM_ROOT *alloc;
   my_ulonglong rows;
   unsigned int fields;
   void *extension;
@@ -455,7 +453,7 @@
   char *info, *db;
   struct charset_info_st *charset;
   MYSQL_FIELD *fields;
-  MEM_ROOT *field_alloc;
+  struct MEM_ROOT *field_alloc;
   my_ulonglong affected_rows;
   my_ulonglong insert_id;
   my_ulonglong extra_info;
@@ -493,7 +491,7 @@
   const struct st_mysql_methods *methods;
   MYSQL_ROW row;
   MYSQL_ROW current_row;
-  MEM_ROOT *field_alloc;
+  struct MEM_ROOT *field_alloc;
   unsigned int field_count, current_field;
   bool eof;
   bool unbuffered_fetch_cancelled;
@@ -670,7 +668,7 @@
 struct st_mysql_stmt_extension;
 typedef struct st_mysql_stmt
 {
-  MEM_ROOT *mem_root;
+  struct MEM_ROOT *mem_root;
   LIST list;
   MYSQL *mysql;
   MYSQL_BIND *params;

include/mysql.h.pp

@@ -24,9 +24,9 @@
   MAINTAINER:
   Note that this file is part of the public API,
   because mysql.h exports
-    struct st_mem_root
+    struct MEM_ROOT
   See
-    - PSI_memory_key st_mem_root::m_psi_key
+    - PSI_memory_key MEM_ROOT::m_psi_key
     - include/mysql.h.pp
 */
 

include/mysql/psi/psi_memory.h

@@ -27,13 +27,14 @@
 #include <sys/types.h>
 
 #include "errmsg.h"
-#include "mem_root_fwd.h"
 #include "my_command.h"
 #include "my_compiler.h"
 #include "my_inttypes.h"
 #include "my_list.h"
 #include "mysql_com.h"
 
+struct MEM_ROOT;
+
 #ifdef	__cplusplus
 extern "C" {
 #endif

include/sql_common.h

@@ -30,7 +30,6 @@
 #include "lex_string.h"
 #include "m_ctype.h"                         // my_convert
 #include "m_string.h"                        // LEX_CSTRING
-#include "mem_root_fwd.h"
 #include "my_byteorder.h"
 #include "my_compiler.h"
 #include "my_dbug.h"
@@ -41,6 +40,8 @@
 #include "mysql/psi/psi_memory.h"
 #include "mysql/service_mysql_alloc.h"       // my_free
 
+struct MEM_ROOT;
+
 #ifdef MYSQL_SERVER
 extern "C" {
 extern PSI_memory_key key_memory_String_value;

include/sql_string.h

@@ -21,9 +21,10 @@
   @file include/typelib.h
 */
 
-#include "mem_root_fwd.h"
 #include "my_inttypes.h"
 
+struct MEM_ROOT;
+
 #ifdef __cplusplus
 extern "C" {
 #endif

include/typelib.h

@@ -465,7 +465,6 @@ class Opt_trace_object;
 class SELECT_LEX;
 class THD;
 struct TABLE_LIST;
-struct st_mem_root;
 template <class T> class List;
 
 /**
@@ -577,7 +576,7 @@ class Group_check: public Item_tree_walker, public Sql_alloc
 {
 public:
 
-  Group_check(SELECT_LEX *select_arg, st_mem_root *root)
+  Group_check(SELECT_LEX *select_arg, MEM_ROOT *root)
     : select(select_arg), search_in_underlying(false),
     non_null_in_source(false),
     table(NULL), group_in_fd(~0ULL), m_root(root), fd(root),
@@ -639,7 +638,7 @@ class Group_check: public Item_tree_walker, public Sql_alloc
   ulonglong group_in_fd;
 
   /// Memory for allocations (like of 'fd')
-  st_mem_root *const m_root;
+  MEM_ROOT *const m_root;
 
   /**
      Columns which are local to 'select' and functionally dependent on an
@@ -660,7 +659,7 @@ class Group_check: public Item_tree_walker, public Sql_alloc
   bool is_child() const { return table != NULL; }
 
   /// Private ctor, for a Group_check to build a child Group_check
-  Group_check(SELECT_LEX *select_arg, st_mem_root *root,
+  Group_check(SELECT_LEX *select_arg, MEM_ROOT *root,
               TABLE_LIST *table_arg)
     : select(select_arg), search_in_underlying(false),
     non_null_in_source(false), table(table_arg),

sql/aggregate_check.h

@@ -32,7 +32,6 @@
 #include "lf.h"
 #include "m_ctype.h"
 #include "map_helpers.h"
-#include "mem_root_fwd.h"
 #include "mf_wcomp.h"                   // wild_many, wild_one, wild_prefix
 #include "my_alloc.h"
 #include "my_inttypes.h"
@@ -60,8 +59,8 @@
 #include "typelib.h"
 #include "violite.h"                    // SSL_type
 
+struct MEM_ROOT;
 class Security_context;
-/* Forward Declarations */
 class String;
 class THD;
 struct TABLE;

sql/auth/sql_auth_cache.h

@@ -16,10 +16,10 @@
 #ifndef DD_TABLESPACE_INCLUDED
 #define DD_TABLESPACE_INCLUDED
 
-#include "mem_root_fwd.h"
 #include "sql/lock.h"                // Tablespace_hash_set
 #include "sql/thr_malloc.h"
 
+struct MEM_ROOT;
 class THD;
 class st_alter_tablespace;
 struct handlerton;

sql/dd/dd_tablespace.h

@@ -19,10 +19,10 @@
 #include "lex_string.h"
 #include "sql/trigger_def.h" // enum_trigger_order_type
 
+struct MEM_ROOT;
 class THD;
 class Trigger;
 
-typedef struct st_mem_root MEM_ROOT;
 template <class T> class List;
 
 namespace dd