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>
22 plugin_main_t vlib_plugin_main;
25 vlib_set_get_handoff_structure_cb (void *cb)
27 plugin_main_t *pm = &vlib_plugin_main;
28 pm->handoff_structure_get_cb = cb;
32 vnet_get_handoff_structure (void)
36 fp = vlib_plugin_main.handoff_structure_get_cb;
44 load_one_plugin (plugin_main_t * pm, plugin_info_t * pi, int from_early_init)
46 void *handle, *register_handle;
47 clib_error_t *(*fp) (vlib_main_t *, void *, int);
49 void *handoff_structure;
51 handle = dlopen ((char *) pi->name, RTLD_LAZY);
54 * Note: this can happen if the plugin has an undefined symbol reference,
55 * so print a warning. Otherwise, the poor slob won't know what happened.
56 * Ask me how I know that...
60 clib_warning ("%s", dlerror ());
67 register_handle = dlsym (pi->handle, "vlib_plugin_register");
68 if (register_handle == 0)
71 clib_warning ("Plugin missing vlib_plugin_register: %s\n",
78 handoff_structure = vnet_get_handoff_structure ();
80 if (handoff_structure == 0)
81 error = clib_error_return (0, "handoff structure callback returned 0");
83 error = (*fp) (pm->vlib_main, handoff_structure, from_early_init);
87 clib_error_report (error);
92 clib_warning ("Loaded plugin: %s", pi->name);
98 split_plugin_path (plugin_main_t * pm)
102 u8 *path = pm->plugin_path;
105 for (i = 0; i < vec_len (pm->plugin_path); i++)
109 vec_add1 (this, path[i]);
125 vlib_load_new_plugins (plugin_main_t * pm, int from_early_init)
128 struct dirent *entry;
135 plugin_path = split_plugin_path (pm);
137 for (i = 0; i < vec_len (plugin_path); i++)
139 dp = opendir ((char *) plugin_path[i]);
144 while ((entry = readdir (dp)))
148 if (pm->plugin_name_filter)
151 for (j = 0; j < vec_len (pm->plugin_name_filter); j++)
152 if (entry->d_name[j] != pm->plugin_name_filter[j])
156 plugin_name = format (0, "%s/%s%c", plugin_path[i],
159 /* Only accept .so */
160 char *ext = strrchr ((const char *) plugin_name, '.');
162 if (!ext || (strcmp (ext, ".so") != 0) ||
163 stat ((char *) plugin_name, &statb) < 0)
166 vec_free (plugin_name);
170 /* a dir or other things which aren't plugins */
171 if (!S_ISREG (statb.st_mode))
174 p = hash_get_mem (pm->plugin_by_name_hash, plugin_name);
177 vec_add2 (pm->plugin_info, pi, 1);
178 pi->name = plugin_name;
179 pi->file_info = statb;
181 if (load_one_plugin (pm, pi, from_early_init))
183 vec_free (plugin_name);
184 _vec_len (pm->plugin_info) = vec_len (pm->plugin_info) - 1;
187 memset (pi, 0, sizeof (*pi));
188 hash_set_mem (pm->plugin_by_name_hash, plugin_name,
189 pi - pm->plugin_info);
195 vec_free (plugin_path[i]);
197 vec_free (plugin_path);
201 char *vlib_plugin_path __attribute__ ((weak));
202 char *vlib_plugin_path = "";
203 char *vlib_plugin_name_filter __attribute__ ((weak));
204 char *vlib_plugin_name_filter = 0;
207 vlib_plugin_early_init (vlib_main_t * vm)
209 plugin_main_t *pm = &vlib_plugin_main;
211 pm->plugin_path = format (0, "%s%c", vlib_plugin_path, 0);
213 clib_warning ("plugin path %s", pm->plugin_path);
215 if (vlib_plugin_name_filter)
216 pm->plugin_name_filter = format (0, "%s%c", vlib_plugin_name_filter, 0);
218 pm->plugin_by_name_hash = hash_create_string (0, sizeof (uword));
221 return vlib_load_new_plugins (pm, 1 /* from_early_init */ );
224 static clib_error_t *
225 vlib_plugins_show_cmd_fn (vlib_main_t * vm,
226 unformat_input_t * input, vlib_cli_command_t * cmd)
228 plugin_main_t *pm = &vlib_plugin_main;
234 s = format (s, " Plugin path is: %s\n", pm->plugin_path);
235 if (vlib_plugin_name_filter)
236 s = format (s, " Plugin filter: %s\n", vlib_plugin_name_filter);
238 s = format (s, " Plugins loaded: \n");
239 hash_foreach_mem (key, value, pm->plugin_by_name_hash,
242 s = format (s, " %d.%s\n", index, key); index++;}
245 vlib_cli_output (vm, "%v", s);
250 VLIB_CLI_COMMAND (plugins_show_cmd, static) =
252 .path = "show plugins",.short_help = "show loaded plugins",.function =
253 vlib_plugins_show_cmd_fn,};
255 * fd.io coding-style-patch-verification: ON
258 * eval: (c-set-style "gnu")