vlib: add description field in plugin registration

Change-Id: I88b322a5d602f3d6d3310e971479180a89430e0e
Signed-off-by: Damjan Marion <damarion@cisco.com>

12 files changed, 21 insertions, 6 deletions

diff --git a/src/examples/sample-plugin/sample/sample.c b/src/examples/sample-plugin/sample/sample.c
index 01852746..2f8ac4c9 100644
--- a/src/examples/sample-plugin/sample/sample.c
+++ b/src/examples/sample-plugin/sample/sample.c
@@ -61,6 +61,7 @@ _(SAMPLE_MACSWAP_ENABLE_DISABLE, sample_macswap_enable_disable)
 /* *INDENT-OFF* */
 VLIB_PLUGIN_REGISTER () = {
     .version = SAMPLE_PLUGIN_BUILD_VER,
+    .description = "Sample of VPP Plugin",
 };
 /* *INDENT-ON* */
 
diff --git a/src/plugins/acl/acl.c b/src/plugins/acl/acl.c
index 476fbc33..4a4dd434 100644
--- a/src/plugins/acl/acl.c
+++ b/src/plugins/acl/acl.c
@@ -80,6 +80,7 @@ _(MACIP_ACL_INTERFACE_GET, macip_acl_interface_get)
 /* *INDENT-OFF* */
 VLIB_PLUGIN_REGISTER () = {
     .version = VPP_BUILD_VER,
+    .description = "Access Control Lists",
 };
 /* *INDENT-ON* */
 
diff --git a/src/plugins/dpdk/main.c b/src/plugins/dpdk/main.c
index 8073a50a..7ee2a785 100644
--- a/src/plugins/dpdk/main.c
+++ b/src/plugins/dpdk/main.c
@@ -91,5 +91,6 @@ VLIB_INIT_FUNCTION (dpdk_main_init);
 /* *INDENT-OFF* */
 VLIB_PLUGIN_REGISTER () = {
     .version = VPP_BUILD_VER,
+    .description = "Data Plane Development Kit (DPDK)",
 };
 /* *INDENT-ON* */
diff --git a/src/plugins/flowperpkt/flowperpkt.c b/src/plugins/flowperpkt/flowperpkt.c
index 587972f7..3e5fc8b0 100644
--- a/src/plugins/flowperpkt/flowperpkt.c
+++ b/src/plugins/flowperpkt/flowperpkt.c
@@ -448,6 +448,7 @@ _(FLOWPERPKT_TX_INTERFACE_ADD_DEL, flowperpkt_tx_interface_add_del)
 /* *INDENT-OFF* */
 VLIB_PLUGIN_REGISTER () = {
     .version = VPP_BUILD_VER,
+    .description = "Flow per Packet",
 };
 /* *INDENT-ON* */
 
diff --git a/src/plugins/ila/ila.c b/src/plugins/ila/ila.c
index 52c7ea55..edbf3017 100644
--- a/src/plugins/ila/ila.c
+++ b/src/plugins/ila/ila.c
@@ -825,6 +825,7 @@ ila_interface (u32 sw_if_index, u8 disable)
 /* *INDENT-OFF* */
 VLIB_PLUGIN_REGISTER () = {
     .version = VPP_BUILD_VER,
+    .description = "Identifier-locator addressing for IPv6",
 };
 /* *INDENT-ON* */
 
