memif: improve error reporting
[vpp.git] / src / plugins / memif / private.h
index b7c18c9..559062e 100644 (file)
@@ -16,6 +16,7 @@
  */
 
 #include <vppinfra/lock.h>
+#include <vlib/log.h>
 
 #define MEMIF_DEFAULT_SOCKET_FILENAME  "memif.sock"
 #define MEMIF_DEFAULT_RING_SIZE 1024
 #define MEMIF_DEFAULT_TX_QUEUES 1
 #define MEMIF_DEFAULT_BUFFER_SIZE 2048
 
-#define MEMIF_MAX_M2S_RING             (vec_len (vlib_mains) - 1)
-#define MEMIF_MAX_S2M_RING             (vec_len (vlib_mains) - 1)
-#define MEMIF_MAX_REGION               255
+#define MEMIF_MAX_M2S_RING             256
+#define MEMIF_MAX_S2M_RING             256
+#define MEMIF_MAX_REGION               256
 #define MEMIF_MAX_LOG2_RING_SIZE       14
 
-#define MEMIF_DEBUG 0
-
-#if MEMIF_DEBUG == 1
-#define DBG(...) clib_warning(__VA_ARGS__)
-#define DBG_UNIX_LOG(...) clib_unix_warning(__VA_ARGS__)
-#else
-#define DBG(...)
-#define DBG_UNIX_LOG(...)
-#endif
-
-#if MEMIF_DEBUG == 1
-#define memif_file_add(a, b) do {                                      \
-  *a = clib_file_add (&file_main, b);                                  \
-  clib_warning ("clib_file_add fd %d private_data %u idx %u",          \
-               (b)->file_descriptor, (b)->private_data, *a);           \
-} while (0)
 
