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 (default): %s", pi->name);
 109           goto error;
 110         }
 111     }
 112   else if (reg->default_disabled)
 113     {
 114       clib_warning ("Plugin disabled (default): %s", 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   if (handle == 0)
 141     {
 142       clib_warning ("%s", dlerror ());
 143       clib_warning ("Failed to load plugin '%s'", pi->name);
 144       goto error;
 145     }
 146
 147   pi->handle = handle;
 148
 149   reg = dlsym (pi->handle, "vlib_plugin_registration");
 150
 151   if (reg == 0)
 152     {
 153       /* This should never happen unless somebody chagnes registration macro */
 154       clib_warning ("Missing plugin registration in plugin '%s'", pi->name);
 155       os_exit (1);
 156     }
 157
 158   pi->reg = reg;
 159   pi->version = str_array_to_vec ((char *) &reg->version,
 160                                   sizeof (reg->version));
 161
 162   if (reg->early_init)
 163     {
 164       clib_error_t *(*ei) (vlib_main_t *);
 165       void *h;
 166
 167       h = dlsym (pi->handle, reg->early_init);
 168       if (h)
 169         {
 170           ei = h;
 171           error = (*ei) (pm->vlib_main);
 172           if (error)
 173             {
 174               clib_error_report (error);
 175               os_exit (1);
 176             }
 177         }
 178       else
 179         clib_warning ("Plugin %s: early init function %s set but not found",
 180                       (char *) pi->name, reg->early_init);
 181     }
 182
 183   if (reg->description)
 184     clib_warning ("Loaded plugin: %s (%s)", pi->name, reg->description);
 185   else
 186     clib_warning ("Loaded plugin: %s", pi->name);
 187
 188   return 0;
 189 error:
 190   vec_free (data);
 191   elf_main_free (&em);
 192   return -1;
 193 }
 194
 195 static u8 **
 196 split_plugin_path (plugin_main_t * pm)
 197 {
 198   int i;
 199   u8 **rv = 0;
 200   u8 *path = pm->plugin_path;
 201   u8 *this = 0;
 202
 203   for (i = 0; i < vec_len (pm->plugin_path); i++)
 204     {
 205       if (path[i] != ':')
 206         {
 207           vec_add1 (this, path[i]);
 208           continue;
 209         }
 210       vec_add1 (this, 0);
 211       vec_add1 (rv, this);
 212       this = 0;
 213     }
 214   if (this)
 215     {
 216       vec_add1 (this, 0);
 217       vec_add1 (rv, this);
 218     }
 219   return rv;
 220 }
 221
 222 static int
 223 plugin_name_sort_cmp (void *a1, void *a2)
 224 {
 225   plugin_info_t *p1 = a1;
 226   plugin_info_t *p2 = a2;
 227
 228   return strcmp ((char *) p1->name, (char *) p2->name);
 229 }
 230
 231 int
 232 vlib_load_new_plugins (plugin_main_t * pm, int from_early_init)
 233 {
 234   DIR *dp;
 235   struct dirent *entry;
 236   struct stat statb;
 237   uword *p;
 238   plugin_info_t *pi;
 239   u8 **plugin_path;
 240   u32 *load_fail_indices = 0;
 241   int i;
 242
 243   plugin_path = split_plugin_path (pm);
 244
 245   for (i = 0; i < vec_len (plugin_path); i++)
 246     {
 247       dp = opendir ((char *) plugin_path[i]);
 248
 249       if (dp == 0)
 250         continue;
 251
 252       while ((entry = readdir (dp)))
 253         {
 254           u8 *plugin_name;
 255           u8 *filename;
 256
 257           if (pm->plugin_name_filter)
 258             {
 259               int j;
 260               for (j = 0; j < vec_len (pm->plugin_name_filter); j++)
 261                 if (entry->d_name[j] != pm->plugin_name_filter[j])
 262                   goto next;
 263             }
 264
 265           filename = format (0, "%s/%s%c", plugin_path[i], entry->d_name, 0);
 266
 267           /* Only accept .so */
 268           char *ext = strrchr ((const char *) filename, '.');
 269           /* unreadable */
 270           if (!ext || (strcmp (ext, ".so") != 0) ||
 271               stat ((char *) filename, &statb) < 0)
 272             {
 273             ignore:
 274               vec_free (filename);
 275               continue;
 276             }
 277
 278           /* a dir or other things which aren't plugins */
 279           if (!S_ISREG (statb.st_mode))
 280             goto ignore;
 281
 282           plugin_name = format (0, "%s%c", entry->d_name, 0);
 283           /* Have we seen this plugin already? */
 284           p = hash_get_mem (pm->plugin_by_name_hash, plugin_name);
 285           if (p == 0)
 286             {
 287               /* No, add it to the plugin vector */
 288               vec_add2 (pm->plugin_info, pi, 1);
 289               pi->name = plugin_name;
 290               pi->filename = filename;
 291               pi->file_info = statb;
 292               hash_set_mem (pm->plugin_by_name_hash, plugin_name,
 293                             pi - pm->plugin_info);
 294             }
 295         next:
 296           ;
 297         }
 298       closedir (dp);
 299       vec_free (plugin_path[i]);
 300     }
 301   vec_free (plugin_path);
 302
 303
 304   /*
 305    * Sort the plugins by name. This is important.
 306    * API traces contain absolute message numbers.
 307    * Loading plugins in directory (vs. alphabetical) order
 308    * makes trace replay incredibly fragile.
 309    */
 310   vec_sort_with_function (pm->plugin_info, plugin_name_sort_cmp);
 311
 312   /*
 313    * Attempt to load the plugins
 314    */
 315   for (i = 0; i < vec_len (pm->plugin_info); i++)
 316     {
 317       pi = vec_elt_at_index (pm->plugin_info, i);
 318
 319       if (load_one_plugin (pm, pi, from_early_init))
 320         {
 321           /* Make a note of any which fail to load */
 322           vec_add1 (load_fail_indices, i);
 323           hash_unset_mem (pm->plugin_by_name_hash, pi->name);
 324           vec_free (pi->name);
 325           vec_free (pi->filename);
 326         }
 327     }
 328
 329   /* Remove plugin info vector elements corresponding to load failures */
 330   if (vec_len (load_fail_indices) > 0)
 331     {
 332       for (i = vec_len (load_fail_indices) - 1; i >= 0; i--)
 333         vec_delete (pm->plugin_info, 1, load_fail_indices[i]);
 334       vec_free (load_fail_indices);
 335     }
 336
 337   /* Recreate the plugin name hash */
 338   for (i = 0; i < vec_len (pm->plugin_info); i++)
 339     {
 340       pi = vec_elt_at_index (pm->plugin_info, i);
 341       hash_unset_mem (pm->plugin_by_name_hash, pi->name);
 342       hash_set_mem (pm->plugin_by_name_hash, pi->name, pi - pm->plugin_info);
 343     }
 344
 345   return 0;
 346 }
 347
 348 int
 349 vlib_plugin_early_init (vlib_main_t * vm)
 350 {
 351   plugin_main_t *pm = &vlib_plugin_main;
 352
 353   if (pm->plugin_path == 0)
 354     pm->plugin_path = format (0, "%s%c", vlib_plugin_path, 0);
 355
 356   clib_warning ("plugin path %s", pm->plugin_path);
 357
 358   pm->plugin_by_name_hash = hash_create_string (0, sizeof (uword));
 359   pm->vlib_main = vm;
 360
 361   return vlib_load_new_plugins (pm, 1 /* from_early_init */ );
 362 }
 363
 364 u8 *
 365 vlib_get_vat_plugin_path (void)
 366 {
 367   plugin_main_t *pm = &vlib_plugin_main;
 368   return (pm->vat_plugin_path);
 369 }
 370
 371 u8 *
 372 vlib_get_vat_plugin_name_filter (void)
 373 {
 374   plugin_main_t *pm = &vlib_plugin_main;
 375   return (pm->vat_plugin_name_filter);
 376 }
 377
 378 static clib_error_t *
 379 vlib_plugins_show_cmd_fn (vlib_main_t * vm,
 380                           unformat_input_t * input, vlib_cli_command_t * cmd)
 381 {
 382   plugin_main_t *pm = &vlib_plugin_main;
 383   u8 *s = 0;
 384   u8 *key = 0;
 385   uword value = 0;
 386   int index = 1;
 387   plugin_info_t *pi;
 388
 389   s = format (s, " Plugin path is: %s\n\n", pm->plugin_path);
 390   s = format (s, "     %-41s%-33s%s\n", "Plugin", "Version", "Description");
 391
 392   /* *INDENT-OFF* */
 393   hash_foreach_mem (key, value, pm->plugin_by_name_hash,
 394     {
 395       if (key != 0)
 396         {
 397           pi = vec_elt_at_index (pm->plugin_info, value);
 398           s = format (s, "%3d. %-40s %-32s %s\n", index, key, pi->version,
 399                       pi->reg->description ? pi->reg->description : "");
 400           index++;
 401         }
 402     });
 403   /* *INDENT-ON* */
 404
 405   vlib_cli_output (vm, "%v", s);
 406   vec_free (s);
 407   return 0;
 408 }
 409
 410 /* *INDENT-OFF* */
 411 VLIB_CLI_COMMAND (plugins_show_cmd, static) =
 412 {
 413   .path = "show plugins",
 414   .short_help = "show loaded plugins",
 415   .function = vlib_plugins_show_cmd_fn,
 416 };
 417 /* *INDENT-ON* */
 418
 419 static clib_error_t *
 420 config_one_plugin (vlib_main_t * vm, char *name, unformat_input_t * input)
 421 {
 422   plugin_main_t *pm = &vlib_plugin_main;
 423   plugin_config_t *pc;
 424   clib_error_t *error = 0;
 425   uword *p;
 426   int is_enable = 0;
 427   int is_disable = 0;
 428   int skip_version_check = 0;
 429
 430   if (pm->config_index_by_name == 0)
 431     pm->config_index_by_name = hash_create_string (0, sizeof (uword));
 432
 433   p = hash_get_mem (pm->config_index_by_name, name);
 434
 435   if (p)
 436     {
 437       error = clib_error_return (0, "plugin '%s' already configured", name);
 438       goto done;
 439     }
 440
 441   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 442     {
 443       if (unformat (input, "enable"))
 444         is_enable = 1;
 445       else if (unformat (input, "disable"))
 446         is_disable = 1;
 447       else if (unformat (input, "skip-version-check"))
 448         skip_version_check = 1;
 449       else
 450         {
 451           error = clib_error_return (0, "unknown input '%U'",
 452                                      format_unformat_error, input);
 453           goto done;
 454         }
 455     }
 456
 457   if (is_enable && is_disable)
 458     {
 459       error = clib_error_return (0, "please specify either enable or disable"
 460                                  " for plugin '%s'", name);
 461       goto done;
 462     }
 463
 464   vec_add2 (pm->configs, pc, 1);
 465   hash_set_mem (pm->config_index_by_name, name, pc - pm->configs);
 466   pc->is_enabled = is_enable;
 467   pc->is_disabled = is_disable;
 468   pc->skip_version_check = skip_version_check;
 469   pc->name = name;
 470
 471 done:
 472   return error;
 473 }
 474
 475 clib_error_t *
 476 vlib_plugin_config (vlib_main_t * vm, unformat_input_t * input)
 477 {
 478   plugin_main_t *pm = &vlib_plugin_main;
 479   clib_error_t *error = 0;
 480   unformat_input_t in;
 481
 482   unformat_init (&in, 0, 0);
 483
 484   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 485     {
 486       u8 *s, *v;
 487       if (unformat (input, "%s %v", &s, &v))
 488         {
 489           if (strncmp ((const char *) s, "plugins", 8) == 0)
 490             {
 491               if (vec_len (in.buffer) > 0)
 492                 vec_add1 (in.buffer, ' ');
 493               vec_add (in.buffer, v, vec_len (v));
 494             }
 495         }
 496       else
 497         {
 498           error = clib_error_return (0, "unknown input '%U'",
 499                                      format_unformat_error, input);
 500           goto done;
 501         }
 502
 503       vec_free (v);
 504       vec_free (s);
 505     }
 506 done:
 507   input = &in;
 508   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 509     {
 510       unformat_input_t sub_input;
 511       u8 *s = 0;
 512       if (unformat (input, "path %s", &s))
 513         pm->plugin_path = s;
 514       else if (unformat (input, "name-filter %s", &s))
 515         pm->plugin_name_filter = s;
 516       else if (unformat (input, "vat-path %s", &s))
 517         pm->vat_plugin_path = s;
 518       else if (unformat (input, "vat-name-filter %s", &s))
 519         pm->vat_plugin_name_filter = s;
 520       else if (unformat (input, "plugin %s %U", &s,
 521                          unformat_vlib_cli_sub_input, &sub_input))
 522         {
 523           error = config_one_plugin (vm, (char *) s, &sub_input);
 524           unformat_free (&sub_input);
 525           if (error)
 526             goto done2;
 527         }
 528       else
 529         {
 530           error = clib_error_return (0, "unknown input '%U'",
 531                                      format_unformat_error, input);
 532           {
 533             vec_free (s);
 534             goto done2;
 535           }
 536         }
 537     }
 538
 539 done2:
 540   unformat_free (&in);
 541   return error;
 542 }
 543
 544 /* discard whole 'plugins' section, as it is already consumed prior to
 545    plugin load */
 546 static clib_error_t *
 547 plugins_config (vlib_main_t * vm, unformat_input_t * input)
 548 {
 549   u8 *junk;
 550
 551   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 552     {
 553       if (unformat (input, "%s", &junk))
 554         {
 555           vec_free (junk);
 556           return 0;
 557         }
 558       else
 559         return clib_error_return (0, "unknown input '%U'",
 560                                   format_unformat_error, input);
 561     }
 562   return 0;
 563 }
 564
 565 VLIB_CONFIG_FUNCTION (plugins_config, "plugins");
 566
 567 /*
 568  * fd.io coding-style-patch-verification: ON
 569  *
 570  * Local Variables:
 571  * eval: (c-set-style "gnu")
 572  * End:
 573  */