diff --git a/src/plugins/ioam/encap/ip6_ioam_trace.c b/src/plugins/ioam/encap/ip6_ioam_trace.c
index 57d3ec5d..299ee88f 100644
--- a/src/plugins/ioam/encap/ip6_ioam_trace.c
+++ b/src/plugins/ioam/encap/ip6_ioam_trace.c
@@ -411,6 +411,7 @@ VLIB_CLI_COMMAND (ip6_show_ioam_trace_cmd, static) = {
 /* *INDENT-OFF* */
 VLIB_PLUGIN_REGISTER () = {
     .version = VPP_BUILD_VER,
+    .description = "Inbound OAM",
 };
 /* *INDENT-ON* */
 
diff --git a/src/plugins/ixge/ixge.c b/src/plugins/ixge/ixge.c
index 4eebc457..f3c5cc09 100644
--- a/src/plugins/ixge/ixge.c
+++ b/src/plugins/ixge/ixge.c
@@ -2935,6 +2935,7 @@ ixge_set_next_node (ixge_rx_next_t next, char *name)
 VLIB_PLUGIN_REGISTER () = {
     .version = VPP_BUILD_VER,
     .default_disabled = 1,
+    .description = "Intel 82599 Family Native Driver (experimental)",
 };
 
 /* *INDENT-ON* */
diff --git a/src/plugins/lb/lb.c b/src/plugins/lb/lb.c
index dc3f5be1..add81236 100644
--- a/src/plugins/lb/lb.c
+++ b/src/plugins/lb/lb.c
@@ -734,6 +734,7 @@ int lb_vip_del(u32 vip_index)
 /* *INDENT-OFF* */
 VLIB_PLUGIN_REGISTER () = {
     .version = VPP_BUILD_VER,
+    .description = "Load Balancer",
 };
 /* *INDENT-ON* */
 
diff --git a/src/plugins/sixrd/sixrd.c b/src/plugins/sixrd/sixrd.c
index 67a9a3ad..98387525 100644
--- a/src/plugins/sixrd/sixrd.c
+++ b/src/plugins/sixrd/sixrd.c
@@ -356,8 +356,9 @@ VLIB_CLI_COMMAND(show_sixrd_stats_command, static) = {
 };
 
 /* *INDENT-OFF* */
-VLIB_PLUGIN_REGISTER () = {
+VLIB_PLUGIN_REGISTER () ={
     .version = VPP_BUILD_VER,
+    .description = "IPv6 Rapid Deployment on IPv4 Infrastructure (RFC5969)",
 };
 /* *INDENT-ON* */
 
diff --git a/src/plugins/snat/snat.c b/src/plugins/snat/snat.c
index d42303f6..70b6a6e2 100644
--- a/src/plugins/snat/snat.c
+++ b/src/plugins/snat/snat.c
@@ -107,6 +107,7 @@ VNET_FEATURE_INIT (ip4_snat_out2in_fast, static) = {
 /* *INDENT-OFF* */
 VLIB_PLUGIN_REGISTER () = {
     .version = VPP_BUILD_VER,
+    .description = "Network Address Translation",
 };
 /* *INDENT-ON* */
 
diff --git a/src/vlib/unix/plugin.c b/src/vlib/unix/plugin.c
index e9846e3b..9b341cc8 100644
--- a/src/vlib/unix/plugin.c
+++ b/src/vlib/unix/plugin.c
@@ -105,13 +105,13 @@ load_one_plugin (plugin_main_t * pm, plugin_info_t * pi, int from_early_init)
 	}
       if (reg->default_disabled && pc->is_enabled == 0)
 	{
-	  clib_warning ("Plugin disabled: %s (default)", pi->name);
+	  clib_warning ("Plugin disabled (default): %s", pi->name);
 	  goto error;
 	}
     }
   else if (reg->default_disabled)
     {
-      clib_warning ("Plugin disabled: %s (default)", pi->name);
+      clib_warning ("Plugin disabled (default): %s", pi->name);
       goto error;
     }
 
@@ -184,7 +184,10 @@ load_one_plugin (plugin_main_t * pm, plugin_info_t * pi, int from_early_init)
 		      (char *) pi->name, reg->early_init);
     }
 
-  clib_warning ("Loaded plugin: %s", pi->name);
+  if (reg->description)
+    clib_warning ("Loaded plugin: %s (%s)", pi->name, reg->description);
+  else
+    clib_warning ("Loaded plugin: %s", pi->name);
 
   return 0;
 error:
@@ -374,7 +377,7 @@ vlib_plugins_show_cmd_fn (vlib_main_t * vm,
   plugin_info_t *pi;
 
   s = format (s, " Plugin path is: %s\n\n", pm->plugin_path);
-  s = format (s, "     %-41s%s\n", "Plugin", "Version");
+  s = format (s, "     %-41s%-33s%s\n", "Plugin", "Version", "Description");
 
   /* *INDENT-OFF* */
   hash_foreach_mem (key, value, pm->plugin_by_name_hash,
@@ -382,7 +385,8 @@ vlib_plugins_show_cmd_fn (vlib_main_t * vm,
       if (key != 0)
         {
           pi = vec_elt_at_index (pm->plugin_info, value);
-          s = format (s, "%3d. %-40s %s\n", index, key, pi->version);
+          s = format (s, "%3d. %-40s %-32s %s\n", index, key, pi->version,
+		      pi->reg->description ? pi->reg->description : "");
 	  index++;
         }
     });
diff --git a/src/vlib/unix/plugin.h b/src/vlib/unix/plugin.h
index 01fec356..d9801ec4 100644
--- a/src/vlib/unix/plugin.h
+++ b/src/vlib/unix/plugin.h
@@ -62,6 +62,7 @@ typedef CLIB_PACKED(struct {
   const char version[32];
   const char version_required[32];
   const char *early_init;
+  const char *description;
 }) vlib_plugin_registration_t;
 /* *INDENT-ON* */