api: add new stream message convention

[vpp.git] / src / vlibmemory / api.h

diff --git a/src/vlibmemory/api.h b/src/vlibmemory/api.h
index e86b88c..6628053 100644 (file)
--- a/src/vlibmemory/api.h
+++ b/src/vlibmemory/api.h
@@ -26,6 +26,7 @@
 #include <vlibmemory/socket_client.h>
 
 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
+void vl_api_force_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
 u16 vl_client_get_first_plugin_msg_id (const char *plugin_name);
 void vl_api_send_pending_rpc_requests (vlib_main_t * vm);
 u8 *vl_api_serialize_message_table (api_main_t * am, u8 * vector);
@@ -52,13 +53,73 @@ vl_api_can_send_msg (vl_api_registration_t * rp)
     return vl_mem_api_can_send (rp->vl_input_queue);
 }
 
+/*
+ * Suggests to an API handler to relinguish control. Currently limits
+ * an handler to a maximum of 1ms or it earlier if the client queue is
+ * full.
+ *
+ * May be enhanced in the future based on other performance
+ * characteristics of the main thread.
+ */
+#define VL_API_MAX_TIME_IN_HANDLER 0.001       /* 1 ms */
+always_inline int
+vl_api_process_may_suspend (vlib_main_t * vm, vl_api_registration_t * rp,
+                           f64 start)
+{
+  /* Is client queue full (leave space for reply message) */
+  if (rp->registration_type <= REGISTRATION_TYPE_SHMEM &&
+      rp->vl_input_queue->cursize + 1 >= rp->vl_input_queue->maxsize)
+    return true;
+  if (vlib_time_now (vm) > start + VL_API_MAX_TIME_IN_HANDLER)
+    return true;
+  return false;
+}
+
 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;
+  if (vl_socket_api_registration_handle_is_valid (ntohl (index)))
+    return vl_socket_api_client_handle_to_registration (ntohl (index));
+  return vl_mem_api_client_index_to_registration (index);
+}
+
+always_inline u32
+vl_api_registration_file_index (vl_api_registration_t * reg)
+{
+  return reg->clib_file_index;
+}
+
+always_inline clib_file_t *
+vl_api_registration_file (vl_api_registration_t * reg)
+{
+  return clib_file_get (&file_main, vl_api_registration_file_index (reg));
+}
 
-  return (vl_mem_api_client_index_to_registration (index));
+always_inline void
+vl_api_registration_del_file (vl_api_registration_t * reg)
+{
+  clib_file_t *cf = vl_api_registration_file (reg);
+  if (cf)
+    clib_file_del (&file_main, cf);
+}
+
+always_inline clib_error_t *
+vl_api_send_fd_msg (vl_api_registration_t * reg, int fds[], int n_fds)
+{
+  clib_file_t *cf = vl_api_registration_file (reg);
+  if (cf)
+    return vl_sock_api_send_fd_msg (cf->file_descriptor, fds, n_fds);
+  return 0;
+}
+
+always_inline clib_error_t *
+vl_api_recv_fd_msg (vl_api_registration_t * reg, int fds[], int n_fds,
+                   u32 wait)
+{
+  clib_file_t *cf = vl_api_registration_file (reg);
+  if (cf)
+    return vl_sock_api_recv_fd_msg (cf->file_descriptor, fds, n_fds, wait);
+  return 0;
 }
 
 /*