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 #define PLUGIN_LOG_DBG(...) \
26 do {vlib_log_debug (vlib_plugin_main.logger, __VA_ARGS__);} while(0)
27 #define PLUGIN_LOG_ERR(...) \
28 do {vlib_log_err (vlib_plugin_main.logger, __VA_ARGS__);} while(0)
29 #define PLUGIN_LOG_NOTICE(...) \
30 do {vlib_log_notice (vlib_plugin_main.logger, __VA_ARGS__);} while(0)
32 char *vlib_plugin_path __attribute__ ((weak));
33 char *vlib_plugin_path = "";
34 char *vlib_plugin_app_version __attribute__ ((weak));
35 char *vlib_plugin_app_version = "";
38 vlib_get_plugin_symbol (char *plugin_name, char *symbol_name)
40 plugin_main_t *pm = &vlib_plugin_main;
44 if ((p = hash_get_mem (pm->plugin_by_name_hash, plugin_name)) == 0)
47 pi = vec_elt_at_index (pm->plugin_info, p[0]);
48 return dlsym (pi->handle, symbol_name);
52 str_array_to_vec (char *array, int len)
62 while (c && ++n < len);
71 extract (u8 * sp, u8 * ep)
85 * If a plugin .so contains a ".vlib_plugin_r2" section,
86 * this function converts the vlib_plugin_r2_t to
87 * a vlib_plugin_registration_t.
91 r2_to_reg (elf_main_t * em, vlib_plugin_r2_t * r2,
92 vlib_plugin_registration_t * reg)
95 elf_section_t *section;
96 uword data_segment_offset;
99 /* It turns out that the strings land in the ".data" section */
100 error = elf_get_section_by_name (em, ".data", §ion);
103 data = elf_get_section_contents (em, section->index, 1);
106 * Offsets in the ".vlib_plugin_r2" section
107 * need to have the data section base subtracted from them.
108 * The offset is in the first 8 bytes of the ".data" section
111 data_segment_offset = *((uword *) data);
113 /* Relocate pointers, subtract data_segment_offset */
114 #define _(a) r2->a.data_segment_offset -= data_segment_offset;
115 foreach_r2_string_field;
118 if (r2->version.length >= ARRAY_LEN (reg->version) - 1)
119 return clib_error_return (0, "Version string too long");
121 if (r2->version_required.length >= ARRAY_LEN (reg->version_required) - 1)
122 return clib_error_return (0, "Version-required string too long");
124 if (r2->overrides.length >= ARRAY_LEN (reg->overrides) - 1)
125 return clib_error_return (0, "Override string too long");
127 /* Compatibility with C-initializer */
128 memcpy ((void *) reg->version, data + r2->version.data_segment_offset,
130 memcpy ((void *) reg->version_required,
131 data + r2->version_required.data_segment_offset,
132 r2->version_required.length);
133 memcpy ((void *) reg->overrides, data + r2->overrides.data_segment_offset,
134 r2->overrides.length);
136 if (r2->early_init.length > 0)
139 vec_validate (ei, r2->early_init.length + 1);
140 memcpy (ei, data + r2->early_init.data_segment_offset,
141 r2->early_init.length);
142 reg->early_init = (void *) ei;
145 if (r2->description.length > 0)
148 vec_validate (desc, r2->description.length + 1);
149 memcpy (desc, data + r2->description.data_segment_offset,
150 r2->description.length);
151 reg->description = (void *) desc;
159 load_one_plugin (plugin_main_t * pm, plugin_info_t * pi, int from_early_init)
164 elf_main_t em = { 0 };
165 elf_section_t *section;
167 char *version_required;
168 vlib_plugin_registration_t *reg;
169 vlib_plugin_r2_t *r2;
170 plugin_config_t *pc = 0;
173 if (elf_read_file (&em, (char *) pi->filename))
176 /* New / improved (well, not really) registration structure? */
177 error = elf_get_section_by_name (&em, ".vlib_plugin_r2", §ion);
180 data = elf_get_section_contents (&em, section->index, 1);
181 r2 = (vlib_plugin_r2_t *) data;
182 reg = clib_mem_alloc (sizeof (*reg));
183 memset (reg, 0, sizeof (*reg));
185 reg->default_disabled = r2->default_disabled != 0;
186 error = r2_to_reg (&em, r2, reg);
189 PLUGIN_LOG_ERR ("Bad r2 registration: %s\n", (char *) pi->name);
192 if (pm->plugins_default_disable)
193 reg->default_disabled = 1;
198 error = elf_get_section_by_name (&em, ".vlib_plugin_registration",
202 PLUGIN_LOG_ERR ("Not a plugin: %s\n", (char *) pi->name);
206 data = elf_get_section_contents (&em, section->index, 1);
207 reg = (vlib_plugin_registration_t *) data;
209 if (vec_len (data) != sizeof (*reg))
211 PLUGIN_LOG_ERR ("vlib_plugin_registration size mismatch in plugin %s\n",
216 if (pm->plugins_default_disable)
217 reg->default_disabled = 1;
220 p = hash_get_mem (pm->config_index_by_name, pi->name);
223 pc = vec_elt_at_index (pm->configs, p[0]);
226 PLUGIN_LOG_NOTICE ("Plugin disabled: %s", pi->name);
229 if (reg->default_disabled && pc->is_enabled == 0)
231 PLUGIN_LOG_NOTICE ("Plugin disabled (default): %s", pi->name);
235 else if (reg->default_disabled)
237 PLUGIN_LOG_NOTICE ("Plugin disabled (default): %s", pi->name);
241 version_required = str_array_to_vec ((char *) ®->version_required,
242 sizeof (reg->version_required));
244 if ((strlen (version_required) > 0) &&
245 (strncmp (vlib_plugin_app_version, version_required,
246 strlen (version_required))))
248 PLUGIN_LOG_ERR ("Plugin %s version mismatch: %s != %s",
249 pi->name, vlib_plugin_app_version,
250 reg->version_required);
251 if (!(pc && pc->skip_version_check == 1))
253 vec_free (version_required);
259 * Collect names of plugins overridden (disabled) by the
262 if (reg->overrides[0])
264 const char *overrides = reg->overrides;
265 u8 *override_name_copy, *overridden_by_name_copy;
269 sp = ep = (u8 *) overrides;
274 || (sp >= (u8 *) overrides + ARRAY_LEN (reg->overrides)))
276 if (*sp == ' ' || *sp == ',')
282 while (*ep && *ep != ' ' && *ep != ',' &&
283 ep < (u8 *) overrides + ARRAY_LEN (reg->overrides))
285 if (*ep == ' ' || *ep == ',')
288 override_name_copy = extract (sp, ep);
291 p = hash_get_mem (pm->plugin_overrides_by_name_hash,
293 /* Already overridden... */
295 vec_free (override_name_copy);
298 overridden_by_name_copy = format (0, "%s%c", pi->name, 0);
299 hash_set_mem (pm->plugin_overrides_by_name_hash,
300 override_name_copy, overridden_by_name_copy);
302 sp = *ep ? ep + 1 : ep;
305 vec_free (version_required);
307 handle = dlopen ((char *) pi->filename,
308 RTLD_LAZY | (reg->deep_bind ? RTLD_DEEPBIND : 0));
312 PLUGIN_LOG_ERR ("%s", dlerror ());
313 PLUGIN_LOG_ERR ("Failed to load plugin '%s'", pi->name);
320 reg = dlsym (pi->handle, "vlib_plugin_registration");
323 pi->version = str_array_to_vec ((char *) ®->version,
324 sizeof (reg->version));
328 clib_error_t *(*ei) (vlib_main_t *);
331 h = dlsym (pi->handle, reg->early_init);
335 error = (*ei) (pm->vlib_main);
338 u8 *err = format (0, "%s: %U%c", pi->name,
339 format_clib_error, error, 0);
340 PLUGIN_LOG_ERR ((char *) err);
341 clib_error_free (error);
342 dlclose (pi->handle);
348 PLUGIN_LOG_ERR ("Plugin %s: early init function %s set but not found",
349 (char *) pi->name, reg->early_init);
352 if (reg->description)
353 PLUGIN_LOG_NOTICE ("Loaded plugin: %s (%s)", pi->name, reg->description);
355 PLUGIN_LOG_NOTICE ("Loaded plugin: %s", pi->name);
368 split_plugin_path (plugin_main_t * pm)
372 u8 *path = pm->plugin_path;
375 for (i = 0; i < vec_len (pm->plugin_path); i++)
379 vec_add1 (this, path[i]);
395 plugin_name_sort_cmp (void *a1, void *a2)
397 plugin_info_t *p1 = a1;
398 plugin_info_t *p2 = a2;
400 return strcmp ((char *) p1->name, (char *) p2->name);
404 index_cmp (void *a1, void *a2)
406 uword *i1 = (uword *) a1, *i2 = (uword *) a2;
417 vlib_load_new_plugins (plugin_main_t * pm, int from_early_init)
420 struct dirent *entry;
425 uword *not_loaded_indices = 0;
428 plugin_path = split_plugin_path (pm);
430 for (i = 0; i < vec_len (plugin_path); i++)
432 dp = opendir ((char *) plugin_path[i]);
437 while ((entry = readdir (dp)))
442 if (pm->plugin_name_filter)
445 for (j = 0; j < vec_len (pm->plugin_name_filter); j++)
446 if (entry->d_name[j] != pm->plugin_name_filter[j])
450 filename = format (0, "%s/%s%c", plugin_path[i], entry->d_name, 0);
452 /* Only accept .so */
453 char *ext = strrchr ((const char *) filename, '.');
455 if (!ext || (strcmp (ext, ".so") != 0) ||
456 stat ((char *) filename, &statb) < 0)
463 /* a dir or other things which aren't plugins */
464 if (!S_ISREG (statb.st_mode))
467 plugin_name = format (0, "%s%c", entry->d_name, 0);
468 /* Have we seen this plugin already? */
469 p = hash_get_mem (pm->plugin_by_name_hash, plugin_name);
472 /* No, add it to the plugin vector */
473 vec_add2 (pm->plugin_info, pi, 1);
474 pi->name = plugin_name;
475 pi->filename = filename;
476 pi->file_info = statb;
478 hash_set_mem (pm->plugin_by_name_hash, plugin_name,
479 pi - pm->plugin_info);
485 vec_free (plugin_path[i]);
487 vec_free (plugin_path);
491 * Sort the plugins by name. This is important.
492 * API traces contain absolute message numbers.
493 * Loading plugins in directory (vs. alphabetical) order
494 * makes trace replay incredibly fragile.
496 vec_sort_with_function (pm->plugin_info, plugin_name_sort_cmp);
499 * Attempt to load the plugins
501 for (i = 0; i < vec_len (pm->plugin_info); i++)
503 pi = vec_elt_at_index (pm->plugin_info, i);
505 if (load_one_plugin (pm, pi, from_early_init))
507 /* Make a note of any which fail to load */
508 vec_add1 (not_loaded_indices, i);
513 * Honor override list
515 for (i = 0; i < vec_len (pm->plugin_info); i++)
519 pi = vec_elt_at_index (pm->plugin_info, i);
521 p = hash_get_mem (pm->plugin_overrides_by_name_hash, pi->name);
523 /* Plugin overridden? */
526 PLUGIN_LOG_NOTICE ("Plugin '%s' overridden by '%s'", pi->name,
528 vec_add1 (not_loaded_indices, i);
533 * Sort the vector of indices to delete to avoid screwing up
534 * the indices as we delete them.
536 vec_sort_with_function (not_loaded_indices, index_cmp);
539 * Remove duplicates, which can happen if a plugin is
540 * disabled from the command line and disabled by
541 * a plugin which is loaded.
543 for (i = 0; i < vec_len (not_loaded_indices); i++)
545 if (i < vec_len (not_loaded_indices) - 1)
547 if (not_loaded_indices[i + 1] == not_loaded_indices[i])
549 vec_delete (not_loaded_indices, 1, i);
555 /* Remove plugin info vector elements corresponding to load failures */
556 if (vec_len (not_loaded_indices) > 0)
558 for (i = vec_len (not_loaded_indices) - 1; i >= 0; i--)
560 pi = vec_elt_at_index (pm->plugin_info, not_loaded_indices[i]);
561 hash_unset_mem (pm->plugin_by_name_hash, pi->name);
564 dlclose (pi->handle);
565 PLUGIN_LOG_NOTICE ("Unloaded plugin: %s", pi->name);
568 vec_free (pi->filename);
569 vec_delete (pm->plugin_info, 1, not_loaded_indices[i]);
571 vec_free (not_loaded_indices);
574 /* Recreate the plugin name hash */
575 hash_free (pm->plugin_by_name_hash);
576 pm->plugin_by_name_hash = hash_create_string (0, sizeof (uword));
578 for (i = 0; i < vec_len (pm->plugin_info); i++)
580 pi = vec_elt_at_index (pm->plugin_info, i);
581 hash_set_mem (pm->plugin_by_name_hash, pi->name, pi - pm->plugin_info);
588 vlib_plugin_early_init (vlib_main_t * vm)
590 plugin_main_t *pm = &vlib_plugin_main;
593 vlib_log_register_class_rate_limit ("plugin", "load",
594 0x7FFFFFFF /* aka no rate limit */ );
596 if (pm->plugin_path == 0)
597 pm->plugin_path = format (0, "%s", vlib_plugin_path);
599 if (pm->plugin_path_add)
600 pm->plugin_path = format (pm->plugin_path, ":%s", pm->plugin_path_add);
602 pm->plugin_path = format (pm->plugin_path, "%c", 0);
604 PLUGIN_LOG_DBG ("plugin path %s", pm->plugin_path);
606 pm->plugin_by_name_hash = hash_create_string (0, sizeof (uword));
607 pm->plugin_overrides_by_name_hash = hash_create_string (0, sizeof (uword));
610 return vlib_load_new_plugins (pm, 1 /* from_early_init */ );
614 vlib_get_vat_plugin_path (void)
616 plugin_main_t *pm = &vlib_plugin_main;
617 return (pm->vat_plugin_path);
621 vlib_get_vat_plugin_name_filter (void)
623 plugin_main_t *pm = &vlib_plugin_main;
624 return (pm->vat_plugin_name_filter);
627 static clib_error_t *
628 vlib_plugins_show_cmd_fn (vlib_main_t * vm,
629 unformat_input_t * input, vlib_cli_command_t * cmd)
631 plugin_main_t *pm = &vlib_plugin_main;
638 s = format (s, " Plugin path is: %s\n\n", pm->plugin_path);
639 s = format (s, " %-41s%-33s%s\n", "Plugin", "Version", "Description");
642 hash_foreach_mem (key, value, pm->plugin_by_name_hash,
646 pi = vec_elt_at_index (pm->plugin_info, value);
647 s = format (s, "%3d. %-40s %-32s %s\n", index, key, pi->version,
648 (pi->reg && pi->reg->description) ?
649 pi->reg->description : "");
655 vlib_cli_output (vm, "%v", s);
661 VLIB_CLI_COMMAND (plugins_show_cmd, static) =
663 .path = "show plugins",
664 .short_help = "show loaded plugins",
665 .function = vlib_plugins_show_cmd_fn,
669 static clib_error_t *
670 config_one_plugin (vlib_main_t * vm, char *name, unformat_input_t * input)
672 plugin_main_t *pm = &vlib_plugin_main;
674 clib_error_t *error = 0;
678 int skip_version_check = 0;
680 if (pm->config_index_by_name == 0)
681 pm->config_index_by_name = hash_create_string (0, sizeof (uword));
683 p = hash_get_mem (pm->config_index_by_name, name);
687 error = clib_error_return (0, "plugin '%s' already configured", name);
691 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
693 if (unformat (input, "enable"))
695 else if (unformat (input, "disable"))
697 else if (unformat (input, "skip-version-check"))
698 skip_version_check = 1;
701 error = clib_error_return (0, "unknown input '%U'",
702 format_unformat_error, input);
707 if (is_enable && is_disable)
709 error = clib_error_return (0, "please specify either enable or disable"
710 " for plugin '%s'", name);
714 vec_add2 (pm->configs, pc, 1);
715 hash_set_mem (pm->config_index_by_name, name, pc - pm->configs);
716 pc->is_enabled = is_enable;
717 pc->is_disabled = is_disable;
718 pc->skip_version_check = skip_version_check;
726 vlib_plugin_config (vlib_main_t * vm, unformat_input_t * input)
728 plugin_main_t *pm = &vlib_plugin_main;
729 clib_error_t *error = 0;
732 unformat_init (&in, 0, 0);
734 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
737 if (unformat (input, "%s %v", &s, &v))
739 if (strncmp ((const char *) s, "plugins", 8) == 0)
741 if (vec_len (in.buffer) > 0)
742 vec_add1 (in.buffer, ' ');
743 vec_add (in.buffer, v, vec_len (v));
748 error = clib_error_return (0, "unknown input '%U'",
749 format_unformat_error, input);
758 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
760 unformat_input_t sub_input;
762 if (unformat (input, "path %s", &s))
764 else if (unformat (input, "add-path %s", &s))
765 pm->plugin_path_add = s;
766 else if (unformat (input, "name-filter %s", &s))
767 pm->plugin_name_filter = s;
768 else if (unformat (input, "vat-path %s", &s))
769 pm->vat_plugin_path = s;
770 else if (unformat (input, "vat-name-filter %s", &s))
771 pm->vat_plugin_name_filter = s;
772 else if (unformat (input, "plugin default %U",
773 unformat_vlib_cli_sub_input, &sub_input))
775 pm->plugins_default_disable =
776 unformat (&sub_input, "disable") ? 1 : 0;
777 unformat_free (&sub_input);
779 else if (unformat (input, "plugin %s %U", &s,
780 unformat_vlib_cli_sub_input, &sub_input))
782 error = config_one_plugin (vm, (char *) s, &sub_input);
783 unformat_free (&sub_input);
789 error = clib_error_return (0, "unknown input '%U'",
790 format_unformat_error, input);
803 /* discard whole 'plugins' section, as it is already consumed prior to
805 static clib_error_t *
806 plugins_config (vlib_main_t * vm, unformat_input_t * input)
810 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
812 if (unformat (input, "%s", &junk))
818 return clib_error_return (0, "unknown input '%U'",
819 format_unformat_error, input);
824 VLIB_CONFIG_FUNCTION (plugins_config, "plugins");
827 * fd.io coding-style-patch-verification: ON
830 * eval: (c-set-style "gnu")