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