1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
*
* Copyright (C) 2008 Sun Microsystems
*
* 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
* @TODO There is plugin.h and also sql_plugin.h. Ostensibly,
* it seems that the two files exist so that plugin.h can provide an
* external API for plugin developers and sql_plugin.h will provide
* and internal server API for dealing with those plugins.
*
* However, there are parts of plugin.h marked "INTERNAL USE ONLY" which
* seems to contradict the above...
*
* Let's figure out a better way of dividing the public and internal API
* and name the files more appropriately.
*
* Also, less #defines, more enums and bitmaps...
*
*/
#ifndef DRIZZLE_SERVER_PLUGIN_H
#define DRIZZLE_SERVER_PLUGIN_H
#include <drizzled/lex_string.h>
#include <mysys/my_alloc.h>
#include <drizzled/plugin_registry.h>
#include <drizzled/plugin.h>
class sys_var;
class Session;
/* A handle for the dynamic library containing a plugin or plugins. */
struct drizzled_plugin_manifest;
struct st_plugin_dl
{
LEX_STRING dl;
void *handle;
struct drizzled_plugin_manifest *plugins;
};
/* A handle of a plugin */
struct st_plugin_int
{
LEX_STRING name;
struct drizzled_plugin_manifest *plugin;
struct st_plugin_dl *plugin_dl;
bool isInited;
MEM_ROOT mem_root; /* memory for dynamic plugin structures */
sys_var *system_vars; /* server variables for this plugin */
};
#define plugin_decl(pi) ((pi)->plugin)
#define plugin_data(pi,cast) (static_cast<cast>((pi)->data))
#define plugin_name(pi) (&((pi)->name))
#define plugin_equals(p1,p2) ((p1) && (p2) && (p1) == (p2))
typedef int (*plugin_type_init)(PluginRegistry &);
/*
Plugin description structure.
*/
struct drizzled_plugin_manifest
{
const char *name; /* plugin name (for SHOW PLUGINS) */
const char *version; /* plugin version (for SHOW PLUGINS) */
const char *author; /* plugin author (for SHOW PLUGINS) */
const char *descr; /* general descriptive text (for SHOW PLUGINS ) */
int license; /* plugin license (PLUGIN_LICENSE_XXX) */
plugin_type_init init; /* function to invoke when plugin is loaded */
plugin_type_init deinit; /* function to invoke when plugin is unloaded */
struct st_mysql_show_var *status_vars;
struct st_mysql_sys_var **system_vars;
void *reserved1; /* reserved for dependency checking */
};
extern char *opt_plugin_load;
extern char *opt_plugin_dir_ptr;
extern char opt_plugin_dir[FN_REFLEN];
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, uint32_t size);
extern bool plugin_is_ready(const LEX_STRING *name, int type);
extern bool mysql_install_plugin(Session *session, const LEX_STRING *name,
const LEX_STRING *dl);
extern bool mysql_uninstall_plugin(Session *session, const LEX_STRING *name);
extern bool plugin_register_builtin(struct drizzled_plugin_manifest *plugin);
extern void plugin_sessionvar_init(Session *session);
extern void plugin_sessionvar_cleanup(Session *session);
#endif /* DRIZZLE_SERVER_PLUGIN_H */
|