Merge branch 'mysql-8.0' into mysql-trunk

Author: phulakun

include/mysql/components/services/log_builtins.h

@@ -28,14 +28,17 @@
 #include <mysql/components/my_service.h>
 #include <mysql/components/service_implementation.h>
 #include <mysql/components/services/log_shared.h>
+#if defined(MYSQL_DYNAMIC_PLUGIN)
+#include <mysql/service_plugin_registry.h>
+#endif
 #include <stdarg.h>
+#include <stdio.h>
 
-#include "my_compiler.h"
-#ifdef MYSQL_SERVER
+#include <my_compiler.h>
+#if defined(MYSQL_SERVER) && !defined(MYSQL_DYNAMIC_PLUGIN)
 #include "sql/log.h"
 #endif
 
-
 /**
   Primitives for services to interact with the structured logger:
   functions pertaining to log_line and log_item data
@@ -651,9 +654,9 @@ BEGIN_SERVICE_DEFINITION(log_builtins_syseventlog)
 END_SERVICE_DEFINITION(log_builtins_syseventlog)
 
 
-#  ifdef __cplusplus
+#ifdef __cplusplus
 
-#    if !defined(LOG_H)
+#if !defined(LOG_H)
 
 extern SERVICE_TYPE(log_builtins)        *log_bi;
 extern SERVICE_TYPE(log_builtins_string) *log_bs;
@@ -686,7 +689,9 @@ extern SERVICE_TYPE(log_builtins_string) *log_bs;
 #      define log_set_float               log_item_set_float
 #      define log_set_lexstring           log_item_set_lexstring
 #      define log_set_cstring             log_item_set_cstring
-#    endif
+#endif // LOG_H
+
+#ifndef DISABLE_ERROR_LOGGING
 
 #define LogErr(severity, ecode, ...) LogEvent().prio(severity)\
                                                .errcode(ecode)\
@@ -696,7 +701,43 @@ extern SERVICE_TYPE(log_builtins_string) *log_bs;
                                                .function(__FUNCTION__)\
                                                .lookup(ecode, ## __VA_ARGS__)
 
+#define LogPluginErr(severity, ecode, ...) \
+  LogEvent().prio(severity)\
+            .errcode(ecode)\
+            .subsys(LOG_SUBSYSTEM_TAG)\
+            .source_line(__LINE__)\
+            .source_file(MY_BASENAME)\
+            .function(__FUNCTION__)\
+            .lookup_quoted(ecode, "Plugin " LOG_SUBSYSTEM_TAG " reported",\
+                           ## __VA_ARGS__)
+
+#define LogPluginErrMsg(severity, ecode, ...) \
+  LogEvent().prio(severity)\
+            .errcode(ecode)\
+            .subsys(LOG_SUBSYSTEM_TAG)\
+            .source_line(__LINE__)\
+            .source_file(MY_BASENAME)\
+            .function(__FUNCTION__)\
+            .message_quoted("Plugin " LOG_SUBSYSTEM_TAG " reported",\
+                            ## __VA_ARGS__)
+
+#else
+
+inline void dummy_log_message(longlong severity MY_ATTRIBUTE((unused)),
+                              longlong ecode MY_ATTRIBUTE((unused)),
+                              ...)
+{
+  return;
+}
+
+#define LogErr(severity, ecode, ...) \
+  dummy_log_message(severity, ecode, ## __VA_ARGS__)
+#define LogPluginErr(severity, ecode, ...) \
+  dummy_log_message(severity, ecode, ## __VA_ARGS__)
+#define LogPluginErrMsg(severity, ecode, ...) \
+  dummy_log_message(severity, ecode, ## __VA_ARGS__)
 
+#endif // DISABLE_ERROR_LOGGING
 
 /**
   Modular logger: fluid API. Server-internal. Lets you use safe and
@@ -710,6 +751,7 @@ class LogEvent
 private:
   log_line     *ll;
   char         *msg;
+  const char   *msg_tag;
 
   /**
     Set MySQL error-code if none has been set yet.
@@ -788,6 +830,7 @@ class LogEvent
     }
     else
       msg= nullptr;
+    msg_tag= nullptr;
   }
 
   /**
@@ -798,7 +841,7 @@ class LogEvent
 
     @retval      the LogEvent, for easy fluent-style chaining.
   */
