Cleanup of plugin loader (v6) interface
[olsrd.git] / src / plugin_loader.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2009, the olsr.org team - see HISTORY file
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 #ifndef _OLSR_PLUGIN_LOADER
43 #define _OLSR_PLUGIN_LOADER
44
45 #include "plugin.h"
46 #include "olsr_types.h"
47
48 #include "common/avl.h"
49 #include "common/list.h"
50
51 /*
52  * declare a plugin without parameters (NoParameter)
53  *
54  * OLSR_PLUGIN6_NP() {
55  *   .descr = "<description of the plugin",
56  *   .author = "<author of the plugin",
57  *   .init = <pointer_to_plugin_initialization_callback>,
58  *   .....
59  * };
60  */
61 #define OLSR_PLUGIN6_NP()   static struct olsr_plugin olsr_internal_plugin_definition; \
62 static void hookup_plugin_definition (void) __attribute__ ((constructor)); \
63 static void hookup_plugin_definition (void) { \
64   static const char *plname = PLUGIN_FULLNAME; \
65   olsr_internal_plugin_definition.name = plname; \
66   olsr_hookup_plugin(&olsr_internal_plugin_definition); \
67 } \
68 static struct olsr_plugin olsr_internal_plugin_definition =
69
70 /*
71  * declare a plugin with parameters
72  *
73  * static const struct olsrd_plugin_parameters plugin_parameters[] = {
74  *   { ...},
75  * };
76  *
77  * OLSR_PLUGIN6(plugin_parameters) {
78  *   .descr = "<description of the plugin",
79  *   .author = "<author of the plugin",
80  *   .init = <pointer_to_plugin_initialization_callback>,
81  *   .....
82  * };
83  */
84 #define OLSR_PLUGIN6(param) static struct olsr_plugin olsr_internal_plugin_definition; \
85 static void hookup_plugin_definition (void) __attribute__ ((constructor)); \
86 static void hookup_plugin_definition (void) { \
87   static const char *plname = PLUGIN_FULLNAME; \
88   olsr_internal_plugin_definition.name = plname; \
89   olsr_internal_plugin_definition.internal_param = param; \
90   olsr_internal_plugin_definition.internal_param_cnt = ARRAYSIZE(param); \
91   olsr_hookup_plugin(&olsr_internal_plugin_definition); \
92 } \
93 static struct olsr_plugin olsr_internal_plugin_definition =
94
95 /* different types of plugins must be initialized at different times during startup */
96 enum plugin_type {
97   PLUGIN_TYPE_ALL = -1,
98   PLUGIN_TYPE_DEFAULT = 0,
99   PLUGIN_TYPE_LQ = 1
100 };
101
102 /* plugin definition functions (version 5) */
103 typedef int (*plugin_init_func) (void);
104 typedef int (*get_interface_version_func) (void);
105 typedef void (*get_plugin_parameters_func) (const struct olsrd_plugin_parameters ** internal_params, unsigned int *size);
106
107 struct olsr_plugin {
108   struct avl_node p_node;
109
110   /* plugin information */
111   const char *name;
112   const char *descr;
113   const char *author;
114
115   /* true if the plugin can be (de)activated during runtime */
116   bool deactivate;
117
118   /* type of the plugin, normally 0 */
119   enum plugin_type type;
120
121   /* plugin callbacks for (de)initialization */
122   int (*init) (void);
123   int (*enable) (void);
124   int (*disable) (void);
125   int (*exit) (void);
126
127   /*
128    * internal callback pointer for legacy plugins, will be initialized
129    * by the plugin loader
130    */
131   int (*internal_legacy_init) (void);
132
133   /* plugin interface version */
134   int internal_version;
135
136   /* plugin list of possible arguments */
137   const struct olsrd_plugin_parameters *internal_param;
138
139   /* number of arguments */
140   unsigned int internal_param_cnt;
141
142   /* internal olsr data */
143   void *internal_dlhandle;
144   struct plugin_param *internal_params;
145   bool internal_active;
146 };
147
148 #define OLSR_FOR_ALL_PLUGIN_ENTRIES(plugin, iterator) avl_for_each_element_safe(&plugin_tree, plugin, p_node, iterator)
149
150 struct olsr_plugin *EXPORT(olsr_get_plugin)(const char *libname);
151
152 void EXPORT(olsr_hookup_plugin) (struct olsr_plugin *plugin);
153 void EXPORT(olsr_unhookup_plugin) (struct olsr_plugin *plugin);
154
155 void olsr_init_pluginsystem(void);
156 void olsr_plugins_init(bool);
157 void olsr_plugins_enable(enum plugin_type type, bool fail_fast);
158 void olsr_destroy_pluginsystem(void);
159
160 struct olsr_plugin *EXPORT(olsr_init_plugin)(const char *);
161 int EXPORT(olsr_exit_plugin)(struct olsr_plugin *);
162
163 int EXPORT(olsr_enable_plugin)(struct olsr_plugin *);
164 int EXPORT(olsr_disable_plugin)(struct olsr_plugin *);
165
166 extern struct avl_tree EXPORT(plugin_tree);
167
168 #endif
169
170 /*
171  * Local Variables:
172  * mode: c
173  * style: linux
174  * c-basic-offset: 4
175  * indent-tabs-mode: nil
176  * End:
177  */