WL#16221 : Revert all C API removals from 8.X and make it equivalent to 8.0

In MySQL 8.3 and 8.4, the following C-APIs were removed:

- MYSQL_OPT_RECONNECT
- mysql_stmt_bind_param()
- mysql_shutdown()
- mysql_ssl_set()
- mysql_refresh()
- mysql_reload()
- mysql_list_fields()
- mysql_list_processes()
- mysql_kill()

This WL intends to restore them back.

Also, few of the above mentioned APIs used to have few deprecated
COM_XXX commands which were removed in MySQL 8.3.

In this implementation of the C-APIs, the deprecated commands
are not being used, instead, mysql_real_query is used.

Only for mysql_list_fields, COM_FIELD_LIST has been restored.

main.kill has few tests disable within. They will be addressed
via separate bug.

Change-Id: I00bf6eb4c9cf29f3189f18fceb5b67b80719b979

Author: shussinh

include/my_command.h

@@ -51,10 +51,10 @@ enum enum_server_command {
     Also used internally to mark the start of a session.
   */
   COM_SLEEP,
-  COM_QUIT,      /**< See @ref page_protocol_com_quit */
-  COM_INIT_DB,   /**< See @ref page_protocol_com_init_db */
-  COM_QUERY,     /**< See @ref page_protocol_com_query */
-  COM_UNUSED_3,  /**< Removed, used to be COM_FIELD_LIST */
+  COM_QUIT,       /**< See @ref page_protocol_com_quit */
+  COM_INIT_DB,    /**< See @ref page_protocol_com_init_db */
+  COM_QUERY,      /**< See @ref page_protocol_com_query */
+  COM_FIELD_LIST, /**< Deprecated. See @ref page_protocol_com_field_list */
   COM_CREATE_DB, /**< Currently refused by the server. See ::dispatch_command */
   COM_DROP_DB,   /**< Currently refused by the server. See ::dispatch_command */
   COM_UNUSED_2,  /**< Removed, used to be COM_REFRESH. */

include/mysql.h

@@ -125,6 +125,7 @@ typedef struct MYSQL_FIELD {
   char *org_table;          /* Org table name, if table was an alias */
   char *db;                 /* Database for table */
   char *catalog;            /* Catalog for table */
+  char *def;                /* Default value (set by mysql_list_fields) */
   unsigned long length;     /* Width of column (create length) */
   unsigned long max_length; /* Max width for selected set */
   unsigned int name_length;
@@ -133,6 +134,7 @@ typedef struct MYSQL_FIELD {
   unsigned int org_table_length;
   unsigned int db_length;
   unsigned int catalog_length;
+  unsigned int def_length;
   unsigned int flags;         /* Div flags */
   unsigned int decimals;      /* Number of decimals in field */
   unsigned int charsetnr;     /* Character set */
@@ -181,6 +183,7 @@ enum mysql_option {
   MYSQL_OPT_WRITE_TIMEOUT,
   MYSQL_OPT_USE_RESULT,
   MYSQL_REPORT_DATA_TRUNCATION,
+  MYSQL_OPT_RECONNECT,
   MYSQL_PLUGIN_DIR,
   MYSQL_DEFAULT_AUTH,
   MYSQL_OPT_BIND,
@@ -317,7 +320,8 @@ typedef struct MYSQL {
   struct st_mysql_options options;
   enum mysql_status status;
   enum enum_resultset_metadata resultset_metadata;
-  bool free_me; /* If free in mysql_close */
+  bool free_me;   /* If free in mysql_close */
+  bool reconnect; /* set to 1 if automatic reconnect */
 
   /* session-wide random string */
   char scramble[SCRAMBLE_LENGTH + 1];
@@ -465,6 +469,9 @@ const char *STDCALL mysql_character_set_name(MYSQL *mysql);
 int STDCALL mysql_set_character_set(MYSQL *mysql, const char *csname);
 
 MYSQL *STDCALL mysql_init(MYSQL *mysql);
+bool STDCALL mysql_ssl_set(MYSQL *mysql, const char *key, const char *cert,
+                           const char *ca, const char *capath,
+                           const char *cipher);
 const char *STDCALL mysql_get_ssl_cipher(MYSQL *mysql);
 bool STDCALL mysql_get_ssl_session_reused(MYSQL *mysql);
 void *STDCALL mysql_get_ssl_session_data(MYSQL *mysql, unsigned int n_ticket,
@@ -518,7 +525,11 @@ void mysql_set_local_infile_handler(
     int (*local_infile_error)(void *, char *, unsigned int), void *);
 
 void mysql_set_local_infile_default(MYSQL *mysql);
+int STDCALL mysql_shutdown(MYSQL *mysql,
+                           enum mysql_enum_shutdown_level shutdown_level);
 int STDCALL mysql_dump_debug_info(MYSQL *mysql);
+int STDCALL mysql_refresh(MYSQL *mysql, unsigned int refresh_options);
+int STDCALL mysql_kill(MYSQL *mysql, unsigned long pid);
 int STDCALL mysql_set_server_option(MYSQL *mysql,
                                     enum enum_mysql_set_option option);
 int STDCALL mysql_ping(MYSQL *mysql);
@@ -531,6 +542,7 @@ unsigned long STDCALL mysql_get_server_version(MYSQL *mysql);
 unsigned int STDCALL mysql_get_proto_info(MYSQL *mysql);
 MYSQL_RES *STDCALL mysql_list_dbs(MYSQL *mysql, const char *wild);
 MYSQL_RES *STDCALL mysql_list_tables(MYSQL *mysql, const char *wild);
+MYSQL_RES *STDCALL mysql_list_processes(MYSQL *mysql);
 int STDCALL mysql_options(MYSQL *mysql, enum mysql_option option,
                           const void *arg);
 int STDCALL mysql_options4(MYSQL *mysql, enum mysql_option option,
@@ -550,6 +562,8 @@ enum net_async_status STDCALL mysql_fetch_row_nonblocking(MYSQL_RES *res,
 
 unsigned long *STDCALL mysql_fetch_lengths(MYSQL_RES *result);
 MYSQL_FIELD *STDCALL mysql_fetch_field(MYSQL_RES *result);
+MYSQL_RES *STDCALL mysql_list_fields(MYSQL *mysql, const char *table,
+                                     const char *wild);
 unsigned long STDCALL mysql_escape_string(char *to, const char *from,
                                           unsigned long from_length);
 unsigned long STDCALL mysql_hex_string(char *to, const char *from,
@@ -590,7 +604,7 @@ enum enum_mysql_stmt_state {
   internally by the client library.
   Public members with their descriptions are listed below
   (conventionally `On input' refers to the binds given to
-  mysql_stmt_bind_named_param, `On output' refers to the binds given
+  mysql_stmt_bind_param, `On output' refers to the binds given
   to mysql_stmt_bind_result):
 
   buffer_type    - One of the MYSQL_* types, used to describe
@@ -603,7 +617,7 @@ enum enum_mysql_stmt_state {
                    output data.
                    The type of memory pointed by buffer must correspond
                    to buffer_type. See the correspondence table in
-                   the comment to mysql_stmt_bind_named_param.
+                   the comment to mysql_stmt_bind_param.
 
   The two above members are mandatory for any kind of bind.
 
@@ -759,6 +773,7 @@ bool STDCALL mysql_stmt_attr_set(MYSQL_STMT *stmt,
 bool STDCALL mysql_stmt_attr_get(MYSQL_STMT *stmt,
                                  enum enum_stmt_attr_type attr_type,
                                  void *attr);
+bool STDCALL mysql_stmt_bind_param(MYSQL_STMT *stmt, MYSQL_BIND *bnd);
 bool STDCALL mysql_stmt_bind_named_param(MYSQL_STMT *stmt, MYSQL_BIND *binds,
                                          unsigned n_params, const char **names);
 bool STDCALL mysql_stmt_bind_result(MYSQL_STMT *stmt, MYSQL_BIND *bnd);
@@ -797,6 +812,8 @@ void STDCALL mysql_reset_server_public_key(void);
 #define MYSQL_NO_DATA 100
 #define MYSQL_DATA_TRUNCATED 101
 
+#define mysql_reload(mysql) mysql_refresh((mysql), REFRESH_GRANT)
+
 #define HAVE_MYSQL_REAL_CONNECT
 
 MYSQL *STDCALL mysql_real_connect_dns_srv(MYSQL *mysql,

include/mysql.h.pp

@@ -58,7 +58,7 @@
   COM_QUIT,
   COM_INIT_DB,
   COM_QUERY,
-  COM_UNUSED_3,
+  COM_FIELD_LIST,
   COM_CREATE_DB,
   COM_DROP_DB,
   COM_UNUSED_2,
@@ -386,6 +386,7 @@
   char *org_table;
   char *db;
   char *catalog;
+  char *def;
   unsigned long length;
   unsigned long max_length;
   unsigned int name_length;
@@ -394,6 +395,7 @@
   unsigned int org_table_length;
   unsigned int db_length;
   unsigned int catalog_length;
+  unsigned int def_length;
   unsigned int flags;
   unsigned int decimals;
   unsigned int charsetnr;
@@ -431,6 +433,7 @@
   MYSQL_OPT_WRITE_TIMEOUT,
   MYSQL_OPT_USE_RESULT,
   MYSQL_REPORT_DATA_TRUNCATION,
+  MYSQL_OPT_RECONNECT,
   MYSQL_PLUGIN_DIR,
   MYSQL_DEFAULT_AUTH,
   MYSQL_OPT_BIND,
@@ -549,6 +552,7 @@
   enum mysql_status status;
   enum enum_resultset_metadata resultset_metadata;
   bool free_me;
+  bool reconnect;
   char scramble[20 + 1];
   LIST *stmts;
   const struct MYSQL_METHODS *methods;
@@ -610,6 +614,9 @@
 const char * mysql_character_set_name(MYSQL *mysql);
 int mysql_set_character_set(MYSQL *mysql, const char *csname);
 MYSQL * mysql_init(MYSQL *mysql);
+bool mysql_ssl_set(MYSQL *mysql, const char *key, const char *cert,
+                   const char *ca, const char *capath,
+                   const char *cipher);
 const char * mysql_get_ssl_cipher(MYSQL *mysql);
 bool mysql_get_ssl_session_reused(MYSQL *mysql);
 void * mysql_get_ssl_session_data(MYSQL *mysql, unsigned int n_ticket,
@@ -656,7 +663,11 @@
     void (*local_infile_end)(void *),
     int (*local_infile_error)(void *, char *, unsigned int), void *);
 void mysql_set_local_infile_default(MYSQL *mysql);
+int mysql_shutdown(MYSQL *mysql,
+                           enum mysql_enum_shutdown_level shutdown_level);
 int mysql_dump_debug_info(MYSQL *mysql);
+int mysql_refresh(MYSQL *mysql, unsigned int refresh_options);
+int mysql_kill(MYSQL *mysql, unsigned long pid);
 int mysql_set_server_option(MYSQL *mysql,
                                     enum enum_mysql_set_option option);
 int mysql_ping(MYSQL *mysql);
@@ -669,6 +680,7 @@
 unsigned int mysql_get_proto_info(MYSQL *mysql);
 MYSQL_RES * mysql_list_dbs(MYSQL *mysql, const char *wild);
 MYSQL_RES * mysql_list_tables(MYSQL *mysql, const char *wild);
+MYSQL_RES * mysql_list_processes(MYSQL *mysql);
 int mysql_options(MYSQL *mysql, enum mysql_option option,
                           const void *arg);
 int mysql_options4(MYSQL *mysql, enum mysql_option option,
@@ -687,6 +699,8 @@
                                                           MYSQL_ROW *row);
 unsigned long * mysql_fetch_lengths(MYSQL_RES *result);
 MYSQL_FIELD * mysql_fetch_field(MYSQL_RES *result);
+MYSQL_RES * mysql_list_fields(MYSQL *mysql, const char *table,
+                                     const char *wild);
 unsigned long mysql_escape_string(char *to, const char *from,
                                           unsigned long from_length);
 unsigned long mysql_hex_string(char *to, const char *from,
@@ -786,6 +800,7 @@
 bool mysql_stmt_attr_get(MYSQL_STMT *stmt,
                                  enum enum_stmt_attr_type attr_type,
                                  void *attr);
+bool mysql_stmt_bind_param(MYSQL_STMT *stmt, MYSQL_BIND *bnd);
 bool mysql_stmt_bind_named_param(MYSQL_STMT *stmt, MYSQL_BIND *binds,
                                  unsigned n_params, const char **names);
 bool mysql_stmt_bind_result(MYSQL_STMT *stmt, MYSQL_BIND *bnd);

include/mysql/com_data.h

@@ -94,6 +94,13 @@ struct COM_QUERY_DATA {
   unsigned long parameter_count;
 };
 
+struct COM_FIELD_LIST_DATA {
+  unsigned char *table_name;
+  unsigned int table_name_length;
+  const unsigned char *query;
+  unsigned int query_length;
+};
+
 union COM_DATA {
   COM_INIT_DB_DATA com_init_db;
   COM_SET_OPTION_DATA com_set_option;
@@ -104,6 +111,7 @@ union COM_DATA {
   COM_STMT_CLOSE_DATA com_stmt_close;
   COM_STMT_RESET_DATA com_stmt_reset;
   COM_QUERY_DATA com_query;
+  COM_FIELD_LIST_DATA com_field_list;
 };
 
 #endif /* PLUGIN_PROTOCOL_INCLUDED */

include/mysql/plugin_audit.h.pp

@@ -142,7 +142,7 @@
   COM_QUIT,
   COM_INIT_DB,
   COM_QUERY,
-  COM_UNUSED_3,
+  COM_FIELD_LIST,
   COM_CREATE_DB,
   COM_DROP_DB,
   COM_UNUSED_2,

include/mysql/services.h.pp

@@ -49,6 +49,12 @@
   PS_PARAM *parameters;
   unsigned long parameter_count;
 };
+struct COM_FIELD_LIST_DATA {
+  unsigned char *table_name;
+  unsigned int table_name_length;
+  const unsigned char *query;
+  unsigned int query_length;
+};
 union COM_DATA {
   COM_INIT_DB_DATA com_init_db;
   COM_SET_OPTION_DATA com_set_option;
@@ -59,6 +65,7 @@
   COM_STMT_CLOSE_DATA com_stmt_close;
   COM_STMT_RESET_DATA com_stmt_reset;
   COM_QUERY_DATA com_query;
+  COM_FIELD_LIST_DATA com_field_list;
 };
 #include "mysql/service_srv_session.h"
 #include "mysql/service_srv_session_bits.h"

include/sql_common.h

@@ -212,6 +212,7 @@ struct MYSQL_METHODS {
   void (*flush_use_result)(MYSQL *mysql, bool flush_all_results);
   int (*read_change_user_result)(MYSQL *mysql);
 #if !defined(MYSQL_SERVER) && !defined(MYSQL_COMPONENT)
+  MYSQL_FIELD *(*list_fields)(MYSQL *mysql);
   bool (*read_prepare_result)(MYSQL *mysql, MYSQL_STMT *stmt);
   int (*stmt_execute)(MYSQL_STMT *stmt);
   int (*read_binary_rows)(MYSQL_STMT *stmt);
@@ -257,6 +258,9 @@ struct MYSQL_METHODS {
           1))
 
 extern CHARSET_INFO *default_client_charset_info;
+MYSQL_FIELD *unpack_fields(MYSQL *mysql, MYSQL_ROWS *data, MEM_ROOT *alloc,
+                           uint fields, bool default_value,
+                           uint server_capabilities);
 MYSQL_FIELD *cli_read_metadata_ex(MYSQL *mysql, MEM_ROOT *alloc,
                                   unsigned long field_count,
                                   unsigned int fields);

libmysql/CMakeLists.txt

@@ -56,7 +56,10 @@ SET(CLIENT_API_FUNCTIONS
   mysql_info
   mysql_init
   mysql_insert_id
+  mysql_kill
   mysql_list_dbs
+  mysql_list_fields
+  mysql_list_processes
   mysql_list_tables
   mysql_more_results
   mysql_next_result
@@ -66,6 +69,7 @@ SET(CLIENT_API_FUNCTIONS
   mysql_ping
   mysql_query
   mysql_set_server_option
+  mysql_stmt_bind_param
   mysql_stmt_bind_named_param
   mysql_stmt_bind_result
   mysql_stmt_execute
@@ -82,6 +86,7 @@ SET(CLIENT_API_FUNCTIONS
   mysql_real_escape_string
   mysql_real_escape_string_quote
   mysql_real_query
+  mysql_refresh
   mysql_rollback
   mysql_row_seek
   mysql_row_tell
@@ -108,7 +113,9 @@ SET(CLIENT_API_FUNCTIONS
   mysql_set_character_set
   mysql_set_local_infile_default
   mysql_set_local_infile_handler
+  mysql_shutdown
   mysql_sqlstate
+  mysql_ssl_set
   mysql_stat
   mysql_stmt_affected_rows
   mysql_stmt_attr_get

libmysql/client_settings.h

@@ -61,6 +61,7 @@ MYSQL *STDCALL cli_mysql_real_connect(MYSQL *mysql, const char *host,
 
 void cli_mysql_close(MYSQL *mysql);
 
+MYSQL_FIELD *cli_list_fields(MYSQL *mysql);
 bool cli_read_prepare_result(MYSQL *mysql, MYSQL_STMT *stmt);
 MYSQL_DATA *cli_read_rows(MYSQL *mysql, MYSQL_FIELD *mysql_fields, uint fields);
 int cli_stmt_execute(MYSQL_STMT *stmt);