-#define memif_file_del(a) do {                                         \
-  clib_warning ("clib_file_del idx %u",a - file_main.file_pool);       \
-  clib_file_del (&file_main, a);                                       \
+#define memif_log_debug(dev, f, ...) do {                               \
+  memif_if_t *_dev = (memif_if_t *) dev;                                \
+  if (_dev)                                                             \
+    vlib_log(VLIB_LOG_LEVEL_DEBUG, memif_main.log_class, "%U: " f,      \
+            format_vnet_hw_if_index_name, vnet_get_main(),             \
+            _dev->hw_if_index, ##__VA_ARGS__);                         \
+  else                                                                  \
+    vlib_log(VLIB_LOG_LEVEL_DEBUG, memif_main.log_class, f,             \
+             ##__VA_ARGS__);                                            \
 } while (0)
 
-#define memif_file_del_by_index(a) do {                                        \
-  clib_warning ("clib_file_del idx %u", a);                            \
-  clib_file_del_by_index (&file_main, a);                              \
+#define memif_log_warn(dev, f, ...) do {                                \
+  memif_if_t *_dev = (memif_if_t *) dev;                                \
+  if (_dev)                                                             \
+    vlib_log(VLIB_LOG_LEVEL_WARNING, memif_main.log_class, "%U: " f,    \
+            format_vnet_hw_if_index_name, vnet_get_main(),             \
+            _dev->hw_if_index, ##__VA_ARGS__);                         \
+  else                                                                  \
+    vlib_log(VLIB_LOG_LEVEL_WARNING, memif_main.log_class, f,           \
+             ##__VA_ARGS__);                                            \
 } while (0)
-#else
-#define memif_file_add(a, b) do {                                      \
-  *a = clib_file_add (&file_main, b);                                  \
+
+#define memif_log_err(dev, f, ...) do {                                 \
+  memif_if_t *_dev = (memif_if_t *) dev;                                \
+  if (_dev)                                                             \
+    vlib_log(VLIB_LOG_LEVEL_ERR, memif_main.log_class, "%U: " f,        \
+            format_vnet_hw_if_index_name, vnet_get_main(),             \
+            _dev->hw_if_index, ##__VA_ARGS__);                         \
+  else                                                                  \
+    vlib_log(VLIB_LOG_LEVEL_ERR, memif_main.log_class, f,               \
+             ##__VA_ARGS__);                                            \
 } while (0)
-#define memif_file_del(a) clib_file_del(&file_main, a)
-#define memif_file_del_by_index(a) clib_file_del_by_index(&file_main, a)
-#endif
+
+#define memif_file_add(a, b)                                                  \
+  do                                                                          \
+    {                                                                         \
+      *a = clib_file_add (&file_main, b);                                     \
+      memif_log_debug (0, "clib_file_add fd %d private_data %u idx %u",       \
+                      (b)->file_descriptor, (b)->private_data, *a);          \
+    }                                                                         \
+  while (0)
+
+#define memif_file_del(a)                                                     \
+  do                                                                          \
+    {                                                                         \
+      memif_log_debug (0, "clib_file_del idx %u", a - file_main.file_pool);   \
+      clib_file_del (&file_main, a);                                          \
+    }                                                                         \
+  while (0)
+
+#define memif_file_del_by_index(a)                                            \
+  do                                                                          \
+    {                                                                         \
+      memif_log_debug (0, "clib_file_del idx %u", a);                         \
+      clib_file_del_by_index (&file_main, a);                                 \
+    }                                                                         \
+  while (0)
 
 typedef struct
 {
@@ -80,9 +106,12 @@ typedef struct
 
 typedef struct
 {
+  /* Required for vec_validate_aligned */
+  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
   void *shm;
   memif_region_size_t region_size;
   int fd;
+  u8 is_external;
 } memif_region_t;
 
 typedef struct
@@ -93,6 +122,8 @@ typedef struct
 
 typedef struct
 {
+  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
+  clib_spinlock_t lockp;
   /* ring data */
   memif_ring_t *ring;
   memif_log2_ring_size_t log2_ring_size;
@@ -101,6 +132,8 @@ typedef struct
 
   u16 last_head;
   u16 last_tail;
+  u32 *buffers;
+  u8 buffer_pool_index;
 
   /* interrupts */
   int int_fd;
@@ -109,6 +142,7 @@ typedef struct
 
   /* queue type */
   memif_ring_type_t type;
+  u32 queue_index;
 } memif_queue_t;
 
 #define foreach_memif_if_flag \
@@ -116,7 +150,9 @@ typedef struct
   _(1, IS_SLAVE, "slave")              \
   _(2, CONNECTING, "connecting")       \
   _(3, CONNECTED, "connected")         \
-  _(4, DELETING, "deleting")
+  _(4, DELETING, "deleting")           \
+  _(5, ZERO_COPY, "zero-copy")         \
+  _(6, ERROR, "error")
 
 typedef enum
 {
@@ -128,7 +164,6 @@ typedef enum
 typedef struct
 {
   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
-  clib_spinlock_t lockp;
   u32 flags;
   memif_interface_id_t id;
   u32 hw_if_index;
@@ -174,6 +209,67 @@ typedef struct
   u8 *remote_disc_string;
 } memif_if_t;
 
+typedef struct
+{
+  u16 packet_len;
+  u16 first_buffer_vec_index;
+} memif_packet_op_t;
+
+typedef struct
+{
+  CLIB_ALIGN_MARK (pad, 16);   /* align up to 16 bytes for 32bit builds */
+  void *data;
+  u32 data_len;
+  i16 buffer_offset;
+  u16 buffer_vec_index;
+} memif_copy_op_t;
+
+#define MEMIF_RX_VECTOR_SZ VLIB_FRAME_SIZE
+
+typedef enum
+{
+  MEMIF_DESC_STATUS_OK = 0,
+  MEMIF_DESC_STATUS_ERR_BAD_REGION,
+  MEMIF_DESC_STATUS_ERR_REGION_OVERRUN,
+  MEMIF_DESC_STATUS_ERR_DATA_TOO_BIG,
+  MEMIF_DESC_STATUS_ERR_ZERO_LENGTH
+} __clib_packed memif_desc_status_err_code_t;
+
+typedef union
+{
+  struct
+  {
+    u8 next : 1;
+    u8 err : 1;
+    u8 reserved : 2;
+    memif_desc_status_err_code_t err_code : 4;
+  };
+  u8 as_u8;
+} memif_desc_status_t;
+
+STATIC_ASSERT_SIZEOF (memif_desc_status_t, 1);
+
+typedef struct
+{
+  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
+  u16 n_packets;
+  u16 max_desc_len;
+  u32 n_rx_bytes;
+  u8 xor_status;
+  /* copy vector */
+  memif_copy_op_t *copy_ops;
+  u32 *buffers;
+  memif_packet_op_t packet_ops[MEMIF_RX_VECTOR_SZ];
+
+  /* temp storage for compressed descriptors */
+  void **desc_data;
+  u16 *desc_len;
+  memif_desc_status_t *desc_status;
+
+  /* buffer template */
+  vlib_buffer_t buffer_template;
+} memif_per_thread_data_t;
+
 typedef struct
 {
   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
@@ -188,8 +284,10 @@ typedef struct
   memif_socket_file_t *socket_files;
   uword *socket_file_index_by_sock_id; /* map user socket id to pool idx */
 
-  /* rx buffer cache */
-  u32 **rx_buffers;
+  /* per thread data */
+  memif_per_thread_data_t *per_thread_data;
+
+  vlib_log_class_t log_class;
 
 } memif_main_t;
 
@@ -197,10 +295,11 @@ extern memif_main_t memif_main;
 extern vnet_device_class_t memif_device_class;
 extern vlib_node_registration_t memif_input_node;
 
-enum
+typedef enum
 {
   MEMIF_PROCESS_EVENT_START = 1,
   MEMIF_PROCESS_EVENT_STOP = 2,
+  MEMIF_PROCESS_EVENT_ADMIN_UP_DOWN = 3,
 } memif_process_event_t;
 
 typedef struct
@@ -209,6 +308,7 @@ typedef struct
   u32 socket_id;
   u8 *secret;
   u8 is_master;
+  u8 is_zero_copy;
   memif_interface_mode_t mode:8;
   memif_log2_ring_size_t log2_ring_size;
   u16 buffer_size;
@@ -221,11 +321,13 @@ typedef struct
   u32 sw_if_index;
 } memif_create_if_args_t;
 
-int memif_socket_filename_add_del (u8 is_add, u32 sock_id,
-                                  u8 * sock_filename);
-int memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args);
-int memif_delete_if (vlib_main_t * vm, memif_if_t * mif);
+clib_error_t *memif_socket_filename_add_del (u8 is_add, u32 sock_id,
+                                            u8 *sock_filename);
+clib_error_t *memif_create_if (vlib_main_t *vm, memif_create_if_args_t *args);
+clib_error_t *memif_delete_if (vlib_main_t *vm, memif_if_t *mif);
 clib_error_t *memif_plugin_api_hookup (vlib_main_t * vm);
+clib_error_t *memif_interface_admin_up_down (vnet_main_t *vnm, u32 hw_if_index,
+                                            u32 flags);
 
 static_always_inline void *
 memif_get_buffer (memif_if_t * mif, memif_ring_t * ring, u16 slot)
@@ -252,6 +354,7 @@ clib_error_t *memif_msg_send_disconnect (memif_if_t * mif,
                                         clib_error_t * err);
 u8 *format_memif_device_name (u8 * s, va_list * args);
 
+
 /*
  * fd.io coding-style-patch-verification: ON
  *