api: refactor vlibmemory

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

diff --git a/src/vlibmemory/socket_api.h b/src/vlibmemory/socket_api.h
new file mode 100644 (file)
index 0000000..69610e8
--- /dev/null
+++ b/src/vlibmemory/socket_api.h
@@ -0,0 +1,88 @@
+/*
+ *------------------------------------------------------------------
+ * Copyright (c) 2018 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.
+ *------------------------------------------------------------------
+ */
+
+#ifndef SRC_VLIBMEMORY_SOCKET_API_H_
+#define SRC_VLIBMEMORY_SOCKET_API_H_
+
+#include <vlibapi/api_common.h>
+#include <vppinfra/file.h>
+
+#define API_SOCKET_FILE "/run/vpp-api.sock"
+
+typedef struct
+{
+  clib_file_t *clib_file;
+  vl_api_registration_t *regp;
+  u8 *data;
+} vl_socket_args_for_process_t;
+
+typedef struct
+{
+  /* Server port number */
+  u8 *socket_name;
+
+  /* By default, localhost... */
+  u32 bind_address;
+
+  /*
+   * (listen, server, client) registrations. Shared memory
+   * registrations are in shared memory
+   */
+  vl_api_registration_t *registration_pool;
+  /*
+   * Chain-drag variables, so message API handlers
+   * (generally) don't know whether they're talking to a socket
+   * or to a shared-memory connection.
+   */
+  vl_api_registration_t *current_rp;
+  clib_file_t *current_uf;
+  /* One input buffer, shared across all sockets */
+  i8 *input_buffer;
+
+  /* pool of process args for socket clients */
+  vl_socket_args_for_process_t *process_args;
+
+  /* Listen for API connections here */
+  clib_socket_t socksvr_listen_socket;
+} socket_main_t;
+
+extern socket_main_t socket_main;
+
+void vl_socket_free_registration_index (u32 pool_index);
+clib_error_t *vl_socket_read_ready (struct clib_file *uf);
+void vl_socket_add_pending_output (struct clib_file *uf,
+                                  struct vl_api_registration_ *rp,
+                                  u8 * buffer, uword buffer_bytes);
+void vl_socket_add_pending_output_no_flush (struct clib_file *uf,
+                                           struct vl_api_registration_ *rp,
+                                           u8 * buffer, uword buffer_bytes);
+clib_error_t *vl_socket_write_ready (struct clib_file *uf);
+void vl_socket_api_send (vl_api_registration_t * rp, u8 * elem);
+void vl_socket_process_api_msg (clib_file_t * uf, vl_api_registration_t * rp,
+                               i8 * input_v);
+void vl_sock_api_dump_clients (vlib_main_t * vm, api_main_t * am);
+clib_error_t *vl_sock_api_init (vlib_main_t * vm);
+
+#endif /* SRC_VLIBMEMORY_SOCKET_API_H_ */
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */