binary-api debug CLI works with plugins

Change-Id: I81f33f5153d5afac94b66b5a8cb91da77463af79
Signed-off-by: Dave Barach <dave@barachs.net>

3 files changed, 301 insertions, 0 deletions

diff --git a/src/vpp/api/api_main.c b/src/vpp/api/api_main.c
index fd6998f4..7bf7e8b7 100644
--- a/src/vpp/api/api_main.c
+++ b/src/vpp/api/api_main.c
@@ -42,11 +42,17 @@ static clib_error_t *
 api_main_init (vlib_main_t * vm)
 {
   vat_main_t *vam = &vat_main;
+  int rv;
+  int vat_plugin_init (vat_main_t * vam);
 
   vam->vlib_main = vm;
   vam->my_client_index = (u32) ~ 0;
   init_error_string_table (vam);
   vat_api_hookup (vam);
+  clib_warning ("vam %llx", vam);
+  rv = vat_plugin_init (vam);
+  if (rv)
+    clib_warning ("vat_plugin_init returned %d", rv);
   return 0;
 }
 
@@ -183,6 +189,39 @@ api_cli_output (void *notused, const char *fmt, ...)
   vec_free (s);
 }
 
+u16
+vl_client_get_first_plugin_msg_id (char *plugin_name)
+{
+  api_main_t *am = &api_main;
+  vl_api_msg_range_t *rp;
+  uword *p;
+
+  p = hash_get_mem (am->msg_range_by_name, plugin_name);
+  if (p == 0)
+    return ~0;
+
+  rp = vec_elt_at_index (am->msg_ranges, p[0]);
+
+  return (rp->first_msg_id);
+}
+
+uword
+unformat_sw_if_index (unformat_input_t * input, va_list * args)
+{
+  u32 *result = va_arg (*args, u32 *);
+  vnet_main_t *vnm = vnet_get_main ();
+  u32 sw_if_index = ~0;
+  u8 *if_name;
+  uword *p;
+
+  if (unformat (input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
+    {
+      *result = sw_if_index;
+      return 1;
+    }
+  return 0;
+}
+
 /*
  * fd.io coding-style-patch-verification: ON
  *
diff --git a/src/vpp/api/plugin.c b/src/vpp/api/plugin.c
new file mode 100644
index 00000000..c1cc928c
--- /dev/null
+++ b/src/vpp/api/plugin.c
@@ -0,0 +1,201 @@
+/*
+ * Copyright (c) 2015 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/*
+ * plugin.c: plugin handling
+ */
+
+#include <vat/vat.h>
+#include <vat/plugin.h>
+#include <dlfcn.h>
+#include <dirent.h>
+
+plugin_main_t vat_plugin_main;
+
+static int
+load_one_plugin (plugin_main_t * pm, plugin_info_t * pi)
+{
+  void *handle, *register_handle;
+  clib_error_t *(*fp) (vat_main_t *);
+  clib_error_t *error;
+
+  handle = dlopen ((char *) pi->name, RTLD_LAZY);
+
+  /*
+   * Note: this can happen if the plugin has an undefined symbol reference,
+   * so print a warning. Otherwise, the poor slob won't know what happened.
+   * Ask me how I know that...
+   */
+  if (handle == 0)
+    {
+      clib_warning ("%s", dlerror ());
+      return -1;
+    }
+
+  pi->handle = handle;
+
+  register_handle = dlsym (pi->handle, "vat_plugin_register");
+  if (register_handle == 0)
+    return 0;
+
+  fp = register_handle;
+
+  error = (*fp) (pm->vat_main);
+
+  if (error)
+    {
+      clib_error_report (error);
+      dlclose (handle);
+      return 1;
+    }
+
+  clib_warning ("Loaded plugin: %s", pi->name);
+
+  return 0;
+}
+
+static u8 **
+split_plugin_path (plugin_main_t * pm)
+{
+  int i;
+  u8 **rv = 0;
+  u8 *path = pm->plugin_path;
+  u8 *this = 0;
+
+  for (i = 0; i < vec_len (pm->plugin_path); i++)
+    {
+      if (path[i] != ':')
+	{
+	  vec_add1 (this, path[i]);
+	  continue;
+	}
+      vec_add1 (this, 0);
+      vec_add1 (rv, this);
+      this = 0;
+    }
+  if (this)
+    {
+      vec_add1 (this, 0);
+      vec_add1 (rv, this);
+    }
+  return rv;
+}
+
+int
+vat_load_new_plugins (plugin_main_t * pm)
+{
+  DIR *dp;
+  struct dirent *entry;
+  struct stat statb;
+  uword *p;
+  plugin_info_t *pi;
+  u8 **plugin_path;
+  int i;
+
+  plugin_path = split_plugin_path (pm);
+
+  for (i = 0; i < vec_len (plugin_path); i++)
+    {
+      dp = opendir ((char *) plugin_path[i]);
+
+      if (dp == 0)
+	continue;
+
+      while ((entry = readdir (dp)))
+	{
+	  u8 *plugin_name;
+
+	  if (pm->plugin_name_filter)
+	    {
+	      int j;
+	      for (j = 0; j < vec_len (pm->plugin_name_filter); j++)
+		if (entry->d_name[j] != pm->plugin_name_filter[j])
+		  goto next;
+	    }
+
+	  plugin_name = format (0, "%s/%s%c", plugin_path[i],
+				entry->d_name, 0);
+
+	  /* unreadable */
+	  if (stat ((char *) plugin_name, &statb) < 0)
+	    {
+	    ignore:
+	      vec_free (plugin_name);
+	      continue;
+	    }
+
+	  /* a dir or other things which aren't plugins */
+	  if (!S_ISREG (statb.st_mode))
+	    goto ignore;
+
+	  p = hash_get_mem (pm->plugin_by_name_hash, plugin_name);
+	  if (p == 0)
+	    {
+	      vec_add2 (pm->plugin_info, pi, 1);
+	      pi->name = plugin_name;
+	      pi->file_info = statb;
+
+	      if (load_one_plugin (pm, pi))
+		{
+		  vec_free (plugin_name);
+		  _vec_len (pm->plugin_info) = vec_len (pm->plugin_info) - 1;
+		  continue;
+		}
+	      memset (pi, 0, sizeof (*pi));
+	      hash_set_mem (pm->plugin_by_name_hash, plugin_name,
+			    pi - pm->plugin_info);
+	    }
+	next:
+	  ;
+	}
+      closedir (dp);
+      vec_free (plugin_path[i]);
+    }
+  vec_free (plugin_path);
+  return 0;
+}
+
+#define QUOTE_(x) #x
+#define QUOTE(x) QUOTE_(x)
+
+/*
+ * Load plugins from /usr/lib/vpp_api_test_plugins by default
+ */
+char *vat_plugin_path = "/usr/lib/vpp_api_test_plugins";
+
+char *vat_plugin_name_filter = 0;
+
+int
+vat_plugin_init (vat_main_t * vam)
+{
+  plugin_main_t *pm = &vat_plugin_main;
+
+
+  pm->plugin_path = format (0, "%s%c", vat_plugin_path, 0);
+  if (vat_plugin_name_filter)
+    pm->plugin_name_filter = format (0, "%s%c", vat_plugin_name_filter, 0);
+
+  pm->plugin_by_name_hash = hash_create_string (0, sizeof (uword));
+  pm->vat_main = vam;
+
+  return vat_load_new_plugins (pm);
+}
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */
diff --git a/src/vpp/api/plugin.h b/src/vpp/api/plugin.h
new file mode 100644
index 00000000..559ec52f
--- /dev/null
+++ b/src/vpp/api/plugin.h
@@ -0,0 +1,61 @@
+/*
+ * Copyright (c) 2015 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/*
+ * plugin.h: plugin handling
+ */
+
+#ifndef __included_plugin_h__
+#define __included_plugin_h__
+
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <unistd.h>
+
+typedef struct
+{
+  u8 *name;
+  struct stat file_info;
+  void *handle;
+} plugin_info_t;
+
+typedef struct
+{
+  /* loaded plugin info */
+  plugin_info_t *plugin_info;
+  uword *plugin_by_name_hash;
+
+  /* path and name filter */
+  u8 *plugin_path;
+  u8 *plugin_name_filter;
+
+  /* convenience */
+  vat_main_t *vat_main;
+
+} plugin_main_t;
+
+plugin_main_t vat_plugin_main;
+
+int vat_plugin_init (vat_main_t * vam);
+int vat_load_new_plugins (plugin_main_t * pm);
+
+#endif
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */