3825b0c77a1fdd1dd620281f758fd09a40640675
[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 #define DEFINE_PLUGIN6(descr, author, pre_init, post_init, pre_cleanup, post_cleanup, deactivate, parameter) \
52 static struct olsr_plugin olsr_internal_plugin_definition = { \
53   .p_name = (char*) PLUGIN_FULLNAME , .p_descr = (char*)descr, .p_author = (char*)author, \
54   .p_pre_init = pre_init, .p_post_init = post_init, .p_pre_cleanup = pre_cleanup, .p_post_cleanup = post_cleanup, \
55   .p_deactivate = deactivate, .p_version = 6, .p_param = parameter, .p_param_cnt = ARRAYSIZE(parameter) \
56 }; \
57 static void hookup_plugin_definition (void) __attribute__ ((constructor)); \
58 static void hookup_plugin_definition (void) { \
59   olsr_hookup_plugin(&olsr_internal_plugin_definition); \
60 }
61
62 /* version 5 */
63 typedef int (*plugin_init_func) (void);
64 typedef int (*get_interface_version_func) (void);
65 typedef void (*get_plugin_parameters_func) (const struct olsrd_plugin_parameters ** params, unsigned int *size);
66
67 struct olsr_plugin {
68   struct avl_node p_node;
69
70   /* plugin information */
71   char *p_name;
72   char *p_descr;
73   char *p_author;
74   bool p_deactivate;    /* plugin can be deactivated */
75
76   /* function pointers */
77   int (*p_pre_init) (void);
78   int (*p_post_init) (void);
79   int (*p_pre_cleanup) (void);
80   void (*p_post_cleanup) (void);
81
82   /* plugin interface version */
83   int p_version;
84
85   /* plugin list of possible arguments */
86   const struct olsrd_plugin_parameters *p_param;
87
88   /* number of arguments */
89   unsigned int p_param_cnt;
90
91   /* internal olsr data */
92   void *dlhandle;
93   struct plugin_param *params;
94   bool active;
95 };
96
97 AVLNODE2STRUCT(plugin_node2tree, struct olsr_plugin, p_node)
98
99 #define OLSR_FOR_ALL_PLUGIN_ENTRIES(plugin) \
100 { \
101   struct avl_node *plugin_node, *next_plugin_node; \
102   for (plugin_node = avl_walk_first(&plugin_tree); \
103     plugin_node; plugin_node = next_plugin_node) { \
104     next_plugin_node = avl_walk_next(plugin_node); \
105     plugin = plugin_node2tree(plugin_node);
106 #define OLSR_FOR_ALL_PLUGIN_ENTRIES_END(plugin) }}
107
108 struct olsr_plugin *EXPORT(olsr_get_plugin)(char *libname);
109
110 void EXPORT(olsr_hookup_plugin) (struct olsr_plugin *plugin);
111 void EXPORT(olsr_unhookup_plugin) (struct olsr_plugin *plugin);
112
113 void EXPORT(olsr_init_pluginsystem)(bool);
114 void EXPORT(olsr_destroy_pluginsystem)(void);
115
116 struct olsr_plugin *EXPORT(olsr_load_plugin)(char *);
117 bool EXPORT(olsr_unload_plugin)(struct olsr_plugin *);
118
119 bool EXPORT(olsr_activate_plugin)(struct olsr_plugin *);
120 bool EXPORT(olsr_deactivate_plugin)(struct olsr_plugin *);
121
122 extern struct avl_tree EXPORT(plugin_tree);
123
124 #endif
125
126 /*
127  * Local Variables:
128  * mode: c
129  * style: linux
130  * c-basic-offset: 4
131  * indent-tabs-mode: nil
132  * End:
133  */