Move spectrum_storage.cc from plugin to libspectrum

Author: Peng Gu

libspectrum/CMakeLists.txt

@@ -54,5 +54,10 @@ ADD_STATIC_LIBRARY(spectrum_log
 
 ADD_STATIC_LIBRARY(spectrum_compute
   ${SPECTRUM_BASE_SRC_DIR}/spectrum_compute.cc
+  LINK_LIBRARIES spectrum_pb spectrum_common
+)
+
+ADD_STATIC_LIBRARY(spectrum_storage
+  ${SPECTRUM_BASE_SRC_DIR}/spectrum_storage.cc
   LINK_LIBRARIES spectrum_pb spectrum_common spectrum_log
 )

libspectrum/include/spectrum.h

@@ -74,6 +74,8 @@ extern int spectrum_compute_acquire_mdl(THD *thd, MDL_ticket *ticket);
 extern int spectrum_compute_release_mdl(THD *thd, enum_mdl_duration duration, int32 ticket_number);
 extern int spectrum_compute_post_ddl(THD *thd);
 
+extern int spectrum_storage_init();
+
 extern int spectrum_log_create_table(THD *thd, const char* db_name, const char* table_name, uint64 handler_id);
 extern int spectrum_log_delete_table(THD *thd, const char* db_name, const char* table_name, const char* table_path);
 extern int spectrum_log_post_ddl(THD *thd);

plugin/spectrum_storage/spectrum_storage.cc renamed to libspectrum/src/spectrum_storage.cc

@@ -16,25 +16,8 @@
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
 
-#include <ctype.h>
-#include <fcntl.h>
-#include <mysql/plugin.h>
-#include <mysql_version.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <time.h>
-
-#include "m_string.h"  // strlen
-#include "my_dbug.h"
-#include "my_dir.h"
-#include "my_inttypes.h"
-#include "my_io.h"
-#include "my_psi_config.h"
-#include "my_sys.h"  // my_write, my_malloc
 #include "my_thread.h"
 #include "thr_lock.h"
-#include "mysql/psi/mysql_memory.h"
-#include "sql/sql_plugin.h"  // st_plugin_int
 #include "sql/sql_class.h"
 #include "sql/sql_base.h"
 #include "sql/sql_table.h"
@@ -869,88 +852,18 @@ class StorageReplicaNodeImpl final : public spectrum::StorageReplicaNode::Servic
     }
 };
 
