PAPI: Use UNIX domain sockets instead of shared memory

Adds support for running the API purely across Unix domain sockets.
Usage: vpp = VPP(use_socket=True)

Change-Id: Iafc1301e03dd3edc3f4d702dd6c0b98d3b50b69e
Signed-off-by: Ole Troan <ot@cisco.com>

5 files changed, 94 insertions, 39 deletions

diff --git a/src/vlibmemory/api.h b/src/vlibmemory/api.h
index 2146b16c5b0..d66c4398764 100644
--- a/src/vlibmemory/api.h
+++ b/src/vlibmemory/api.h
@@ -55,10 +55,11 @@ vl_api_can_send_msg (vl_api_registration_t * rp)
 always_inline vl_api_registration_t *
 vl_api_client_index_to_registration (u32 index)
 {
-  if (PREDICT_FALSE (socket_main.current_rp != 0))
-    return socket_main.current_rp;
-
-  return (vl_mem_api_client_index_to_registration (index));
+  vl_api_registration_t *reg =
+    vl_socket_api_client_index_to_registration (index);
+  if (reg && reg->registration_type != REGISTRATION_TYPE_FREE)
+    return reg;
+  return vl_mem_api_client_index_to_registration (index);
 }
 
 always_inline u32
diff --git a/src/vlibmemory/memclnt.api b/src/vlibmemory/memclnt.api
index f88e5bdb7ca..451bc0e5fae 100644
--- a/src/vlibmemory/memclnt.api
+++ b/src/vlibmemory/memclnt.api
@@ -17,7 +17,7 @@
 option version = "2.0.0";
 
 /*
- * Define services not following the normal convetions here
+ * Define services not following the normal conventions here
  */
 service {
   rpc memclnt_rx_thread_suspend returns null;
@@ -145,6 +145,12 @@ manual_print define trace_plugin_msg_ids
     u16 last_msg_id;
 };
 
+typedef message_table_entry
+{
+  u16 index;
+  u8 name[64];
+};
+
 /*
  * Create a socket client registration. 
  */
@@ -154,23 +160,26 @@ define sockclnt_create {
 };
 
 define sockclnt_create_reply {
+    u32 client_index;
     u32 context;                /* opaque value from the create request */
     i32 response;               /* Non-negative = success */
-    u64 handle;           	/* handle by which vlib knows this client */
     u32 index;                  /* index, used e.g. by API trace replay */
+    u16 count;
+    vl_api_message_table_entry_t message_table[count];
 };
 
 /*
  * Delete a client registration 
  */
 define sockclnt_delete {
+    u32 client_index;
+    u32 context;
     u32 index;                  /* index, used e.g. by API trace replay */
-    u64 handle;               	/* handle by which vlib knows this client */
 };
 
 define sockclnt_delete_reply {
+    u32 context;
     i32 response;               /* Non-negative = success */
-    u64 handle;               	/* in case the client wonders */
 };
 
 /*
diff --git a/src/vlibmemory/socket_api.c b/src/vlibmemory/socket_api.c
index afe02d20536..4787069daa3 100644
--- a/src/vlibmemory/socket_api.c
+++ b/src/vlibmemory/socket_api.c
@@ -1,6 +1,6 @@
 /*
  *------------------------------------------------------------------
- * socksvr_vlib.c
+ * socket_api.c
  *
  * Copyright (c) 2009 Cisco and/or its affiliates.
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -74,6 +74,20 @@ vl_sock_api_dump_clients (vlib_main_t * vm, api_main_t * am)
 /* *INDENT-ON* */
 }
 
+vl_api_registration_t *
+vl_socket_api_client_index_to_registration (u32 index)
+{
+  socket_main_t *sm = &socket_main;
+  if (pool_is_free_index (sm->registration_pool, ntohl (index)))
+    {
+#if DEBUG > 2
+      clib_warning ("Invalid index %d\n", ntohl (index));
+#endif
+      return 0;
+    }
+  return pool_elt_at_index (sm->registration_pool, ntohl (index));
+}
+
 void
 vl_socket_api_send (vl_api_registration_t * rp, u8 * elem)
 {
@@ -289,26 +303,37 @@ vl_socket_write_ready (clib_file_t * uf)
   rp = pool_elt_at_index (socket_main.registration_pool, uf->private_data);
 
   /* Flush output vector. */
-  n = write (uf->file_descriptor, rp->output_vector,
-	     vec_len (rp->output_vector));
-  if (n < 0)
+  size_t total_bytes = vec_len (rp->output_vector);
+  size_t bytes_to_send, remaining_bytes = total_bytes;
+  void *p = rp->output_vector;
+  while (remaining_bytes > 0)
     {
+      bytes_to_send = remaining_bytes > 4096 ? 4096 : remaining_bytes;
+      n = write (uf->file_descriptor, p, bytes_to_send);
+      if (n < 0)
+	{
+	  if (errno == EAGAIN)
+	    {
+	      break;
+	    }
 #if DEBUG > 2
-      clib_warning ("write error, close the file...\n");
+	  clib_warning ("write error, close the file...\n");
 #endif
-      clib_file_del (fm, uf);
-      vl_socket_free_registration_index (rp - socket_main.registration_pool);
-      return 0;
+	  clib_file_del (fm, uf);
+	  vl_socket_free_registration_index (rp -
+					     socket_main.registration_pool);
+	  return 0;
+	}
+      remaining_bytes -= bytes_to_send;
+      p += bytes_to_send;
     }
-  else if (n > 0)
+
+  vec_delete (rp->output_vector, total_bytes - remaining_bytes, 0);
+  if (vec_len (rp->output_vector) <= 0
+      && (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE))
     {
-      vec_delete (rp->output_vector, n, 0);
-      if (vec_len (rp->output_vector) <= 0
-	  && (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE))
-	{
-	  uf->flags &= ~UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
-	  fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
-	}
+      uf->flags &= ~UNIX_FILE_DATA_AVAILABLE_TO_WRITE;
+      fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY);
     }
 
   return 0;