-  LogEvent &type(log_type val)
+  LogEvent &type(enum_log_type val)
   {
     log_set_int(log_line_item_set(this->ll, LOG_ITEM_LOG_TYPE), val);
     return *this;
@@ -1111,6 +1154,30 @@ class LogEvent
   LogEvent &message(const char *fmt, ...)
     MY_ATTRIBUTE((format(printf, 2, 3)));
 
+  /**
+    Fill in a format string by substituting the % with the given
+    arguments and tag, then add the result as the event's message.
+
+    @param  tag  Tag to prefix to message.
+    @param  fmt  message (treated as a printf-style format-string,
+                 so % substitution will happen)
+    @param  ...  varargs to satisfy any % in the message
+
+    @retval      the LogEvent, for easy fluent-style chaining.
+  */
+  LogEvent &message_quoted(const char *tag, const char *fmt, ...)
+    MY_ATTRIBUTE((format(printf, 3, 4)))
+  {
+    msg_tag= tag;
+
+    va_list args;
+    va_start(args, fmt);
+    set_message(fmt, args);
+    va_end(args);
+
+    return *this;
+  }
+
   /**
     Find an error message by its MySQL error code.
     Substitute the % in that message with the given
@@ -1132,6 +1199,18 @@ class LogEvent
     return *this;
   }
 
+  LogEvent &lookup_quoted(longlong errcode, const char *tag, ...)
+  {
+    msg_tag= tag;
+
+    va_list args;
+    va_start(args, tag);
+    set_message_by_errcode(errcode, args);
+    va_end(args);
+
+    return *this;
+  }
+
   /**
     Add a ad hoc integer value with the given key.
 
@@ -1217,6 +1296,12 @@ inline void LogEvent::set_message(const char *fmt, va_list ap)
 {
   if ((ll != nullptr) && (msg != nullptr))
   {
+    char buf[LOG_BUFF_MAX];
+    if (msg_tag != nullptr)
+    {
+      snprintf(buf, LOG_BUFF_MAX - 1, "%s: \'%s\'", msg_tag, fmt);
+      fmt= buf;
+    }
     size_t         len=    log_msg(msg, LOG_BUFF_MAX - 1, fmt, ap);
     log_set_lexstring(log_line_item_set(this->ll, LOG_ITEM_LOG_MESSAGE),
                       msg, len);
@@ -1233,6 +1318,77 @@ inline LogEvent &LogEvent::message(const char *fmt, ...)
   return *this;
 }
 
-#  endif
+// Methods initialize and de-initialize logging service for plugins.
+#if defined(MYSQL_DYNAMIC_PLUGIN)
+
+/**
+  Method to de-initialize logging service in plugin.
+
+  param[in]  reg_srv    Pluin registry service.
+*/
+inline void deinit_logging_service_for_plugin(SERVICE_TYPE(registry) **reg_srv)
+{
+  if (log_bi)
+    (*reg_srv)->release((my_h_service)log_bi);
+  if (log_bs)
+    (*reg_srv)->release((my_h_service)log_bs);
+  mysql_plugin_registry_release(*reg_srv);
+  log_bi= nullptr;
+  log_bs= nullptr;
+  *reg_srv= nullptr;
+}
+
+/**
+  Method to de-initialize logging service in plugin.
+
+  param[out]  reg_srv    Pluin registry service.
+
+  @retval     false  Success.
+  @retval     true   Failed.
+*/
+inline bool init_logging_service_for_plugin(SERVICE_TYPE(registry) **reg_srv)
+{
+  my_h_service log_srv= nullptr;
+  my_h_service log_str_srv= nullptr;
+  *reg_srv= mysql_plugin_registry_acquire();
+  if (!(*reg_srv)->acquire("log_builtins.mysql_server", &log_srv) &&
+      !(*reg_srv)->acquire("log_builtins_string.mysql_server", &log_str_srv))
+  {
+    log_bi= reinterpret_cast<SERVICE_TYPE(log_builtins) *>(log_srv);
+    log_bs= reinterpret_cast<SERVICE_TYPE(log_builtins_string) *>(log_str_srv);
+  }
+  else
+  {
+    deinit_logging_service_for_plugin(reg_srv);
+    return true;
+  }
+  return false;
+}
+
+#elif defined(EXTRA_CODE_FOR_UNIT_TESTING)
+
+/**
+  Method is used by unit tests.
+
+  param[in]  reg_srv    Pluin registry service.
+*/
+inline bool init_logging_service_for_plugin(
+  SERVICE_TYPE(registry) **reg_srv MY_ATTRIBUTE((unused)))
+{
+  return false;
+}
+
+/**
+  Method is used by unit tests.
+
+  param[in]  reg_srv    Pluin registry service.
+*/
+inline void deinit_logging_service_for_plugin(
+  SERVICE_TYPE(registry) **reg_srv MY_ATTRIBUTE((unused)))
+{ }
+
+#endif // MYSQL_DYNAMIC_PLUGIN
+
+#endif  // __cplusplus
 
 #endif

include/mysql/components/services/log_shared.h

@@ -68,15 +68,15 @@ typedef struct MYSQL_LEX_CSTRING LEX_CSTRING;
   log_type -- which log to send data to
   check vs enum_log_table_type and LOG_FILE/LOG_TABLE/LOG_NONE
 */
-typedef enum enum_log_type
+enum enum_log_type
 {
   LOG_TYPE_UNDEF   = 0,
   LOG_TYPE_ERROR   = 1,
   LOG_TYPE_GENERAL = 2,
   LOG_TYPE_SLOW    = 4,
   LOG_TYPE_AUDIT   = 8,
   LOG_TYPE_MISC    = 16
-} log_type;
+};
 
 /**
   item_type -- what to log

include/mysql/thread_pool_priv.h

@@ -37,11 +37,6 @@
 #include "sql/conn_handler/connection_handler_manager.h"
 #include "sql/debug_sync.h"
 #include "sql/field.h"
-/*
-  Print to the MySQL error log -- ultimately, this should possibly
-  become a service calling another service.
-*/
-#include "sql/log.h"
 #include "sql/sql_profile.h"
 #include "sql/sql_thd_internal_api.h"
 #include "sql/table.h"