-struct spectrum_storage_plugin_context {
-  std::unique_ptr<grpc::Server> server;
-};
-
-PSI_memory_key key_memory_spectrum_storage_plugin_context;
-
-/*
-  Initialize the daemon example at server start or plugin installation.
-  SYNOPSIS
-    daemon_example_plugin_init()
-  DESCRIPTION
-    Starts up heartbeatbeat thread
-  RETURN VALUE
-    0                    success
-    1                    failure (cannot happen)
-*/
-
-static int daemon_example_plugin_init(void *p) {
-  DBUG_TRACE;
-  struct spectrum_storage_plugin_context *con;
-  struct st_plugin_int *plugin = (struct st_plugin_int *)p;
-
-  con = (struct spectrum_storage_plugin_context *)my_malloc(
-      key_memory_spectrum_storage_plugin_context,
-      sizeof(struct spectrum_storage_plugin_context), MYF(0));
-  plugin->data = (void *)con;
-
-  spectrum_config_init();
-
-  if (is_spectrum_storage()) {
-    grpc::ServerBuilder serverBuilder;
+std::unique_ptr<grpc::Server> spectrum_storage_server;
 
-    grpc::Service *service = new StorageNodeImpl();
-    serverBuilder.RegisterService(service);
+int spectrum_storage_init() {
+  grpc::ServerBuilder serverBuilder;
 
-    grpc::Service *replicaService = new StorageReplicaNodeImpl();
-    serverBuilder.RegisterService(replicaService);
+  serverBuilder.RegisterService(new StorageNodeImpl());
+  serverBuilder.RegisterService(new StorageReplicaNodeImpl());
 
-    node_config_t *node_config = find_current_node_config();
-    serverBuilder.AddListeningPort(node_config->address, grpc::InsecureServerCredentials());
-    con->server = serverBuilder.BuildAndStart();
-    sql_print_information("Spectrum storage server started at %s", node_config->address.c_str());
-  }
+  node_config_t *node_config = find_current_node_config();
+  serverBuilder.AddListeningPort(node_config->address, grpc::InsecureServerCredentials());
 
+  spectrum_storage_server = serverBuilder.BuildAndStart();
+  sql_print_information("Spectrum storage server started at %s", node_config->address.c_str());
   return 0;
 }
-
-/*
-  Terminate the daemon example at server shutdown or plugin deinstallation.
-  SYNOPSIS
-    daemon_example_plugin_deinit()
-    Does nothing.
-  RETURN VALUE
-    0                    success
-    1                    failure (cannot happen)
-*/
-
-static int daemon_example_plugin_deinit(void *p) {
-  DBUG_TRACE;
-
-  return 0;
-}
-
-struct st_mysql_daemon daemon_example_plugin = {MYSQL_DAEMON_INTERFACE_VERSION};
-
-/*
-  Plugin library descriptor
-*/
-
-mysql_declare_plugin(spectrum_storage){
-    MYSQL_DAEMON_PLUGIN,
-    &daemon_example_plugin,
-    "spectrum_storage",
-    PLUGIN_AUTHOR_ORACLE,
-    "Spectrum storage",
-    PLUGIN_LICENSE_GPL,
-    daemon_example_plugin_init,   /* Plugin Init */
-    nullptr,                      /* Plugin Check uninstall */
-    daemon_example_plugin_deinit, /* Plugin Deinit */
-    0x0100 /* 1.0 */,
-    nullptr, /* status variables                */
-    nullptr, /* system variables                */
-    nullptr, /* config options                  */
-    0,       /* flags                           */
-} mysql_declare_plugin_end;

plugin/spectrum_storage/AUTHORS renamed to plugin/spectrum/AUTHORS

@@ -21,7 +21,7 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
 
-OPTION(WITH_SPECTRUM_STORAGE "Build Spectrum Storage Plugin" ON)
+OPTION(WITH_SPECTRUM "Build Spectrum Plugin" ON)
 
 SET(SPECTRUM_PB_GENERATE_DIR ${CMAKE_BINARY_DIR}/libspectrum/generated/protobuf)
 
@@ -31,14 +31,14 @@ INCLUDE_DIRECTORIES(
   ${SPECTRUM_PB_GENERATE_DIR}
 )
 
-MYSQL_ADD_PLUGIN(spectrum_storage
-  spectrum_storage.cc
-  LINK_LIBRARIES spectrum_pb spectrum_common
+MYSQL_ADD_PLUGIN(spectrum
+  spectrum_plugin.cc
+  LINK_LIBRARIES spectrum_compute spectrum_storage
   DEFAULT
 )
 
 INSTALL(FILES
-  spectrum_storage.ini
+  spectrum_plugin.ini
   DESTINATION ${INSTALL_PLUGINDIR}
   COMPONENT Test
 )

plugin/spectrum_storage/CMakeLists.txt renamed to plugin/spectrum/CMakeLists.txt

@@ -0,0 +1,78 @@
+/* Copyright (c) 2006, 2023, 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,
+   as published by the Free Software Foundation.
+   This program is also distributed with certain software (including
+   but not limited to OpenSSL) that is licensed under separate terms,
+   as designated in a particular file or component or in included license
+   documentation.  The authors of MySQL hereby grant you an additional
+   permission to link the program and your derivative works with the
+   separately licensed software that they have included with MySQL.
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License, version 2.0, for more details.
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
+
+#include <mysql/plugin.h>
+#include <stdio.h>
+#include <stdlib.h>
+
+#include "mysql/psi/mysql_memory.h"
+#include "sql/sql_plugin.h"  // st_plugin_int
+
+#include "spectrum.h"
+#include "spectrum_config.h"
+
+struct spectrum_plugin_context {
+};
+
+PSI_memory_key key_memory_spectrum_plugin_context;
+
+static int spectrum_plugin_init(void *p) {
+  DBUG_TRACE;
+  struct spectrum_plugin_context *plugin_context;
+  struct st_plugin_int *plugin = (struct st_plugin_int *)p;
+
+  plugin_context = (struct spectrum_plugin_context *)my_malloc(
+      key_memory_spectrum_plugin_context,
+      sizeof(struct spectrum_plugin_context), MYF(0));
+  plugin->data = (void *)plugin_context;
+
+  spectrum_config_init();
+
+  if (is_spectrum_storage()) {
+    spectrum_storage_init();
+  }
+  return 0;
+}
+
+static int spectrum_plugin_deinit(void *p) {
+  DBUG_TRACE;
+
+  return 0;
+}
+
+struct st_mysql_daemon spectrum_plugin = {MYSQL_DAEMON_INTERFACE_VERSION};
+
+/*
+  Plugin library descriptor
+*/
+mysql_declare_plugin(spectrum){
+    MYSQL_DAEMON_PLUGIN,
+    &spectrum_plugin,
+    "spectrum",
+    PLUGIN_AUTHOR_ORACLE,
+    "Spectrum",
+    PLUGIN_LICENSE_GPL,
+    spectrum_plugin_init,   /* Plugin Init */
+    nullptr,                      /* Plugin Check uninstall */
+    spectrum_plugin_deinit, /* Plugin Deinit */
+    0x0100 /* 1.0 */,
+    nullptr, /* status variables                */
+    nullptr, /* system variables                */
+    nullptr, /* config options                  */
+    0,       /* flags                           */
+} mysql_declare_plugin_end;

plugin/spectrum/spectrum_plugin.cc

@@ -28,5 +28,4 @@
 # component_name
 # [component_name] - additional components in plugin
 #
-libspectrum_storage
-spectrum_storage
+libspectrum_plugin