ome usefaul optional features for running multiple olsrds
[olsrd.git] / src / plugin_loader.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004, Andreas Tonnesen(andreto@olsr.org)
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 #include "plugin_loader.h"
43 #include "olsrd_plugin.h"
44 #include "plugin_util.h"
45 #include "defs.h"
46 #include "olsr.h"
47
48 #include <dlfcn.h>
49
50 /* Local functions */
51 static int init_olsr_plugin(struct olsr_plugin *);
52 static int olsr_load_dl(char *, struct plugin_param *);
53 static int olsr_add_dl(struct olsr_plugin *);
54
55 static struct olsr_plugin *olsr_plugins = NULL;
56
57 /**
58  *Function that loads all registered plugins
59  *
60  *@return the number of plugins loaded
61  */
62 void
63 olsr_load_plugins(void)
64 {
65   struct plugin_entry *entry = olsr_cnf->plugins;
66   int rv = 0;
67   for (entry = olsr_cnf->plugins; entry != NULL; entry = entry->next) {
68     if (olsr_load_dl(entry->name, entry->params) < 0) {
69       rv = 1;
70     }
71   }
72   if (rv != 0) {
73     OLSR_PRINTF(0, "-- PLUGIN LOADING FAILED! --\n");
74     exit(1);
75   }
76   OLSR_PRINTF(0, "-- ALL PLUGINS LOADED! --\n\n");
77 }
78
79 /**
80  *Try to load a shared library and extract
81  *the required information
82  *
83  *@param libname the name of the library(file)
84  *
85  *@return negative on error
86  */
87 static int
88 olsr_load_dl(char *libname, struct plugin_param *params)
89 {
90 #if TESTLIB_PATH
91   char path[256] = "/usr/testlib/";
92 #endif
93   struct olsr_plugin *plugin = olsr_malloc(sizeof(struct olsr_plugin), "Plugin entry");
94   int rv;
95
96   OLSR_PRINTF(0, "---------- LOADING LIBRARY %s ----------\n", libname);
97
98 #if TESTLIB_PATH
99   strcat(path, libname);
100   plugin->dlhandle = dlopen(path, RTLD_NOW);
101 #else
102   plugin->dlhandle = dlopen(libname, RTLD_NOW);
103 #endif
104   if (plugin->dlhandle == NULL) {
105     const int save_errno = errno;
106     OLSR_PRINTF(0, "DL loading failed: \"%s\"!\n", dlerror());
107     free(plugin);
108     errno = save_errno;
109     return -1;
110   }
111
112   rv = olsr_add_dl(plugin);
113   if (rv == -1) {
114     const int save_errno = errno;
115     dlclose(plugin->dlhandle);
116     free(plugin);
117     errno = save_errno;
118   } else {
119     plugin->params = params;
120
121     /* Initialize the plugin */
122     if (init_olsr_plugin(plugin) != 0) {
123       rv = -1;
124     }
125
126     /* queue */
127     plugin->next = olsr_plugins;
128     olsr_plugins = plugin;
129   }
130   OLSR_PRINTF(0, "---------- LIBRARY %s %s ----------\n\n", libname, rv == 0 ? "LOADED" : "FAILED");
131   return rv;
132 }
133
134 #if SUPPORT_OLD_PLUGIN_VERSIONS
135 static int
136 try_old_versions(const struct olsr_plugin *plugin)
137 {
138   get_interface_version_func get_interface_version;
139   int *interface_version;
140
141   OLSR_PRINTF(1, "trying v2 detection... ");
142   get_interface_version = dlsym(plugin->dlhandle, "get_plugin_interface_version");
143   if (get_interface_version != NULL) {
144     return get_interface_version();
145   }
146
147   OLSR_PRINTF(1, "trying v1 detection... ");
148   interface_version = dlsym(plugin->dlhandle, "plugin_interface_version");
149   if (interface_version != NULL) {
150     return *interface_version;
151   }
152   OLSR_PRINTF(0, "FAILED: \"%s\"\n", dlerror());
153   return -1;
154 }
155 #else
156 #define try_old_versions(plugin) -1
157 #endif
158
159 static int
160 olsr_add_dl(struct olsr_plugin *plugin)
161 {
162   get_interface_version_func get_interface_version;
163   get_plugin_parameters_func get_plugin_parameters;
164   int plugin_interface_version;
165
166   /* Fetch the interface version function, 3 different ways */
167   OLSR_PRINTF(0, "Checking plugin interface version: ");
168   get_interface_version = dlsym(plugin->dlhandle, "olsrd_plugin_interface_version");
169   if (get_interface_version == NULL) {
170     plugin_interface_version = try_old_versions(plugin);
171   } else {
172     plugin_interface_version = get_interface_version();
173   }
174   if (plugin_interface_version == -1) {
175     OLSR_PRINTF(0, "FAILED: \"%s\"\n", dlerror());
176     return -1;
177   }
178   OLSR_PRINTF(0, " %d - OK\n", plugin_interface_version);
179
180   if (plugin_interface_version < 5) {
181     /* old plugin interface */
182     OLSR_PRINTF(0,
183                 "\nWARNING: YOU ARE USING AN OLD DEPRECATED PLUGIN INTERFACE!\n"
184                 "DETECTED VERSION %d AND THE CURRENT VERSION IS %d\n" "PLEASE UPGRADE YOUR PLUGIN!\n", plugin_interface_version,
185                 MOST_RECENT_PLUGIN_INTERFACE_VERSION);
186 #if SUPPORT_OLD_PLUGIN_VERSIONS
187     OLSR_PRINTF(0, "WILL CONTINUE IN 5 SECONDS...\n\n");
188     sleep(5);
189 #else
190     return -1;
191 #endif
192   }
193 #if SUPPORT_OLD_PLUGIN_VERSIONS
194   /* new plugin interface */
195   if (plugin_interface_version < LAST_SUPPORTED_PLUGIN_INTERFACE_VERSION) {
196     OLSR_PRINTF(0,
197                 "\n\nWARNING: VERSION MISMATCH!\n" "DETECTED %d AND LAST SUPPORTED VERSION IS %d\n"
198                 "THIS CAN CAUSE UNEXPECTED BEHAVIOUR AND CRASHES!\n" "WILL CONTINUE IN 5 SECONDS...\n\n", get_interface_version(),
199                 LAST_SUPPORTED_PLUGIN_INTERFACE_VERSION);
200     sleep(5);
201   }
202 #endif
203
204   /* Fetch the init function */
205   OLSR_PRINTF(1, "Trying to fetch plugin init function: ");
206   plugin->plugin_init = dlsym(plugin->dlhandle, "olsrd_plugin_init");
207   if (plugin->plugin_init == NULL) {
208     OLSR_PRINTF(0, "FAILED: \"%s\"\n", dlerror());
209     return -1;
210   }
211   OLSR_PRINTF(1, "OK\n");
212
213   OLSR_PRINTF(1, "Trying to fetch parameter table and it's size... \n");
214
215   get_plugin_parameters = dlsym(plugin->dlhandle, "olsrd_get_plugin_parameters");
216   if (get_plugin_parameters != NULL) {
217     (*get_plugin_parameters) (&plugin->plugin_parameters, &plugin->plugin_parameters_size);
218   } else {
219 #if SUPPORT_OLD_PLUGIN_VERSIONS
220     /* Fetch the parameter function */
221     OLSR_PRINTF(1, "Trying to fetch param function: ");
222
223     plugin->register_param = dlsym(plugin->dlhandle, "olsrd_plugin_register_param");
224     if (plugin->register_param == NULL) {
225       OLSR_PRINTF(0, "FAILED: \"%s\"\n", dlerror());
226       return -1;
227     } else {
228       OLSR_PRINTF(1, "OK\n");
229     }
230
231     plugin->plugin_parameters = NULL;
232     plugin->plugin_parameters_size = 0;
233 #else
234     OLSR_PRINTF(0, "Old plugin interfaces are not supported\n");
235     return -1;
236 #endif
237   }
238   return 0;
239 }
240
241 /**
242  *Initialize a loaded plugin
243  *This includes sending information
244  *from olsrd to the plugin and
245  *register the functions from the plugin with olsrd
246  *
247  *@param entry the plugin to initialize
248  *
249  *@return -1 if there was an error
250  */
251 static int
252 init_olsr_plugin(struct olsr_plugin *entry)
253 {
254   int rv = 0;
255   struct plugin_param *params;
256   OLSR_PRINTF(1, "Sending parameters...\n");
257   for (params = entry->params; params != NULL; params = params->next) {
258     OLSR_PRINTF(1, "\"%s\"/\"%s\"... ", params->key, params->value);
259     if (entry->plugin_parameters_size != 0) {
260       unsigned int i;
261       int rc = 0;
262       for (i = 0; i < entry->plugin_parameters_size; i++) {
263         if (0 == entry->plugin_parameters[i].name[0] || 0 == strcasecmp(entry->plugin_parameters[i].name, params->key)) {
264           /* we have found it! */
265           rc =
266             entry->plugin_parameters[i].set_plugin_parameter(params->value, entry->plugin_parameters[i].data,
267                                                              0 == entry->plugin_parameters[i].name[0]
268                                                              ? (set_plugin_parameter_addon)
269                                                              params->key : entry->plugin_parameters[i].addon);
270           if (rc != 0) {
271             fprintf(stderr, "\nFatal error in plugin parameter \"%s\"/\"%s\"\n", params->key, params->value);
272             rv = -1;
273           }
274           break;
275         }
276       }
277       if (i >= entry->plugin_parameters_size) {
278         OLSR_PRINTF(0, "Ignored parameter \"%s\"\n", params->key);
279       } else {
280         OLSR_PRINTF(1, "%s: %s\n", params->key, rc == 0 ? "OK" : "FAILED");
281         if (rc != 0) {
282           rv = -1;
283         }
284       }
285 #if SUPPORT_OLD_PLUGIN_VERSIONS
286     } else if (entry->register_param != NULL) {
287       int rc;
288       OLSR_PRINTF(0, "Registering parameter \"%s\": ", params->key);
289       rc = entry->register_param(params->key, params->value);
290       if (rc < 0) {
291         fprintf(stderr, "\nFatal error in plugin parameter \"%s\"/\"%s\"\n", params->key, params->value);
292         exit(EXIT_FAILURE);
293       }
294       OLSR_PRINTF(0, "%s\n", rc == 0 ? "FAILED" : "OK");
295 #endif
296     } else {
297       OLSR_PRINTF(0, "I don't know what to do with \"%s\"!\n", params->key);
298       rv = -1;
299     }
300   }
301
302   OLSR_PRINTF(1, "Running plugin_init function...\n");
303   entry->plugin_init();
304   return rv;
305 }
306
307 /**
308  *Close all loaded plugins
309  */
310 void
311 olsr_close_plugins(void)
312 {
313   struct olsr_plugin *entry;
314
315   OLSR_PRINTF(0, "Closing plugins...\n");
316   for (entry = olsr_plugins; entry != NULL; entry = entry->next) {
317     dlclose(entry->dlhandle);
318     entry->dlhandle = NULL;
319   }
320 }
321
322 /*
323  * Local Variables:
324  * mode: c
325  * style: linux
326  * c-basic-offset: 4
327  * indent-tabs-mode: nil
328  * End:
329  */