Remove memory allocation in olsr_timer_add()
[oonf.git] / src / core / olsr_plugins.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2011, 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 "common/common_types.h"
46 #include "common/avl.h"
47 #include "common/list.h"
48
49 /*
50  * declare a plugin
51  *
52  * OLSR_PLUGIN7 {
53  *   .descr = "<description of the plugin",
54  *   .author = "<author of the plugin",
55  *   .....
56  * };
57  */
58 #define OLSR_PLUGIN7 _OLSR_PLUGIN7_DEF(PLUGIN_FULLNAME)
59
60 #define _OLSR_PLUGIN7_DEF(param) _OLSR_PLUGIN7_DEF2(param)
61 #define _OLSR_PLUGIN7_DEF2(plg_name) static struct olsr_plugin olsr_internal_plugin_definition; \
62 EXPORT void hookup_plugin_ ## plg_name (void) __attribute__ ((constructor)); \
63 void hookup_plugin_ ## plg_name (void) { \
64   olsr_internal_plugin_definition.name = #plg_name; \
65   olsr_plugins_hook(&olsr_internal_plugin_definition); \
66 } \
67 static struct olsr_plugin olsr_internal_plugin_definition =
68
69 struct olsr_plugin {
70   struct avl_node p_node;
71
72   /* plugin information */
73   const char *name;
74   const char *descr;
75   const char *author;
76
77   /* true if the plugin can be (de)activated during runtime */
78   bool deactivate;
79
80   /* plugin callbacks for (de)initialization */
81   int (*load) (void);
82   int (*enable) (void);
83   int (*disable) (void);
84   int (*unload) (void);
85
86   /* pointer to dlopen handle */
87   void *int_dlhandle;
88
89   /* true if the plugin has been loaded */
90   bool int_loaded;
91
92   /* true if the plugin has been enables */
93   bool int_enabled;
94 };
95
96 #define OLSR_FOR_ALL_PLUGIN_ENTRIES(plugin, iterator) avl_for_each_element_safe(&plugin_tree, plugin, p_node, iterator)
97 EXPORT extern struct avl_tree plugin_tree;
98
99 EXPORT void olsr_plugins_init(void);
100 EXPORT void olsr_plugins_cleanup(void);
101
102 EXPORT void olsr_plugins_hook(struct olsr_plugin *plugin);
103 EXPORT int olsr_plugins_init_static(void) __attribute__((warn_unused_result));
104
105 EXPORT struct olsr_plugin *olsr_plugins_get(const char *libname);
106
107 EXPORT struct olsr_plugin *olsr_plugins_load(const char *);
108 EXPORT int olsr_plugins_unload(struct olsr_plugin *);
109 EXPORT int olsr_plugins_enable(struct olsr_plugin *);
110 EXPORT int olsr_plugins_disable(struct olsr_plugin *);
111
112 /**
113  * @param p pointer to plugin
114  * @return true if its a static plugin, false otherwise
115  */
116 static inline bool
117 olsr_plugins_is_static(struct olsr_plugin *p) {
118   return p->int_dlhandle == NULL;
119 }
120
121 /**
122  * @param p pointer to plugin
123  * @return true if its a static plugin, false otherwise
124  */
125 static inline bool
126 olsr_plugins_is_enabled(struct olsr_plugin *p) {
127   return p->int_enabled;
128 }
129
130 #endif