mysql-test/suite/query_rewrite_plugins/r/digest_collision.result

@@ -56,7 +56,7 @@ SELECT search_error_log( '[Note]', '%Plugin Rewriter reported: ''Statement "SELE
 'WHERE a = "digest_collision.test"%' );
 search_error_log( '[Note]', '%Plugin Rewriter reported: ''Statement "SELECT * FROM test.t1 ' ||
 'WHERE a = "digest_collision.test"%' )
-[Note] [MY-000000] Plugin Rewriter reported: 'Statement "SELECT * FROM test.t1 WHERE a = "digest_collision.test" UNION SELECT * FROM test.t1 WHERE a = "diges..." with digest "3c579229047547d5b35dbb0f1f00f0d1ff521755e231f83952e6d51b2019818b" matched some rule but had different parse tree and/or literals.'
+[Note] [MY-004920] Plugin Rewriter reported: 'Statement "SELECT * FROM test.t1 WHERE a = "digest_collision.test" UNION SELECT * FROM test.t1 WHERE a = "diges..." with digest "3c579229047547d5b35dbb0f1f00f0d1ff521755e231f83952e6d51b2019818b" matched some rule but had different parse tree and/or literals.'
 DROP TABLE t1;
 Warnings:
 Warning	1620	Plugin is busy and will be uninstalled on shutdown

mysql-test/suite/query_rewrite_plugins/r/errors.result

@@ -47,7 +47,7 @@ UPDATE error_log SET line = replace ( line, '\r', '' );
 # Avoid seeing any other error that might be there.
 SELECT search_error_log( '[Error]', "%Plugin Rewriter reported: 'Wrong%" );
 search_error_log( '[Error]', "%Plugin Rewriter reported: 'Wrong%" )
-[ERROR] [MY-000000] Plugin Rewriter reported: 'Wrong column count or names when loading rules.'
+[ERROR] [MY-004920] Plugin Rewriter reported: 'Wrong column count or names when loading rules.'
 SHOW STATUS LIKE 'Rewriter_number_reloads';
 Variable_name	Value
 Rewriter_number_reloads	1
@@ -70,7 +70,7 @@ UPDATE error_log SET line = replace ( line, '\r', '' );
 # Avoid seeing any other error that might be there.
 SELECT search_error_log( '[Error]', "%Plugin Rewriter reported: 'Wrong%" );
 search_error_log( '[Error]', "%Plugin Rewriter reported: 'Wrong%" )
