mirror of
https://github.com/MariaDB/server.git
synced 2025-01-16 12:02:42 +01:00
afee63222a
It is not possible to prevent the server from starting if a mandatory
built-in plugin fails to start. This can in some cases lead to data
corruption when the old table name space suddenly is used by a different
storage engine.
A boolean command line option in the form of --foobar is automatically
created for every existing plugin "foobar". By changing this command line
option from a boolean to a tristate { OFF, ON, FORCE } it is possible to
specify the plugin loading policy for each plugin.
The behavior is specified as follows:
OFF = Disable the plugin and start the server
ON = Enable the plugin and start the server even if an error occurrs
during plugin initialization.
FORCE = Enable the plugin but don't start the server if an error occurrs
during plugin initialization.
mysql-test/lib/mtr_cases.pm:
* Changed --<pluginname> from a boolean to a tristate.
mysys/my_getopt.c:
* Changed --<pluginname> from boolean to tristate. Optional arguments
must still work for tristates. It is praxis that disable means value 0
and enable is value 1. Since plugin name is the only tristate with
optional arguments this principle will still hold.
sql/sql_plugin.cc:
* Changed --<pluginname> option from a boolean type to a tristate.
- FORCE will now terminate the server if the plugin fails to
initialize properly.
* Refactored prototypes for test_plugin_options() and construct_options()
to get rid of the 'enable' value pointer.
* Cleaned up code related to option name constructing.
* Added documentation
sql/sql_plugin.h:
* Introduced new member to st_plugin_int structure.
141 lines
5.3 KiB
C++
141 lines
5.3 KiB
C++
/* Copyright (C) 2005 MySQL AB
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; version 2 of the License.
|
|
|
|
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 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
|
|
|
|
#ifndef _sql_plugin_h
|
|
#define _sql_plugin_h
|
|
|
|
class sys_var;
|
|
|
|
/*
|
|
the following flags are valid for plugin_init()
|
|
*/
|
|
#define PLUGIN_INIT_SKIP_DYNAMIC_LOADING 1
|
|
#define PLUGIN_INIT_SKIP_PLUGIN_TABLE 2
|
|
#define PLUGIN_INIT_SKIP_INITIALIZATION 4
|
|
|
|
#define INITIAL_LEX_PLUGIN_LIST_SIZE 16
|
|
|
|
/*
|
|
the following #define adds server-only members to enum_mysql_show_type,
|
|
that is defined in plugin.h
|
|
*/
|
|
#define SHOW_FUNC SHOW_FUNC, SHOW_KEY_CACHE_LONG, SHOW_KEY_CACHE_LONGLONG, \
|
|
SHOW_LONG_STATUS, SHOW_DOUBLE_STATUS, SHOW_HAVE, \
|
|
SHOW_MY_BOOL, SHOW_HA_ROWS, SHOW_SYS, SHOW_LONG_NOFLUSH, \
|
|
SHOW_LONGLONG_STATUS
|
|
#include <mysql/plugin.h>
|
|
#undef SHOW_FUNC
|
|
typedef enum enum_mysql_show_type SHOW_TYPE;
|
|
typedef struct st_mysql_show_var SHOW_VAR;
|
|
|
|
#define MYSQL_ANY_PLUGIN -1
|
|
|
|
/*
|
|
different values of st_plugin_int::state
|
|
though they look like a bitmap, plugin may only
|
|
be in one of those eigenstates, not in a superposition of them :)
|
|
It's a bitmap, because it makes it easier to test
|
|
"whether the state is one of those..."
|
|
*/
|
|
#define PLUGIN_IS_FREED 1
|
|
#define PLUGIN_IS_DELETED 2
|
|
#define PLUGIN_IS_UNINITIALIZED 4
|
|
#define PLUGIN_IS_READY 8
|
|
#define PLUGIN_IS_DYING 16
|
|
#define PLUGIN_IS_DISABLED 32
|
|
|
|
/* A handle for the dynamic library containing a plugin or plugins. */
|
|
|
|
struct st_plugin_dl
|
|
{
|
|
LEX_STRING dl;
|
|
void *handle;
|
|
struct st_mysql_plugin *plugins;
|
|
int version;
|
|
uint ref_count; /* number of plugins loaded from the library */
|
|
};
|
|
|
|
/* A handle of a plugin */
|
|
|
|
struct st_plugin_int
|
|
{
|
|
LEX_STRING name;
|
|
struct st_mysql_plugin *plugin;
|
|
struct st_plugin_dl *plugin_dl;
|
|
uint state;
|
|
uint ref_count; /* number of threads using the plugin */
|
|
void *data; /* plugin type specific, e.g. handlerton */
|
|
MEM_ROOT mem_root; /* memory for dynamic plugin structures */
|
|
sys_var *system_vars; /* server variables for this plugin */
|
|
bool is_mandatory; /* If true then plugin must not fail to load */
|
|
};
|
|
|
|
|
|
/*
|
|
See intern_plugin_lock() for the explanation for the
|
|
conditionally defined plugin_ref type
|
|
*/
|
|
#ifdef DBUG_OFF
|
|
typedef struct st_plugin_int *plugin_ref;
|
|
#define plugin_decl(pi) ((pi)->plugin)
|
|
#define plugin_dlib(pi) ((pi)->plugin_dl)
|
|
#define plugin_data(pi,cast) ((cast)((pi)->data))
|
|
#define plugin_name(pi) (&((pi)->name))
|
|
#define plugin_state(pi) ((pi)->state)
|
|
#define plugin_equals(p1,p2) ((p1) == (p2))
|
|
#else
|
|
typedef struct st_plugin_int **plugin_ref;
|
|
#define plugin_decl(pi) ((pi)[0]->plugin)
|
|
#define plugin_dlib(pi) ((pi)[0]->plugin_dl)
|
|
#define plugin_data(pi,cast) ((cast)((pi)[0]->data))
|
|
#define plugin_name(pi) (&((pi)[0]->name))
|
|
#define plugin_state(pi) ((pi)[0]->state)
|
|
#define plugin_equals(p1,p2) ((p1) && (p2) && (p1)[0] == (p2)[0])
|
|
#endif
|
|
|
|
typedef int (*plugin_type_init)(struct st_plugin_int *);
|
|
|
|
extern char *opt_plugin_load;
|
|
extern char *opt_plugin_dir_ptr;
|
|
extern char opt_plugin_dir[FN_REFLEN];
|
|
extern const LEX_STRING plugin_type_names[];
|
|
|
|
extern int plugin_init(int *argc, char **argv, int init_flags);
|
|
extern void plugin_shutdown(void);
|
|
extern void my_print_help_inc_plugins(struct my_option *options, uint size);
|
|
extern bool plugin_is_ready(const LEX_STRING *name, int type);
|
|
#define my_plugin_lock_by_name(A,B,C) plugin_lock_by_name(A,B,C CALLER_INFO)
|
|
#define my_plugin_lock_by_name_ci(A,B,C) plugin_lock_by_name(A,B,C ORIG_CALLER_INFO)
|
|
#define my_plugin_lock(A,B) plugin_lock(A,B CALLER_INFO)
|
|
#define my_plugin_lock_ci(A,B) plugin_lock(A,B ORIG_CALLER_INFO)
|
|
extern plugin_ref plugin_lock(THD *thd, plugin_ref *ptr CALLER_INFO_PROTO);
|
|
extern plugin_ref plugin_lock_by_name(THD *thd, const LEX_STRING *name,
|
|
int type CALLER_INFO_PROTO);
|
|
extern void plugin_unlock(THD *thd, plugin_ref plugin);
|
|
extern void plugin_unlock_list(THD *thd, plugin_ref *list, uint count);
|
|
extern bool mysql_install_plugin(THD *thd, const LEX_STRING *name,
|
|
const LEX_STRING *dl);
|
|
extern bool mysql_uninstall_plugin(THD *thd, const LEX_STRING *name);
|
|
extern bool plugin_register_builtin(struct st_mysql_plugin *plugin);
|
|
extern void plugin_thdvar_init(THD *thd);
|
|
extern void plugin_thdvar_cleanup(THD *thd);
|
|
|
|
typedef my_bool (plugin_foreach_func)(THD *thd,
|
|
plugin_ref plugin,
|
|
void *arg);
|
|
#define plugin_foreach(A,B,C,D) plugin_foreach_with_mask(A,B,C,PLUGIN_IS_READY,D)
|
|
extern bool plugin_foreach_with_mask(THD *thd, plugin_foreach_func *func,
|
|
int type, uint state_mask, void *arg);
|
|
#endif
|