vlib: add plugin override support

[vpp.git] / src / vlib / unix / plugin.h

diff --git a/src/vlib/unix/plugin.h b/src/vlib/unix/plugin.h
index f35c9c5..30039c5 100644 (file)
--- a/src/vlib/unix/plugin.h
+++ b/src/vlib/unix/plugin.h
@@ -56,27 +56,57 @@
  * 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* */
 
 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;
+
+  /* plugin configs and hash by name */
+  plugin_config_t *configs;
+  uword *config_index_by_name;
 
-  /* handoff structure get callback */
-  void *handoff_structure_get_cb;
+  /* Plugin log, avoid filling syslog w/ junk */
+  vlib_log_class_t logger;
 
   /* usual */
   vlib_main_t *vlib_main;
@@ -84,8 +114,41 @@ 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 \
+  __attribute__((__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__ */