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