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