2 * plugin.c: plugin handling
4 * Copyright (c) 2011 Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 #include <vlib/unix/plugin.h>
19 #include <vppinfra/elf.h>
23 plugin_main_t vlib_plugin_main;
25 char *vlib_plugin_path __attribute__ ((weak));
26 char *vlib_plugin_path = "";
27 char *vlib_plugin_app_version __attribute__ ((weak));
28 char *vlib_plugin_app_version = "";
31 vlib_get_plugin_symbol (char *plugin_name, char *symbol_name)
33 plugin_main_t *pm = &vlib_plugin_main;
37 if ((p = hash_get_mem (pm->plugin_by_name_hash, plugin_name)) == 0)
40 pi = vec_elt_at_index (pm->plugin_info, p[0]);
41 return dlsym (pi->handle, symbol_name);
45 str_array_to_vec (char *array, int len)
55 while (c && ++n < len);
64 load_one_plugin (plugin_main_t * pm, plugin_info_t * pi, int from_early_init)
68 elf_main_t em = { 0 };
69 elf_section_t *section;
71 char *version_required;
72 vlib_plugin_registration_t *reg;
73 plugin_config_t *pc = 0;
76 if (elf_read_file (&em, (char *) pi->filename))
79 error = elf_get_section_by_name (&em, ".vlib_plugin_registration",
83 clib_warning ("Not a plugin: %s\n", (char *) pi->name);
87 data = elf_get_section_contents (&em, section->index, 1);
88 reg = (vlib_plugin_registration_t *) data;
90 if (vec_len (data) != sizeof (*reg))
92 clib_warning ("vlib_plugin_registration size mismatch in plugin %s\n",
97 p = hash_get_mem (pm->config_index_by_name, pi->name);
100 pc = vec_elt_at_index (pm->configs, p[0]);
103 clib_warning ("Plugin disabled: %s", pi->name);
106 if (reg->default_disabled && pc->is_enabled == 0)
108 clib_warning ("Plugin disabled (default): %s", pi->name);
112 else if (reg->default_disabled)
114 clib_warning ("Plugin disabled (default): %s", pi->name);
118 version_required = str_array_to_vec ((char *) ®->version_required,
119 sizeof (reg->version_required));
121 if ((strlen (version_required) > 0) &&
122 (strncmp (vlib_plugin_app_version, version_required,
123 strlen (version_required))))
125 clib_warning ("Plugin %s version mismatch: %s != %s",
126 pi->name, vlib_plugin_app_version, reg->version_required);
127 if (!(pc && pc->skip_version_check == 1))
129 vec_free (version_required);
134 vec_free (version_required);
138 handle = dlopen ((char *) pi->filename, RTLD_LAZY);
141 * Note: this can happen if the plugin has an undefined symbol reference,
142 * so print a warning. Otherwise, the poor slob won't know what happened.
143 * Ask me how I know that...
147 clib_warning ("%s", dlerror ());
153 reg = dlsym (pi->handle, "vlib_plugin_registration");
157 /* This should never happen unless somebody chagnes registration macro */
158 clib_warning ("Missing plugin registration in plugin '%s'", pi->name);
163 pi->version = str_array_to_vec ((char *) ®->version,
164 sizeof (reg->version));
168 clib_error_t *(*ei) (vlib_main_t *);
171 h = dlsym (pi->handle, reg->early_init);
175 error = (*ei) (pm->vlib_main);
178 clib_error_report (error);
183 clib_warning ("Plugin %s: early init function %s set but not found",
184 (char *) pi->name, reg->early_init);
187 if (reg->description)
188 clib_warning ("Loaded plugin: %s (%s)", pi->name, reg->description);
190 clib_warning ("Loaded plugin: %s", pi->name);
200 split_plugin_path (plugin_main_t * pm)
204 u8 *path = pm->plugin_path;
207 for (i = 0; i < vec_len (pm->plugin_path); i++)
211 vec_add1 (this, path[i]);
227 plugin_name_sort_cmp (void *a1, void *a2)
229 plugin_info_t *p1 = a1;
230 plugin_info_t *p2 = a2;
232 return strcmp ((char *) p1->name, (char *) p2->name);
236 vlib_load_new_plugins (plugin_main_t * pm, int from_early_init)
239 struct dirent *entry;
244 u32 *load_fail_indices = 0;
247 plugin_path = split_plugin_path (pm);
249 for (i = 0; i < vec_len (plugin_path); i++)
251 dp = opendir ((char *) plugin_path[i]);
256 while ((entry = readdir (dp)))
261 if (pm->plugin_name_filter)
264 for (j = 0; j < vec_len (pm->plugin_name_filter); j++)
265 if (entry->d_name[j] != pm->plugin_name_filter[j])
269 filename = format (0, "%s/%s%c", plugin_path[i], entry->d_name, 0);
271 /* Only accept .so */
272 char *ext = strrchr ((const char *) filename, '.');
274 if (!ext || (strcmp (ext, ".so") != 0) ||
275 stat ((char *) filename, &statb) < 0)
282 /* a dir or other things which aren't plugins */
283 if (!S_ISREG (statb.st_mode))
286 plugin_name = format (0, "%s%c", entry->d_name, 0);
287 /* Have we seen this plugin already? */
288 p = hash_get_mem (pm->plugin_by_name_hash, plugin_name);
291 /* No, add it to the plugin vector */
292 vec_add2 (pm->plugin_info, pi, 1);
293 pi->name = plugin_name;
294 pi->filename = filename;
295 pi->file_info = statb;
296 hash_set_mem (pm->plugin_by_name_hash, plugin_name,
297 pi - pm->plugin_info);
303 vec_free (plugin_path[i]);
305 vec_free (plugin_path);
309 * Sort the plugins by name. This is important.
310 * API traces contain absolute message numbers.
311 * Loading plugins in directory (vs. alphabetical) order
312 * makes trace replay incredibly fragile.
314 vec_sort_with_function (pm->plugin_info, plugin_name_sort_cmp);
317 * Attempt to load the plugins
319 for (i = 0; i < vec_len (pm->plugin_info); i++)
321 pi = vec_elt_at_index (pm->plugin_info, i);
323 if (load_one_plugin (pm, pi, from_early_init))
325 /* Make a note of any which fail to load */
326 vec_add1 (load_fail_indices, i);
327 hash_unset_mem (pm->plugin_by_name_hash, pi->name);
329 vec_free (pi->filename);
333 /* Remove plugin info vector elements corresponding to load failures */
334 if (vec_len (load_fail_indices) > 0)
336 for (i = vec_len (load_fail_indices) - 1; i >= 0; i--)
337 vec_delete (pm->plugin_info, 1, load_fail_indices[i]);
338 vec_free (load_fail_indices);
341 /* Recreate the plugin name hash */
342 for (i = 0; i < vec_len (pm->plugin_info); i++)
344 pi = vec_elt_at_index (pm->plugin_info, i);
345 hash_unset_mem (pm->plugin_by_name_hash, pi->name);
346 hash_set_mem (pm->plugin_by_name_hash, pi->name, pi - pm->plugin_info);
353 vlib_plugin_early_init (vlib_main_t * vm)
355 plugin_main_t *pm = &vlib_plugin_main;
357 if (pm->plugin_path == 0)
358 pm->plugin_path = format (0, "%s%c", vlib_plugin_path, 0);
360 clib_warning ("plugin path %s", pm->plugin_path);
362 pm->plugin_by_name_hash = hash_create_string (0, sizeof (uword));
365 return vlib_load_new_plugins (pm, 1 /* from_early_init */ );
368 static clib_error_t *
369 vlib_plugins_show_cmd_fn (vlib_main_t * vm,
370 unformat_input_t * input, vlib_cli_command_t * cmd)
372 plugin_main_t *pm = &vlib_plugin_main;
379 s = format (s, " Plugin path is: %s\n\n", pm->plugin_path);
380 s = format (s, " %-41s%-33s%s\n", "Plugin", "Version", "Description");
383 hash_foreach_mem (key, value, pm->plugin_by_name_hash,
387 pi = vec_elt_at_index (pm->plugin_info, value);
388 s = format (s, "%3d. %-40s %-32s %s\n", index, key, pi->version,
389 pi->reg->description ? pi->reg->description : "");
395 vlib_cli_output (vm, "%v", s);
401 VLIB_CLI_COMMAND (plugins_show_cmd, static) =
403 .path = "show plugins",
404 .short_help = "show loaded plugins",
405 .function = vlib_plugins_show_cmd_fn,
409 static clib_error_t *
410 config_one_plugin (vlib_main_t * vm, char *name, unformat_input_t * input)
412 plugin_main_t *pm = &vlib_plugin_main;
414 clib_error_t *error = 0;
418 int skip_version_check = 0;
420 if (pm->config_index_by_name == 0)
421 pm->config_index_by_name = hash_create_string (0, sizeof (uword));
423 p = hash_get_mem (pm->config_index_by_name, name);
427 error = clib_error_return (0, "plugin '%s' already configured", name);
431 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
433 if (unformat (input, "enable"))
435 else if (unformat (input, "disable"))
437 else if (unformat (input, "skip-version-check"))
438 skip_version_check = 1;
441 error = clib_error_return (0, "unknown input '%U'",
442 format_unformat_error, input);
447 if (is_enable && is_disable)
449 error = clib_error_return (0, "please specify either enable or disable"
450 " for plugin '%s'", name);
454 vec_add2 (pm->configs, pc, 1);
455 hash_set_mem (pm->config_index_by_name, name, pc - pm->configs);
456 pc->is_enabled = is_enable;
457 pc->is_disabled = is_disable;
458 pc->skip_version_check = skip_version_check;
466 vlib_plugin_config (vlib_main_t * vm, unformat_input_t * input)
468 plugin_main_t *pm = &vlib_plugin_main;
469 clib_error_t *error = 0;
472 unformat_init (&in, 0, 0);
474 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
477 if (unformat (input, "%s %v", &s, &v))
479 if (strncmp ((const char *) s, "plugins", 8) == 0)
481 if (vec_len (in.buffer) > 0)
482 vec_add1 (in.buffer, ' ');
483 vec_add (in.buffer, v, vec_len (v));
488 error = clib_error_return (0, "unknown input '%U'",
489 format_unformat_error, input);
498 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
500 unformat_input_t sub_input;
502 if (unformat (input, "path %s", &s))
504 else if (unformat (input, "plugin %s %U", &s,
505 unformat_vlib_cli_sub_input, &sub_input))
507 error = config_one_plugin (vm, (char *) s, &sub_input);
508 unformat_free (&sub_input);
514 error = clib_error_return (0, "unknown input '%U'",
515 format_unformat_error, input);
528 /* discard whole 'plugins' section, as it is already consumed prior to
530 static clib_error_t *
531 plugins_config (vlib_main_t * vm, unformat_input_t * input)
535 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
537 if (unformat (input, "%s", &junk))
543 return clib_error_return (0, "unknown input '%U'",
544 format_unformat_error, input);
549 VLIB_CONFIG_FUNCTION (plugins_config, "plugins");
552 * fd.io coding-style-patch-verification: ON
555 * eval: (c-set-style "gnu")