src/vlib/unix/plugin.h

   1 /*
   2  * plugin.h: 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 #ifndef __included_plugin_h__
  19 #define __included_plugin_h__
  20
  21 #include <vlib/vlib.h>
  22 #include <vlib/unix/unix.h>
  23 #include <sys/types.h>
  24 #include <sys/stat.h>
  25 #include <unistd.h>
  26
  27 /*
  28  * vlib plugin scheme
  29  *
  30  * Almost anything which can be made to work in a vlib unix
  31  * application will also work in a vlib plugin.
  32  *
  33  * The elf-section magic which registers static objects
  34  * works so long as plugins are preset when the vlib unix process
  35  * starts. But wait: there's more...
  36  *
  37  * If an application calls vlib_load_new_plugins() -- possibly after
  38  * changing vlib_plugin_main.plugin_path / vlib_plugin_main.plugin_name_filter,
  39  * -- new plugins will be loaded. That, in turn, allows considerable
  40  * flexibility in terms of adding feature code or fixing bugs without
  41  * requiring the data-plane process to restart.
  42  *
  43  * When the plugin mechanism loads a plugin, it uses dlsym to locate
  44  * and call the plugin's function vlib_plugin_register() if it exists.
  45  * A plugin which expects to be loaded after the vlib application
  46  * starts uses this callback to modify the application. If vlib_plugin_register
  47  * returns non-zero, the plugin mechanism dlclose()'s the plugin.
  48  *
  49  * Applications control the plugin search path and name filter by
  50  * declaring the variables vlib_plugin_path and vlib_plugin_name_filter.
  51  * libvlib.la supplies weak references for these symbols which
  52  * effectively disable the scheme. In order for the elf-section magic to
  53  * work, static plugins must be loaded at the earliest possible moment.
  54  *
  55  * An application can change these parameters at any time and call
  56  * vlib_load_new_plugins().
  57  */
  58
  59 /* *INDENT-OFF* */
  60 typedef CLIB_PACKED(struct {
  61   u8 default_disabled;
  62   const char version[32];
  63   const char version_required[32];
  64   const char overrides[256];
  65   const char *early_init;
  66   const char *description;
  67 }) vlib_plugin_registration_t;
  68 /* *INDENT-ON* */
  69
  70 typedef struct
  71 {
  72   u8 *name;
  73   u8 *filename;
  74   struct stat file_info;
  75   void *handle;
  76
  77   /* plugin registration */
  78   vlib_plugin_registration_t *reg;
  79   char *version;
  80 } plugin_info_t;
  81
  82 typedef struct
  83 {
  84   char *name;
  85   u8 is_disabled;
  86   u8 is_enabled;
  87   u8 skip_version_check;
  88 } plugin_config_t;
  89
  90 typedef struct
  91 {
  92   /* loaded plugin info */
  93   plugin_info_t *plugin_info;
  94   uword *plugin_by_name_hash;
  95   uword *plugin_overrides_by_name_hash;
  96
  97   /* paths and name filters */
  98   u8 *plugin_path;
  99   u8 *plugin_name_filter;
 100   u8 *vat_plugin_path;
 101   u8 *vat_plugin_name_filter;
 102   u8 plugins_default_disable;
 103
 104   /* plugin configs and hash by name */
 105   plugin_config_t *configs;
 106   uword *config_index_by_name;
 107
 108   /* Plugin log, avoid filling syslog w/ junk */
 109   vlib_log_class_t logger;
 110
 111   /* usual */
 112   vlib_main_t *vlib_main;
 113 } plugin_main_t;
 114
 115 extern plugin_main_t vlib_plugin_main;
 116
 117 clib_error_t *vlib_plugin_config (vlib_main_t * vm, unformat_input_t * input);
 118 int vlib_plugin_early_init (vlib_main_t * vm);
 119 int vlib_load_new_plugins (plugin_main_t * pm, int from_early_init);
 120 void *vlib_get_plugin_symbol (char *plugin_name, char *symbol_name);
 121 u8 *vlib_get_vat_plugin_path (void);
 122
 123 #define VLIB_PLUGIN_REGISTER() \
 124   vlib_plugin_registration_t vlib_plugin_registration \
 125   CLIB_NOSANITIZE_PLUGIN_REG_SECTION \
 126   __attribute__((__section__(".vlib_plugin_registration")))
 127
 128 /* Call a plugin init function: used for init function dependencies. */
 129 #define vlib_call_plugin_init_function(vm,p,x)                  \
 130 ({                                                              \
 131   clib_error_t *(*_f)(vlib_main_t *);                           \
 132   uword *_fptr = 0;                                             \
 133   clib_error_t * _error = 0;                                    \
 134   _fptr= vlib_get_plugin_symbol                                 \
 135     (p, CLIB_STRING_MACRO(_vlib_init_function_##x));            \
 136   if (_fptr == 0)                                               \
 137     {                                                           \
 138       _error = clib_error_return                                \
 139         (0, "Plugin %s and/or symbol %s not found.",            \
 140          p, CLIB_STRING_MACRO(_vlib_init_function_##x));        \
 141     }                                                           \
 142   else                                                          \
 143     {                                                           \
 144       _f = (void *)(_fptr[0]);                                  \
 145     }                                                           \
 146   if (_fptr && ! hash_get (vm->init_functions_called, _f))      \
 147     {                                                           \
 148       hash_set1 (vm->init_functions_called, _f);                \
 149       _error = _f (vm);                                         \
 150     }                                                           \
 151   _error;                                                       \
 152  })
 153
 154 #endif /* __included_plugin_h__ */
 155
 156 /*
 157  * fd.io coding-style-patch-verification: ON
 158  *
 159  * Local Variables:
 160  * eval: (c-set-style "gnu")
 161  * End:
 162  */