src/vlib/unix/plugin.c

   1 /*
   2  * plugin.c: plugin handling
   3  *
   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:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  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.
  16  */
  17
  18 #include <vlib/unix/plugin.h>
  19 #include <vppinfra/elf.h>
  20 #include <dlfcn.h>
  21 #include <dirent.h>
  22
  23 plugin_main_t vlib_plugin_main;
  24
  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 = "";
  29
  30 void *
  31 vlib_get_plugin_symbol (char *plugin_name, char *symbol_name)
  32 {
  33   plugin_main_t *pm = &vlib_plugin_main;
  34   uword *p;
  35   plugin_info_t *pi;
  36
  37   if ((p = hash_get_mem (pm->plugin_by_name_hash, plugin_name)) == 0)
  38     return 0;
  39
  40   pi = vec_elt_at_index (pm->plugin_info, p[0]);
  41   return dlsym (pi->handle, symbol_name);
  42 }
  43
  44 static char *
  45 str_array_to_vec (char *array, int len)
  46 {
  47   char c, *r = 0;
  48   int n = 0;
  49
  50   do
  51     {
  52       c = array[n];
  53       vec_add1 (r, c);
  54     }
  55   while (c && ++n < len);
  56
  57   if (c)
  58     vec_add1 (r, 0);
  59
  60   return r;
  61 }
  62
  63 static int
  64 load_one_plugin (plugin_main_t * pm, plugin_info_t * pi, int from_early_init)
  65 {
  66   void *handle;
  67   clib_error_t *error;
  68   elf_main_t em = { 0 };
  69   elf_section_t *section;
  70   u8 *data;
  71   char *version_required;
  72   vlib_plugin_registration_t *reg;
  73   plugin_config_t *pc = 0;
  74   uword *p;
  75
  76   if (elf_read_file (&em, (char *) pi->filename))
  77     return -1;
  78
  79   error = elf_get_section_by_name (&em, ".vlib_plugin_registration",
  80                                    &section);
  81   if (error)
  82     {
  83       clib_warning ("Not a plugin: %s\n", (char *) pi->name);
  84       return -1;
  85     }
  86
  87   data = elf_get_section_contents (&em, section->index, 1);
  88   reg = (vlib_plugin_registration_t *) data;
  89
  90   if (vec_len (data) != sizeof (*reg))
  91     {
  92       clib_warning ("vlib_plugin_registration size mismatch in plugin %s\n",
  93                     (char *) pi->name);
  94       goto error;
  95     }
  96
  97   p = hash_get_mem (pm->config_index_by_name, pi->name);
  98   if (p)
  99     {
 100       pc = vec_elt_at_index (pm->configs, p[0]);
 101       if (pc->is_disabled)
 102         {
 103           clib_warning ("Plugin disabled: %s", pi->name);
 104           goto error;
 105         }
 106       if (reg->default_disabled && pc->is_enabled == 0)
 107         {
 108           clib_warning ("Plugin disabled: %s (default)", pi->name);
 109           goto error;
 110         }
 111     }
 112   else if (reg->default_disabled)
 113     {
 114       clib_warning ("Plugin disabled: %s (default)", pi->name);
 115       goto error;
 116     }
 117
 118   version_required = str_array_to_vec ((char *) &reg->version_required,
 119                                        sizeof (reg->version_required));
 120
 121   if ((strlen (version_required) > 0) &&
 122       (strncmp (vlib_plugin_app_version, version_required,
 123                 strlen (version_required))))
 124     {
 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))
 128         {
 129           vec_free (version_required);
 130           goto error;
 131         }
 132     }
 133
 134   vec_free (version_required);
 135   vec_free (data);
 136   elf_main_free (&em);
 137
 138   handle = dlopen ((char *) pi->filename, RTLD_LAZY);
 139
 140   /*
 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...
 144    */
 145   if (handle == 0)
 146     {
 147       clib_warning ("%s", dlerror ());
 148       return -1;
 149     }
 150
 151   pi->handle = handle;
 152
 153   reg = dlsym (pi->handle, "vlib_plugin_registration");
 154
 155   if (reg == 0)
 156     {
 157       /* This should never happen unless somebody chagnes registration macro */
 158       clib_warning ("Missing plugin registration in plugin '%s'", pi->name);
 159       os_exit (1);
 160     }
 161
 162   pi->reg = reg;
 163   pi->version = str_array_to_vec ((char *) &reg->version,
 164                                   sizeof (reg->version));
 165
 166   if (reg && reg->early_init)
 167     {
 168       clib_error_t *(*ei) (vlib_main_t *);
 169       void *h;
 170
 171       h = dlsym (pi->handle, reg->early_init);
 172       if (h)
 173         {
 174           ei = h;
 175           error = (*ei) (pm->vlib_main);
 176           if (error)
 177             {
 178               clib_error_report (error);
 179               os_exit (1);
 180             }
 181         }
 182       else
 183         clib_warning ("Plugin %s: early init function %s set but not found",
 184                       (char *) pi->name, reg->early_init);
 185     }
 186
 187   clib_warning ("Loaded plugin: %s", pi->name);
 188
 189   return 0;
 190 error:
 191   vec_free (data);
 192   elf_main_free (&em);
 193   return -1;
 194 }
 195
 196 static u8 **
 197 split_plugin_path (plugin_main_t * pm)
 198 {
 199   int i;
 200   u8 **rv = 0;
 201   u8 *path = pm->plugin_path;
 202   u8 *this = 0;
 203
 204   for (i = 0; i < vec_len (pm->plugin_path); i++)
 205     {
 206       if (path[i] != ':')
 207         {
 208           vec_add1 (this, path[i]);
 209           continue;
 210         }
 211       vec_add1 (this, 0);
 212       vec_add1 (rv, this);
 213       this = 0;
 214     }
 215   if (this)
 216     {
 217       vec_add1 (this, 0);
 218       vec_add1 (rv, this);
 219     }
 220   return rv;
 221 }
 222
 223 int
 224 vlib_load_new_plugins (plugin_main_t * pm, int from_early_init)
 225 {
 226   DIR *dp;
 227   struct dirent *entry;
 228   struct stat statb;
 229   uword *p;
 230   plugin_info_t *pi;
 231   u8 **plugin_path;
 232   int i;
 233
 234   plugin_path = split_plugin_path (pm);
 235
 236   for (i = 0; i < vec_len (plugin_path); i++)
 237     {
 238       dp = opendir ((char *) plugin_path[i]);
 239
 240       if (dp == 0)
 241         continue;
 242
 243       while ((entry = readdir (dp)))
 244         {
 245           u8 *plugin_name;
 246           u8 *filename;
 247
 248           if (pm->plugin_name_filter)
 249             {
 250               int j;
 251               for (j = 0; j < vec_len (pm->plugin_name_filter); j++)
 252                 if (entry->d_name[j] != pm->plugin_name_filter[j])
 253                   goto next;
 254             }
 255
 256           filename = format (0, "%s/%s%c", plugin_path[i], entry->d_name, 0);
 257
 258           /* Only accept .so */
 259           char *ext = strrchr ((const char *) filename, '.');
 260           /* unreadable */
 261           if (!ext || (strcmp (ext, ".so") != 0) ||
 262               stat ((char *) filename, &statb) < 0)
 263             {
 264             ignore:
 265               vec_free (filename);
 266               continue;
 267             }
 268
 269           /* a dir or other things which aren't plugins */
 270           if (!S_ISREG (statb.st_mode))
 271             goto ignore;
 272
 273           plugin_name = format (0, "%s%c", entry->d_name, 0);
 274           p = hash_get_mem (pm->plugin_by_name_hash, plugin_name);
 275           if (p == 0)
 276             {
 277               vec_add2 (pm->plugin_info, pi, 1);
 278               pi->name = plugin_name;
 279               pi->filename = filename;
 280               pi->file_info = statb;
 281
 282               if (load_one_plugin (pm, pi, from_early_init))
 283                 {
 284                   vec_free (plugin_name);
 285                   vec_free (filename);
 286                   _vec_len (pm->plugin_info) = vec_len (pm->plugin_info) - 1;
 287                   memset (pi, 0, sizeof (*pi));
 288                   continue;
 289                 }
 290               hash_set_mem (pm->plugin_by_name_hash, plugin_name,
 291                             pi - pm->plugin_info);
 292             }
 293         next:
 294           ;
 295         }
 296       closedir (dp);
 297       vec_free (plugin_path[i]);
 298     }
 299   vec_free (plugin_path);
 300   return 0;
 301 }
 302
 303 int
 304 vlib_plugin_early_init (vlib_main_t * vm)
 305 {
 306   plugin_main_t *pm = &vlib_plugin_main;
 307
 308   if (pm->plugin_path == 0)
 309     pm->plugin_path = format (0, "%s%c", vlib_plugin_path, 0);
 310
 311   clib_warning ("plugin path %s", pm->plugin_path);
 312
 313   pm->plugin_by_name_hash = hash_create_string (0, sizeof (uword));
 314   pm->vlib_main = vm;
 315
 316   return vlib_load_new_plugins (pm, 1 /* from_early_init */ );
 317 }
 318
 319 static clib_error_t *
 320 vlib_plugins_show_cmd_fn (vlib_main_t * vm,
 321                           unformat_input_t * input, vlib_cli_command_t * cmd)
 322 {
 323   plugin_main_t *pm = &vlib_plugin_main;
 324   u8 *s = 0;
 325   u8 *key = 0;
 326   uword value = 0;
 327   int index = 1;
 328   plugin_info_t *pi;
 329
 330   s = format (s, " Plugin path is: %s\n\n", pm->plugin_path);
 331   s = format (s, "     %-41s%s\n", "Plugin", "Version");
 332
 333   /* *INDENT-OFF* */
 334   hash_foreach_mem (key, value, pm->plugin_by_name_hash,
 335     {
 336       if (key != 0)
 337         {
 338           pi = vec_elt_at_index (pm->plugin_info, value);
 339           s = format (s, "%3d. %-40s %s\n", index, key, pi->version);
 340           index++;
 341         }
 342     });
 343   /* *INDENT-ON* */
 344
 345   vlib_cli_output (vm, "%v", s);
 346   vec_free (s);
 347   return 0;
 348 }
 349
 350 /* *INDENT-OFF* */
 351 VLIB_CLI_COMMAND (plugins_show_cmd, static) =
 352 {
 353   .path = "show plugins",
 354   .short_help = "show loaded plugins",
 355   .function = vlib_plugins_show_cmd_fn,
 356 };
 357 /* *INDENT-ON* */
 358
 359 static clib_error_t *
 360 config_one_plugin (vlib_main_t * vm, char *name, unformat_input_t * input)
 361 {
 362   plugin_main_t *pm = &vlib_plugin_main;
 363   plugin_config_t *pc;
 364   clib_error_t *error = 0;
 365   uword *p;
 366   int is_enable = 0;
 367   int is_disable = 0;
 368   int skip_version_check = 0;
 369
 370   if (pm->config_index_by_name == 0)
 371     pm->config_index_by_name = hash_create_string (0, sizeof (uword));
 372
 373   p = hash_get_mem (pm->config_index_by_name, name);
 374
 375   if (p)
 376     {
 377       error = clib_error_return (0, "plugin '%s' already configured", name);
 378       goto done;
 379     }
 380
 381   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 382     {
 383       if (unformat (input, "enable"))
 384         is_enable = 1;
 385       else if (unformat (input, "disable"))
 386         is_disable = 1;
 387       else if (unformat (input, "skip-version-check"))
 388         skip_version_check = 1;
 389       else
 390         {
 391           error = clib_error_return (0, "unknown input '%U'",
 392                                      format_unformat_error, input);
 393           goto done;
 394         }
 395     }
 396
 397   if (is_enable && is_disable)
 398     {
 399       error = clib_error_return (0, "please specify either enable or disable"
 400                                  " for plugin '%s'", name);
 401       goto done;
 402     }
 403
 404   vec_add2 (pm->configs, pc, 1);
 405   hash_set_mem (pm->config_index_by_name, name, pc - pm->configs);
 406   pc->is_enabled = is_enable;
 407   pc->is_disabled = is_disable;
 408   pc->skip_version_check = skip_version_check;
 409   pc->name = name;
 410
 411 done:
 412   return error;
 413 }
 414
 415 clib_error_t *
 416 vlib_plugin_config (vlib_main_t * vm, unformat_input_t * input)
 417 {
 418   plugin_main_t *pm = &vlib_plugin_main;
 419   clib_error_t *error = 0;
 420   unformat_input_t in;
 421
 422   unformat_init (&in, 0, 0);
 423
 424   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 425     {
 426       u8 *s, *v;
 427       if (unformat (input, "%s %v", &s, &v))
 428         {
 429           if (strncmp ((const char *) s, "plugins", 8) == 0)
 430             {
 431               if (vec_len (in.buffer) > 0)
 432                 vec_add1 (in.buffer, ' ');
 433               vec_add (in.buffer, v, vec_len (v));
 434             }
 435         }
 436       else
 437         {
 438           error = clib_error_return (0, "unknown input '%U'",
 439                                      format_unformat_error, input);
 440           goto done;
 441         }
 442
 443       vec_free (v);
 444       vec_free (s);
 445     }
 446 done:
 447   input = &in;
 448   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 449     {
 450       unformat_input_t sub_input;
 451       u8 *s = 0;
 452       if (unformat (input, "path %s", &s))
 453         pm->plugin_path = s;
 454       else if (unformat (input, "plugin %s %U", &s,
 455                          unformat_vlib_cli_sub_input, &sub_input))
 456         {
 457           error = config_one_plugin (vm, (char *) s, &sub_input);
 458           unformat_free (&sub_input);
 459           if (error)
 460             goto done2;
 461         }
 462       else
 463         {
 464           error = clib_error_return (0, "unknown input '%U'",
 465                                      format_unformat_error, input);
 466           {
 467             vec_free (s);
 468             goto done2;
 469           }
 470         }
 471     }
 472
 473 done2:
 474   unformat_free (&in);
 475   return error;
 476 }
 477
 478 /* discard whole 'plugins' section, as it is already consumed prior to
 479    plugin load */
 480 static clib_error_t *
 481 plugins_config (vlib_main_t * vm, unformat_input_t * input)
 482 {
 483   u8 *junk;
 484
 485   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 486     {
 487       if (unformat (input, "%s", &junk))
 488         {
 489           vec_free (junk);
 490           return 0;
 491         }
 492       else
 493         return clib_error_return (0, "unknown input '%U'",
 494                                   format_unformat_error, input);
 495     }
 496   return 0;
 497 }
 498
 499 VLIB_CONFIG_FUNCTION (plugins_config, "plugins");
 500
 501 /*
 502  * fd.io coding-style-patch-verification: ON
 503  *
 504  * Local Variables:
 505  * eval: (c-set-style "gnu")
 506  * End:
 507  */