@@ -379,7 +404,11 @@ vl_api_sockclnt_create_t_handler (vl_api_sockclnt_create_t * mp)
 {
   vl_api_registration_t *regp;
   vl_api_sockclnt_create_reply_t *rp;
+  api_main_t *am = &api_main;
+  hash_pair_t *hp;
   int rv = 0;
+  u32 nmsg = hash_elts (am->msg_index_by_name_and_crc);
+  u32 i = 0;
 
   regp = socket_main.current_rp;
 
@@ -387,13 +416,22 @@ vl_api_sockclnt_create_t_handler (vl_api_sockclnt_create_t * mp)
 
   regp->name = format (0, "%s%c", mp->name, 0);
 
-  rp = vl_msg_api_alloc (sizeof (*rp));
+  u32 size = sizeof (*rp) + (nmsg * sizeof (vl_api_message_table_entry_t));
+  rp = vl_msg_api_alloc (size);
   rp->_vl_msg_id = htons (VL_API_SOCKCLNT_CREATE_REPLY);
-  rp->handle = (uword) regp;
-  rp->index = (uword) regp->vl_api_registration_pool_index;
+  rp->index = htonl (regp->vl_api_registration_pool_index);
   rp->context = mp->context;
   rp->response = htonl (rv);
-
+  rp->count = htons (nmsg);
+
+  /* *INDENT-OFF* */
+  hash_foreach_pair (hp, am->msg_index_by_name_and_crc,
+  ({
+    rp->message_table[i].index = htons(hp->value[0]);
+    strncpy((char *)rp->message_table[i].name, (char *)hp->key, 64-1);
+    i++;
+  }));
+  /* *INDENT-ON* */
   vl_api_send_msg (regp, (u8 *) rp);
 }
 
@@ -406,23 +444,28 @@ vl_api_sockclnt_delete_t_handler (vl_api_sockclnt_delete_t * mp)
   vl_api_registration_t *regp;
   vl_api_sockclnt_delete_reply_t *rp;
 
-  if (!pool_is_free_index (socket_main.registration_pool, mp->index))
-    {
-      regp = pool_elt_at_index (socket_main.registration_pool, mp->index);
+  regp = vl_api_client_index_to_registration (mp->client_index);
+  if (!regp)
+    return;
 
-      rp = vl_msg_api_alloc (sizeof (*rp));
-      rp->_vl_msg_id = htons (VL_API_SOCKCLNT_DELETE_REPLY);
-      rp->handle = mp->handle;
-      rp->response = htonl (1);
+  u32 reg_index = ntohl (mp->index);
+  rp = vl_msg_api_alloc (sizeof (*rp));
+  rp->_vl_msg_id = htons (VL_API_SOCKCLNT_DELETE_REPLY);
+  rp->context = mp->context;
 
+  if (!pool_is_free_index (socket_main.registration_pool, reg_index))
+    {
+      rp->response = htonl (1);
       vl_api_send_msg (regp, (u8 *) rp);
 
       vl_api_registration_del_file (regp);
-      vl_socket_free_registration_index (mp->index);
+      vl_socket_free_registration_index (reg_index);
     }
   else
     {
-      clib_warning ("unknown client ID %d", mp->index);
+      clib_warning ("unknown client ID %d", reg_index);
+      rp->response = htonl (-1);
+      vl_api_send_msg (regp, (u8 *) rp);
     }
 }
 
diff --git a/src/vlibmemory/socket_api.h b/src/vlibmemory/socket_api.h
index 1e99550e64b..00985fe7591 100644
--- a/src/vlibmemory/socket_api.h
+++ b/src/vlibmemory/socket_api.h
@@ -75,6 +75,8 @@ clib_error_t *vl_sock_api_send_fd_msg (int socket_fd, int fds[], int n_fds);
 clib_error_t *vl_sock_api_recv_fd_msg (int socket_fd, int fds[], int n_fds,
 				       u32 wait);
 
+vl_api_registration_t *vl_socket_api_client_index_to_registration (u32 index);
+
 #endif /* SRC_VLIBMEMORY_SOCKET_API_H_ */
 
 /*
diff --git a/src/vlibmemory/vlib_api.c b/src/vlibmemory/vlib_api.c
index 65fa34bcc63..15a0ba82f12 100644
--- a/src/vlibmemory/vlib_api.c
+++ b/src/vlibmemory/vlib_api.c
@@ -165,8 +165,8 @@ vl_api_api_versions_t_handler (vl_api_api_versions_t * mp)
   vl_api_send_msg (reg, (u8 *) rmp);
 }
 
-#define foreach_vlib_api_msg                            \
-_(GET_FIRST_MSG_ID, get_first_msg_id)                   \
+#define foreach_vlib_api_msg				\
+_(GET_FIRST_MSG_ID, get_first_msg_id)			\
 _(API_VERSIONS, api_versions)
 
 /*