-[ERROR] [MY-000000] Plugin Rewriter reported: 'Wrong column count or names when loading rules.'
+[ERROR] [MY-004920] Plugin Rewriter reported: 'Wrong column count or names when loading rules.'
 SHOW STATUS LIKE 'Rewriter_number_reloads';
 Variable_name	Value
 Rewriter_number_reloads	1

mysql-test/suite/query_rewrite_plugins/r/verbose.result

@@ -39,7 +39,7 @@ SELECT search_error_log( '[Note]', "%Plugin Rewriter reported: " ||
 "'Statement \"SELECT 'nonrewritten'\"%" ) INTO @line;
 SELECT @line;
 @line
-[Note] [MY-000000] Plugin Rewriter reported: 'Statement "SELECT 'nonrewritten'" with digest "d1b44b0c19af710b5a679907e284acd2ddc285201794bc69a2389d77baedddae" did not match any rule.'
+[Note] [MY-004920] Plugin Rewriter reported: 'Statement "SELECT 'nonrewritten'" with digest "d1b44b0c19af710b5a679907e284acd2ddc285201794bc69a2389d77baedddae" did not match any rule.'
 SELECT digest INTO @pfs_digest
 FROM performance_schema.events_statements_history_long
 WHERE sql_text = "SELECT 'nonrewritten'"

plugin/connection_control/connection_control.cc

@@ -13,6 +13,8 @@
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
 
+#define LOG_SUBSYSTEM_TAG "CONNECTION_CONTROL"
+
 #include "plugin/connection_control/connection_control.h"
 
 #include <mysql/plugin_audit.h>         /* mysql_event_connection */
@@ -22,9 +24,15 @@
 #include "my_dbug.h"
 #include "my_inttypes.h"
 #include "mysql_version.h"
+#include "mysqld_error.h"
+#include <mysql/components/services/log_builtins.h>
 #include "plugin/connection_control/connection_control_coordinator.h" /* g_connection_event_coordinator */
 #include "plugin/connection_control/connection_delay_api.h" /* connection_delay apis */
 
+static SERVICE_TYPE(registry) *reg_srv= nullptr;
+SERVICE_TYPE(log_builtins) *log_bi= nullptr;
+SERVICE_TYPE(log_builtins_string) *log_bs= nullptr;
+
 namespace connection_control
 {
   class Connection_control_error_handler : public Error_handler
@@ -36,9 +44,7 @@ namespace connection_control
 
     void handle_error(const char * error_message)
     {
-      my_plugin_log_message(&m_plugin_info,
-                            MY_ERROR_LEVEL,
-                            "%s", error_message);
+      LogPluginErr(ERROR_LEVEL, ER_CONN_CONTROL_ERROR_MSG, error_message);
     }
   private:
     MYSQL_PLUGIN m_plugin_info;
@@ -111,12 +117,17 @@ connection_control_notify(MYSQL_THD thd,
 static int
 connection_control_init(MYSQL_PLUGIN plugin_info)
 {
+  // Initialize error logging service.
+  if (init_logging_service_for_plugin(&reg_srv))
+    return 1;
+
   connection_control_plugin_info= plugin_info;
   Connection_control_error_handler error_handler(connection_control_plugin_info);
   g_connection_event_coordinator= new Connection_event_coordinator();
   if (!g_connection_event_coordinator)
   {
     error_handler.handle_error("Failed to initialize Connection_event_coordinator");
+    deinit_logging_service_for_plugin(&reg_srv);
     return 1;
   }
 
@@ -125,8 +136,10 @@ connection_control_init(MYSQL_PLUGIN plugin_info)
                                   &error_handler))
   {
     delete g_connection_event_coordinator;
+    deinit_logging_service_for_plugin(&reg_srv);
     return 1;
   }
+
   return 0;
 }
 
@@ -146,6 +159,8 @@ connection_control_deinit(void *arg MY_ATTRIBUTE((unused)))
   g_connection_event_coordinator= 0;
   connection_control::deinit_connection_delay_event();
   connection_control_plugin_info= 0;
+
+  deinit_logging_service_for_plugin(&reg_srv);
   return 0;
 }