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