X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvlib%2Funix%2Fplugin.h;h=ae15e5db973bf75691923e78c21a8659d40fe517;hb=06111a837d77323d253ecfd26557775fa0b03ca8;hp=f35c9c5de1ed9e3c04450a115a93ad54698c0c6e;hpb=0eca04d84e39ca16c60bea91d77a1c458300c16c;p=vpp.git diff --git a/src/vlib/unix/plugin.h b/src/vlib/unix/plugin.h index f35c9c5de1e..ae15e5db973 100644 --- a/src/vlib/unix/plugin.h +++ b/src/vlib/unix/plugin.h @@ -56,27 +56,84 @@ * vlib_load_new_plugins(). */ +/* *INDENT-OFF* */ +typedef CLIB_PACKED(struct { + u8 default_disabled; + const char version[32]; + const char version_required[32]; + const char overrides[256]; + const char *early_init; + const char *description; +}) vlib_plugin_registration_t; +/* *INDENT-ON* */ +/* + * Plugins may also use this registration format, which is + * easy enough to emit from e.g. a golang compiler. + */ +typedef struct +{ + uword data_segment_offset; + uword length; +} vlib_r2_string_t; + +typedef struct +{ + int default_disabled; + vlib_r2_string_t version; + vlib_r2_string_t version_required; + vlib_r2_string_t overrides; + vlib_r2_string_t early_init; + vlib_r2_string_t description; +} vlib_plugin_r2_t; + +#define foreach_r2_string_field \ +_(version) \ +_(version_required) \ +_(overrides) \ +_(early_init) \ +_(description) typedef struct { u8 *name; + u8 *filename; struct stat file_info; void *handle; + + /* plugin registration */ + vlib_plugin_registration_t *reg; + char *version; } plugin_info_t; +typedef struct +{ + char *name; + u8 is_disabled; + u8 is_enabled; + u8 skip_version_check; +} plugin_config_t; + typedef struct { /* loaded plugin info */ plugin_info_t *plugin_info; uword *plugin_by_name_hash; + uword *plugin_overrides_by_name_hash; - /* path and name filter */ + /* paths and name filters */ u8 *plugin_path; u8 *plugin_name_filter; + u8 *vat_plugin_path; + u8 *vat_plugin_name_filter; + u8 plugins_default_disable; - /* handoff structure get callback */ - void *handoff_structure_get_cb; + /* plugin configs and hash by name */ + plugin_config_t *configs; + uword *config_index_by_name; + + /* Plugin log, avoid filling syslog w/ junk */ + vlib_log_class_t logger; /* usual */ vlib_main_t *vlib_main; @@ -84,8 +141,42 @@ typedef struct extern plugin_main_t vlib_plugin_main; +clib_error_t *vlib_plugin_config (vlib_main_t * vm, unformat_input_t * input); int vlib_plugin_early_init (vlib_main_t * vm); int vlib_load_new_plugins (plugin_main_t * pm, int from_early_init); +void *vlib_get_plugin_symbol (char *plugin_name, char *symbol_name); +u8 *vlib_get_vat_plugin_path (void); + +#define VLIB_PLUGIN_REGISTER() \ + vlib_plugin_registration_t vlib_plugin_registration \ + CLIB_NOSANITIZE_PLUGIN_REG_SECTION \ + __clib_export __clib_section(".vlib_plugin_registration") + +/* Call a plugin init function: used for init function dependencies. */ +#define vlib_call_plugin_init_function(vm,p,x) \ +({ \ + clib_error_t *(*_f)(vlib_main_t *); \ + uword *_fptr = 0; \ + clib_error_t * _error = 0; \ + _fptr= vlib_get_plugin_symbol \ + (p, CLIB_STRING_MACRO(_vlib_init_function_##x)); \ + if (_fptr == 0) \ + { \ + _error = clib_error_return \ + (0, "Plugin %s and/or symbol %s not found.", \ + p, CLIB_STRING_MACRO(_vlib_init_function_##x)); \ + } \ + else \ + { \ + _f = (void *)(_fptr[0]); \ + } \ + if (_fptr && ! hash_get (vm->init_functions_called, _f)) \ + { \ + hash_set1 (vm->init_functions_called, _f); \ + _error = _f (vm); \ + } \ + _error; \ + }) #endif /* __included_plugin_h__ */