info: java: update workspace
[olsrd.git] / src / plugin_loader.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon (olsrd)
3  *
4  * (c) by the OLSR project
5  *
6  * See our Git repository to find out who worked on this file
7  * and thus is a copyright holder on it.
8  *
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  *
15  * * Redistributions of source code must retain the above copyright
16  *   notice, this list of conditions and the following disclaimer.
17  * * Redistributions in binary form must reproduce the above copyright
18  *   notice, this list of conditions and the following disclaimer in
19  *   the documentation and/or other materials provided with the
20  *   distribution.
21  * * Neither the name of olsr.org, olsrd nor the names of its
22  *   contributors may be used to endorse or promote products derived
23  *   from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  *
38  * Visit http://www.olsr.org for more information.
39  *
40  * If you find this software useful feel free to make a donation
41  * to the project. For more information see the website or contact
42  * the copyright holders.
43  *
44  */
45
46 #include "plugin_loader.h"
47 #include "olsrd_plugin.h"
48 #include "plugin_util.h"
49 #include "defs.h"
50 #include "olsr.h"
51
52 #include <dlfcn.h>
53
54 /* Local functions */
55 static int init_olsr_plugin(struct olsr_plugin *);
56 static int olsr_load_dl(char *, struct plugin_param *);
57 static int olsr_add_dl(struct olsr_plugin *);
58
59 static struct olsr_plugin *olsr_plugins = NULL;
60
61 /**
62  *Function that loads all registered plugins
63  *
64  *@return the number of plugins loaded
65  */
66 void
67 olsr_load_plugins(void)
68 {
69   struct plugin_entry *entry = olsr_cnf->plugins;
70   int rv = 0;
71   for (entry = olsr_cnf->plugins; entry != NULL; entry = entry->next) {
72     if (olsr_load_dl(entry->name, entry->params) < 0) {
73       rv = 1;
74     }
75   }
76   if (rv != 0) {
77     olsr_exit("-- PLUGIN LOADING FAILED --", EXIT_FAILURE);
78   }
79   OLSR_PRINTF(0, "-- ALL PLUGINS LOADED! --\n\n");
80 }
81
82 /**
83  *Try to load a shared library and extract
84  *the required information
85  *
86  *@param libname the name of the library(file)
87  *@param params plugin parameters
88  *
89  *@return negative on error
90  */
91 static int
92 olsr_load_dl(char *libname, struct plugin_param *params)
93 {
94 #if defined TESTLIB_PATH && TESTLIB_PATH
95   char path[256] = "/usr/testlib/";
96 #endif /* defined TESTLIB_PATH && TESTLIB_PATH */
97   struct olsr_plugin *plugin = olsr_malloc(sizeof(struct olsr_plugin), "Plugin entry");
98   int rv;
99
100   OLSR_PRINTF(0, "---------- LOADING LIBRARY %s ----------\n", libname);
101
102 #if defined TESTLIB_PATH && TESTLIB_PATH
103   strcat(path, libname);
104   plugin->dlhandle = dlopen(path, RTLD_NOW);
105 #else /* defined TESTLIB_PATH && TESTLIB_PATH */
106   plugin->dlhandle = dlopen(libname, RTLD_NOW);
107 #endif /* defined TESTLIB_PATH && TESTLIB_PATH */
108   if (plugin->dlhandle == NULL) {
109     const int save_errno = errno;
110     OLSR_PRINTF(0, "DL loading failed: \"%s\"!\n", dlerror());
111     free(plugin);
112     errno = save_errno;
113     return -1;
114   }
115
116   rv = olsr_add_dl(plugin);
117   if (rv == -1) {
118     const int save_errno = errno;
119     dlclose(plugin->dlhandle);
120     free(plugin);
121     errno = save_errno;
122   } else {
123     plugin->params = params;
124
125     /* Initialize the plugin */
126     if (init_olsr_plugin(plugin) != 0) {
127       rv = -1;
128     }
129
130     /* queue */
131     plugin->next = olsr_plugins;
132     olsr_plugins = plugin;
133   }
134   OLSR_PRINTF(0, "---------- LIBRARY %s %s ----------\n\n", libname, rv == 0 ? "LOADED" : "FAILED");
135   return rv;
136 }
137
138 #if defined SUPPORT_OLD_PLUGIN_VERSIONS && SUPPORT_OLD_PLUGIN_VERSIONS
139 static int
140 try_old_versions(const struct olsr_plugin *plugin)
141 {
142   get_interface_version_func get_interface_version;
143   int *interface_version;
144
145   OLSR_PRINTF(1, "trying v2 detection... ");
146   get_interface_version = dlsym(plugin->dlhandle, "get_plugin_interface_version");
147   if (get_interface_version != NULL) {
148     return get_interface_version();
149   }
150
151   OLSR_PRINTF(1, "trying v1 detection... ");
152   interface_version = dlsym(plugin->dlhandle, "plugin_interface_version");
153   if (interface_version != NULL) {
154     return *interface_version;
155   }
156   OLSR_PRINTF(0, "FAILED: \"%s\"\n", dlerror());
157   return -1;
158 }
159 #else /* defined SUPPORT_OLD_PLUGIN_VERSIONS && SUPPORT_OLD_PLUGIN_VERSIONS */
160 #define try_old_versions(plugin) -1
161 #endif /* defined SUPPORT_OLD_PLUGIN_VERSIONS && SUPPORT_OLD_PLUGIN_VERSIONS */
162
163 static int
164 olsr_add_dl(struct olsr_plugin *plugin)
165 {
166   get_interface_version_func get_interface_version;
167   get_plugin_parameters_func get_plugin_parameters;
168   int plugin_interface_version;
169
170   /* Fetch the interface version function, 3 different ways */
171   OLSR_PRINTF(0, "Checking plugin interface version: ");
172   get_interface_version = dlsym(plugin->dlhandle, "olsrd_plugin_interface_version");
173   if (get_interface_version == NULL) {
174     plugin_interface_version = try_old_versions(plugin);
175   } else {
176     plugin_interface_version = get_interface_version();
177   }
178   if (plugin_interface_version == -1) {
179     OLSR_PRINTF(0, "FAILED: \"%s\"\n", dlerror());
180     return -1;
181   }
182   OLSR_PRINTF(0, " %d - OK\n", plugin_interface_version);
183
184   if (plugin_interface_version < 5) {
185     /* old plugin interface */
186     OLSR_PRINTF(0,
187                 "\nWARNING: YOU ARE USING AN OLD DEPRECATED PLUGIN INTERFACE!\n"
188                 "DETECTED VERSION %d AND THE CURRENT VERSION IS %d\n" "PLEASE UPGRADE YOUR PLUGIN!\n", plugin_interface_version,
189                 MOST_RECENT_PLUGIN_INTERFACE_VERSION);
190 #if defined SUPPORT_OLD_PLUGIN_VERSIONS && SUPPORT_OLD_PLUGIN_VERSIONS
191     OLSR_PRINTF(0, "WILL CONTINUE IN 5 SECONDS...\n\n");
192     sleep(5);
193 #else /* defined SUPPORT_OLD_PLUGIN_VERSIONS && SUPPORT_OLD_PLUGIN_VERSIONS */
194     return -1;
195 #endif /* defined SUPPORT_OLD_PLUGIN_VERSIONS && SUPPORT_OLD_PLUGIN_VERSIONS */
196   }
197 #if defined SUPPORT_OLD_PLUGIN_VERSIONS && SUPPORT_OLD_PLUGIN_VERSIONS
198   /* new plugin interface */
199   if (plugin_interface_version < LAST_SUPPORTED_PLUGIN_INTERFACE_VERSION) {
200     OLSR_PRINTF(0,
201                 "\n\nWARNING: VERSION MISMATCH!\n" "DETECTED %d AND LAST SUPPORTED VERSION IS %d\n"
202                 "THIS CAN CAUSE UNEXPECTED BEHAVIOUR AND CRASHES!\n" "WILL CONTINUE IN 5 SECONDS...\n\n", get_interface_version(),
203                 LAST_SUPPORTED_PLUGIN_INTERFACE_VERSION);
204     sleep(5);
205   }
206 #endif /* defined SUPPORT_OLD_PLUGIN_VERSIONS && SUPPORT_OLD_PLUGIN_VERSIONS */
207
208   /* Fetch the init function */
209   OLSR_PRINTF(1, "Trying to fetch plugin init function: ");
210   plugin->plugin_init = dlsym(plugin->dlhandle, "olsrd_plugin_init");
211   if (plugin->plugin_init == NULL) {
212     OLSR_PRINTF(0, "FAILED: \"%s\"\n", dlerror());
213     return -1;
214   }
215   OLSR_PRINTF(1, "OK\n");
216
217   OLSR_PRINTF(1, "Trying to fetch parameter table and it's size... \n");
218
219   get_plugin_parameters = dlsym(plugin->dlhandle, "olsrd_get_plugin_parameters");
220   if (get_plugin_parameters != NULL) {
221     (*get_plugin_parameters) (&plugin->plugin_parameters, &plugin->plugin_parameters_size);
222   } else {
223 #if defined SUPPORT_OLD_PLUGIN_VERSIONS && SUPPORT_OLD_PLUGIN_VERSIONS
224     /* Fetch the parameter function */
225     OLSR_PRINTF(1, "Trying to fetch param function: ");
226
227     plugin->register_param = dlsym(plugin->dlhandle, "olsrd_plugin_register_param");
228     if (plugin->register_param == NULL) {
229       OLSR_PRINTF(0, "FAILED: \"%s\"\n", dlerror());
230       return -1;
231     } else {
232       OLSR_PRINTF(1, "OK\n");
233     }
234
235     plugin->plugin_parameters = NULL;
236     plugin->plugin_parameters_size = 0;
237 #else /* defined SUPPORT_OLD_PLUGIN_VERSIONS && SUPPORT_OLD_PLUGIN_VERSIONS */
238     OLSR_PRINTF(0, "Old plugin interfaces are not supported\n");
239     return -1;
240 #endif /* defined SUPPORT_OLD_PLUGIN_VERSIONS && SUPPORT_OLD_PLUGIN_VERSIONS */
241   }
242   return 0;
243 }
244
245 /**
246  *Initialize a loaded plugin
247  *This includes sending information
248  *from olsrd to the plugin and
249  *register the functions from the plugin with olsrd
250  *
251  *@param entry the plugin to initialize
252  *
253  *@return -1 if there was an error
254  */
255 static int
256 init_olsr_plugin(struct olsr_plugin *entry)
257 {
258   int rv = 0;
259   struct plugin_param *params;
260   OLSR_PRINTF(1, "Sending parameters...\n");
261   for (params = entry->params; params != NULL; params = params->next) {
262     OLSR_PRINTF(1, "\"%s\"/\"%s\"... ", params->key, params->value);
263     if (entry->plugin_parameters_size != 0) {
264       unsigned int i;
265       int rc = 0;
266       for (i = 0; i < entry->plugin_parameters_size; i++) {
267         if (0 == entry->plugin_parameters[i].name[0] || 0 == strcasecmp(entry->plugin_parameters[i].name, params->key)) {
268           /* we have found it! */
269           rc =
270             entry->plugin_parameters[i].set_plugin_parameter(params->value, entry->plugin_parameters[i].data,
271                                                              0 == entry->plugin_parameters[i].name[0]
272                                                              ? (set_plugin_parameter_addon)
273                                                              params->key : entry->plugin_parameters[i].addon);
274           if (rc != 0) {
275             fprintf(stderr, "\nFatal error in plugin parameter \"%s\"/\"%s\"\n", params->key, params->value);
276             rv = -1;
277           }
278           break;
279         }
280       }
281       if (i >= entry->plugin_parameters_size) {
282         OLSR_PRINTF(0, "Ignored parameter \"%s\"\n", params->key);
283       } else {
284         OLSR_PRINTF(1, "%s: %s\n", params->key, rc == 0 ? "OK" : "FAILED");
285         if (rc != 0) {
286           rv = -1;
287         }
288       }
289 #if defined SUPPORT_OLD_PLUGIN_VERSIONS && SUPPORT_OLD_PLUGIN_VERSIONS
290     } else if (entry->register_param != NULL) {
291       int rc;
292       OLSR_PRINTF(0, "Registering parameter \"%s\": ", params->key);
293       rc = entry->register_param(params->key, params->value);
294       if (rc < 0) {
295         char buf[1024];
296         snprintf(buf, sizeof(buf), "Fatal error in plugin parameter \"%s\"/\"%s\"", params->key, params->value);
297         olsr_exit(buf, EXIT_FAILURE);
298       }
299       OLSR_PRINTF(0, "%s\n", rc == 0 ? "FAILED" : "OK");
300 #endif /* defined SUPPORT_OLD_PLUGIN_VERSIONS && SUPPORT_OLD_PLUGIN_VERSIONS */
301     } else {
302       OLSR_PRINTF(0, "I don't know what to do with \"%s\"!\n", params->key);
303       rv = -1;
304     }
305   }
306
307   OLSR_PRINTF(1, "Running plugin_init function...\n");
308   entry->plugin_init();
309   return rv;
310 }
311
312 /**
313  *Close all loaded plugins
314  */
315 void
316 olsr_close_plugins(void)
317 {
318   struct olsr_plugin *entry;
319
320   OLSR_PRINTF(0, "Closing plugins...\n");
321   for (entry = olsr_plugins; entry != NULL; entry = entry->next) {
322     dlclose(entry->dlhandle);
323     entry->dlhandle = NULL;
324   }
325 }
326
327 /*
328  * Local Variables:
329  * mode: c
330  * style: linux
331  * c-basic-offset: 4
332  * indent-tabs-mode: nil
333  * End:
334  */