Move modules.h to core/maxscale

Also remove some unnecessary includes + cleanup

server/core/authenticator.c

@@ -13,9 +13,9 @@
 
 #include <maxscale/gw_authenticator.h>
 #include <maxscale/modutil.h>
-#include <maxscale/modules.h>
 #include <maxscale/alloc.h>
 
+#include "maxscale/modules.h"
 /**
  * @file authenticator.c - Authenticator module functions
  */

server/core/config.c

@@ -58,7 +58,6 @@
 #include <maxscale/housekeeper.h>
 #include <maxscale/limits.h>
 #include <maxscale/log_manager.h>
-#include <maxscale/modules.h>
 #include <maxscale/notification.h>
 #include <maxscale/pcre2.h>
 #include <maxscale/spinlock.h>
@@ -69,6 +68,7 @@
 #include "maxscale/filter.h"
 #include "maxscale/service.h"
 #include "maxscale/monitor.h"
+#include "maxscale/modules.h"
 
 typedef struct duplicate_context
 {

server/core/config_runtime.c

@@ -16,11 +16,11 @@
 #include <maxscale/config_runtime.h>
 #include <maxscale/gwdirs.h>
 #include <maxscale/spinlock.h>
-#include <maxscale/modules.h>
 
 #include "maxscale/config.h"
 #include "maxscale/service.h"
 #include "maxscale/monitor.h"
+#include "maxscale/modules.h"
 
 static SPINLOCK crt_lock = SPINLOCK_INIT;
 

server/core/dcb.c

@@ -76,7 +76,6 @@
 #include <maxscale/spinlock.h>
 #include <maxscale/server.h>
 #include <maxscale/service.h>
-#include <maxscale/modules.h>
 #include <maxscale/router.h>
 #include <maxscale/poll.h>
 #include <maxscale/atomic.h>
@@ -95,6 +94,7 @@
 #include <maxscale/platform.h>
 
 #include "maxscale/session.h"
+#include "maxscale/modules.h"
 
 /* A DCB with null values, used for initialization */
 static DCB dcb_initialized = DCB_INIT;

server/core/filter.c

@@ -29,12 +29,12 @@
 #include <errno.h>
 #include <maxscale/alloc.h>
 #include <maxscale/log_manager.h>
-#include <maxscale/modules.h>
 #include <maxscale/session.h>
 #include <maxscale/spinlock.h>
 #include "maxscale/filter.h"
 
 #include "maxscale/config.h"
+#include "maxscale/modules.h"
 
 static SPINLOCK filter_spin = SPINLOCK_INIT;    /**< Protects the list of all filters */
 static MXS_FILTER_DEF *allFilters = NULL;           /**< The list of all filters */

server/core/gateway.cc

@@ -60,7 +60,6 @@
 #include <maxscale/log_manager.h>
 #include <maxscale/maxscale.h>
 #include <maxscale/memlog.h>
-#include <maxscale/modules.h>
 #include <maxscale/poll.h>
 #include <maxscale/query_classifier.h>
 #include <maxscale/server.h>
@@ -73,6 +72,7 @@
 #include "maxscale/service.h"
 #include "maxscale/statistics.h"
 #include "maxscale/monitor.h"
+#include "maxscale/modules.h"
 
 #define STRING_BUFFER_SIZE 1024
 #define PIDFD_CLOSED -1

server/core/listener.c

@@ -38,7 +38,6 @@
 #include <maxscale/log_manager.h>
 #include <maxscale/alloc.h>
 #include <maxscale/users.h>
-#include <maxscale/modules.h>
 #include <maxscale/service.h>
 
 static RSA *rsa_512 = NULL;

server/core/load_utils.c

@@ -34,7 +34,6 @@
 #include <unistd.h>
 #include <string.h>
 #include <dlfcn.h>
-#include <maxscale/modules.h>
 #include <maxscale/modinfo.h>
 #include <maxscale/log_manager.h>
 #include <maxscale/version.h>
@@ -45,6 +44,8 @@
 #include <maxscale/gwdirs.h>
 #include <maxscale/alloc.h>
 
+#include "maxscale/modules.h"
+
 typedef struct loaded_module
 {
     char    *module;       /**< The name of the module */

server/core/maxscale/modules.h

@@ -0,0 +1,164 @@
+#pragma once
+/*
+ * Copyright (c) 2016 MariaDB Corporation Ab
+ *
+ * Use of this software is governed by the Business Source License included
+ * in the LICENSE.TXT file and at www.mariadb.com/bsl.
+ *
+ * Change Date: 2019-07-01
+ *
+ * On the date above, in accordance with the Business Source License, use
+ * of this software will be governed by version 2 or later of the General
+ * Public License.
+ */
+
+/**
+ * @file modules.h  Utilities for loading modules
+ *
+ * The module interface used within the gateway
+ *
+ * @verbatim
+ * Revision History
+ *
+ * Date     Who                 Description
+ * 13/06/13 Mark Riddoch        Initial implementation
+ * 08/07/13 Mark Riddoch        Addition of monitor modules
+ * 29/05/14 Mark Riddoch        Addition of filter modules
+ * 01/10/14 Mark Riddoch        Addition of call to unload all modules on shutdown
+ * 19/02/15 Mark Riddoch        Addition of moduleGetList
+ * 26/02/15 Massimiliano Pinto  Addition of module_feedback_send
+ *
+ * @endverbatim
+ */
+
+#include <maxscale/cdefs.h>
+#include <maxscale/dcb.h>
+#include <maxscale/modinfo.h>
+#include <maxscale/resultset.h>
+#include <maxscale/debug.h>
+
+MXS_BEGIN_DECLS
+
+/**
+ * Module types
+ */
+#define MODULE_PROTOCOL         "Protocol"        /**< A protocol module type */
+#define MODULE_AUTHENTICATOR    "Authenticator"   /**< An authenticator module type */
+#define MODULE_ROUTER           "Router"          /**< A router module type */
+#define MODULE_MONITOR          "Monitor"         /**< A database monitor module type */
+#define MODULE_FILTER           "Filter"          /**< A filter module type */
+#define MODULE_QUERY_CLASSIFIER "QueryClassifier" /**< A query classifier module type */
+
+
+/**
+ *@brief Load a module
+ *
+ * @param module Name of the module to load
+ * @param type   Type of module, used purely for registration
+ * @return       The module specific entry point structure or NULL
+ */
+void *load_module(const char *module, const char *type);
+
+/**
+ * @brief Get a module
+ *
+ * @param name Name of the module
+ * @param type The module type
+ * @return The loaded module or NULL if the module is not loaded
+ */
+const MXS_MODULE *get_module(const char *name, const char *type);
+
+/**
+ * @brief Unload a module.
+ *
+ * No errors are returned since it is not clear that much can be done
+ * to fix issues relating to unloading modules.
+ *
+ * @param module The name of the module
+ */
+void unload_module(const char *module);
+
+/**
+ * @brief Unload all modules
+ *
+ * Remove all the modules from the system, called during shutdown
+ * to allow termination hooks to be called.
+ */
+void unload_all_modules();
+
+/**
+ * @brief Print Modules
+ *
+ * Diagnostic routine to display all the loaded modules
+ */
+void printModules();
+
+/**
+ * @brief Print Modules to a DCB
+ *
+ * Diagnostic routine to display all the loaded modules
+ */
+void dprintAllModules(DCB *);
+
+/**
+ * @brief Return a resultset that has the current set of modules in it
+ *
+ * @return A Result set
+ */
+RESULTSET *moduleGetList();
+
+/**
+ * @brief Send loaded modules info to notification service
+ *
+ *  @param data The configuration details of notification service
+ */
+void module_feedback_send(void*);
+
+/**
+ * @brief Show feedback report
+ *
+ * Prints the feedback report to a DCB
+ */
+void moduleShowFeedbackReport(DCB *dcb);
+
+typedef struct mxs_module_iterator
+{
+    const char* type;
+    void* position;
+} MXS_MODULE_ITERATOR;
+
+/**
+ * @brief Returns an iterator to modules.
+ *
+ * @attention It is unspecified whether a module loaded after the iterator
+ *            was created, will be returned by the iterator. The behaviour
+ *            is undefined if a module is unloaded while an iteration is
+ *            being performed.
+ *
+ * @param type  The type of modules that should be returned. If NULL,
+ *              then all modules are returned.
+ *
+ * @return An iterator.
+ */
+MXS_MODULE_ITERATOR mxs_module_iterator_get(const char* type);
+
+/**
+ * @brief Indicates whether the iterator has a module to return.
+ *
+ * @param iterator  An iterator
+ *
+ * @return True if a subsequent call to @c mxs_module_iterator_get
+ *         will return a module.
+ */
+bool mxs_module_iterator_has_next(const MXS_MODULE_ITERATOR* iterator);
+
+/**
+ * @brief Returns the next module and advances the iterator.
+ *
+ * @param iterator  An iterator.
+ *
+ * @return A module if there was a module to return, NULL otherwise.
+ */
+MXS_MODULE* mxs_module_iterator_get_next(MXS_MODULE_ITERATOR* iterator);
+
+MXS_END_DECLS

server/core/monitor.c

@@ -38,7 +38,6 @@
 #include <maxscale/externcmd.h>
 #include <maxscale/gwdirs.h>
 #include <maxscale/log_manager.h>
-#include <maxscale/modules.h>
 #include <maxscale/mysql_utils.h>
 #include <maxscale/pcre2.h>
 #include <maxscale/secrets.h>
@@ -46,6 +45,7 @@
 
 #include "maxscale/config.h"
 #include "maxscale/monitor.h"
+#include "maxscale/modules.h"
 
 static MXS_MONITOR  *allMonitors = NULL;
 static SPINLOCK monLock = SPINLOCK_INIT;

server/core/query_classifier.c

@@ -13,11 +13,12 @@
 
 #include <maxscale/query_classifier.h>
 #include <maxscale/log_manager.h>
-#include <maxscale/modules.h>
 #include <maxscale/modutil.h>
 #include <maxscale/alloc.h>
 #include <maxscale/utils.h>
 
+#include "../core/maxscale/modules.h"
+
 //#define QC_TRACE_ENABLED
 #undef QC_TRACE_ENABLED
 

server/core/server.c

@@ -47,7 +47,6 @@
 #include <maxscale/log_manager.h>
 #include <maxscale/gw_ssl.h>
 #include <maxscale/alloc.h>
-#include <maxscale/modules.h>
 #include <maxscale/gwdirs.h>
 
 #include "maxscale/monitor.h"

server/core/service.c

@@ -54,7 +54,6 @@
 #include <maxscale/housekeeper.h>
 #include <maxscale/listener.h>
 #include <maxscale/log_manager.h>
-#include <maxscale/modules.h>
 #include <maxscale/poll.h>
 #include <maxscale/protocol.h>
 #include <maxscale/queuemanager.h>
@@ -70,6 +69,7 @@
 #include "maxscale/config.h"
 #include "maxscale/filter.h"
 #include "maxscale/service.h"
+#include "maxscale/modules.h"
 
 /** Base value for server weights */
 #define SERVICE_BASE_SERVER_WEIGHT 1000

server/core/test/testfeedback.c

@@ -43,8 +43,8 @@
 #include <maxscale/housekeeper.h>
 #include <maxscale/buffer.h>
 #include <regex.h>
-#include <maxscale/modules.h>
 #include <maxscale/maxscale_test.h>
+
 #include "../load_utils.c"
 
 static char* server_options[] =