src/plugins/memif/private.h

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2017 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17
  18 #include <vppinfra/lock.h>
  19 #include <vlib/log.h>
  20
  21 #define MEMIF_DEFAULT_SOCKET_FILENAME  "memif.sock"
  22 #define MEMIF_DEFAULT_RING_SIZE 1024
  23 #define MEMIF_DEFAULT_RX_QUEUES 1
  24 #define MEMIF_DEFAULT_TX_QUEUES 1
  25 #define MEMIF_DEFAULT_BUFFER_SIZE 2048
  26
  27 #define MEMIF_MAX_M2S_RING              (vec_len (vlib_mains))
  28 #define MEMIF_MAX_S2M_RING              256
  29 #define MEMIF_MAX_REGION                256
  30 #define MEMIF_MAX_LOG2_RING_SIZE        14
  31
  32
  33 #define memif_log_debug(dev, f, ...) do {                               \
  34   memif_if_t *_dev = (memif_if_t *) dev;                                \
  35   if (_dev)                                                             \
  36     vlib_log(VLIB_LOG_LEVEL_DEBUG, memif_main.log_class, "%U: " f,      \
  37              format_vnet_hw_if_index_name, vnet_get_main(),             \
  38              _dev->hw_if_index, ##__VA_ARGS__);                         \
  39   else                                                                  \
  40     vlib_log(VLIB_LOG_LEVEL_DEBUG, memif_main.log_class, f,             \
  41              ##__VA_ARGS__);                                            \
  42 } while (0)
  43
  44 #define memif_log_warn(dev, f, ...) do {                                \
  45   memif_if_t *_dev = (memif_if_t *) dev;                                \
  46   if (_dev)                                                             \
  47     vlib_log(VLIB_LOG_LEVEL_WARNING, memif_main.log_class, "%U: " f,    \
  48              format_vnet_hw_if_index_name, vnet_get_main(),             \
  49              _dev->hw_if_index, ##__VA_ARGS__);                         \
  50   else                                                                  \
  51     vlib_log(VLIB_LOG_LEVEL_WARNING, memif_main.log_class, f,           \
  52              ##__VA_ARGS__);                                            \
  53 } while (0)
  54
  55 #define memif_log_err(dev, f, ...) do {                                 \
  56   memif_if_t *_dev = (memif_if_t *) dev;                                \
  57   if (_dev)                                                             \
  58     vlib_log(VLIB_LOG_LEVEL_ERR, memif_main.log_class, "%U: " f,        \
  59              format_vnet_hw_if_index_name, vnet_get_main(),             \
  60              _dev->hw_if_index, ##__VA_ARGS__);                         \
  61   else                                                                  \
  62     vlib_log(VLIB_LOG_LEVEL_ERR, memif_main.log_class, f,               \
  63              ##__VA_ARGS__);                                            \
  64 } while (0)
  65
  66 #define memif_file_add(a, b) do {                                       \
  67   *a = clib_file_add (&file_main, b);                                   \
  68   memif_log_warn (0, "clib_file_add fd %d private_data %u idx %u",      \
  69                 (b)->file_descriptor, (b)->private_data, *a);           \
  70 } while (0)
  71
  72 #define memif_file_del(a) do {                                          \
  73   memif_log_warn (0, "clib_file_del idx %u", a - file_main.file_pool);  \
  74   clib_file_del (&file_main, a);                                        \
  75 } while (0)
  76
  77 #define memif_file_del_by_index(a) do {                                 \
  78   memif_log_warn (0, "clib_file_del idx %u", a);                        \
  79   clib_file_del_by_index (&file_main, a);                               \
  80 } while (0)
  81
  82 typedef struct
  83 {
  84   u8 *filename;
  85   u32 socket_id;
  86   clib_socket_t *sock;
  87   clib_socket_t **pending_clients;
  88   int ref_cnt;
  89   int is_listener;
  90
  91   /* hash of all registered id */
  92   mhash_t dev_instance_by_id;
  93
  94   /* hash of all registered fds */
  95   uword *dev_instance_by_fd;
  96 } memif_socket_file_t;
  97
  98 typedef struct
  99 {
 100   /* Required for vec_validate_aligned */
 101   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 102   void *shm;
 103   memif_region_size_t region_size;
 104   int fd;
 105   u8 is_external;
 106 } memif_region_t;
 107
 108 typedef struct
 109 {
 110   memif_msg_t msg;
 111   int fd;
 112 } memif_msg_fifo_elt_t;
 113
 114 typedef struct
 115 {
 116   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 117   /* ring data */
 118   memif_ring_t *ring;
 119   memif_log2_ring_size_t log2_ring_size;
 120   memif_region_index_t region;
 121   memif_region_offset_t offset;
 122
 123   u16 last_head;
 124   u16 last_tail;
 125   u32 *buffers;
 126
 127   /* interrupts */
 128   int int_fd;
 129   uword int_clib_file_index;
 130   u64 int_count;
 131
 132   /* queue type */
 133   memif_ring_type_t type;
 134 } memif_queue_t;
 135
 136 #define foreach_memif_if_flag \
 137   _(0, ADMIN_UP, "admin-up")            \
 138   _(1, IS_SLAVE, "slave")               \
 139   _(2, CONNECTING, "connecting")        \
 140   _(3, CONNECTED, "connected")          \
 141   _(4, DELETING, "deleting")            \
 142   _(5, ZERO_COPY, "zero-copy")          \
 143   _(6, ERROR, "error")
 144
 145 typedef enum
 146 {
 147 #define _(a, b, c) MEMIF_IF_FLAG_##b = (1 << a),
 148   foreach_memif_if_flag
 149 #undef _
 150 } memif_if_flag_t;
 151
 152 typedef struct
 153 {
 154   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 155   clib_spinlock_t lockp;
 156   u32 flags;
 157   memif_interface_id_t id;
 158   u32 hw_if_index;
 159   u32 sw_if_index;
 160   uword dev_instance;
 161   memif_interface_mode_t mode:8;
 162
 163   u32 per_interface_next_index;
 164
 165   /* socket connection */
 166   clib_socket_t *sock;
 167   uword socket_file_index;
 168   memif_msg_fifo_elt_t *msg_queue;
 169   u8 *secret;
 170
 171   memif_region_t *regions;
 172
 173   memif_queue_t *rx_queues;
 174   memif_queue_t *tx_queues;
 175
 176   /* remote info */
 177   u8 *remote_name;
 178   u8 *remote_if_name;
 179
 180   struct
 181   {
 182     memif_log2_ring_size_t log2_ring_size;
 183     u8 num_s2m_rings;
 184     u8 num_m2s_rings;
 185     u16 buffer_size;
 186   } cfg;
 187
 188   struct
 189   {
 190     memif_log2_ring_size_t log2_ring_size;
 191     u8 num_s2m_rings;
 192     u8 num_m2s_rings;
 193     u16 buffer_size;
 194   } run;
 195
 196   /* disconnect strings */
 197   u8 *local_disc_string;
 198   u8 *remote_disc_string;
 199 } memif_if_t;
 200
 201 typedef struct
 202 {
 203   u32 packet_len;
 204   u16 first_buffer_vec_index;
 205 } memif_packet_op_t;
 206
 207 typedef struct
 208 {
 209   CLIB_ALIGN_MARK (pad, 16);    /* align up to 16 bytes for 32bit builds */
 210   void *data;
 211   u32 data_len;
 212   i16 buffer_offset;
 213   u16 buffer_vec_index;
 214 } memif_copy_op_t;
 215
 216 #define MEMIF_RX_VECTOR_SZ VLIB_FRAME_SIZE
 217
 218 typedef struct
 219 {
 220   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 221
 222   /* copy vector */
 223   memif_packet_op_t packet_ops[MEMIF_RX_VECTOR_SZ];
 224   memif_copy_op_t *copy_ops;
 225   u32 *buffers;
 226
 227   /* buffer template */
 228   vlib_buffer_t buffer_template;
 229   memif_desc_t desc_template;
 230 } memif_per_thread_data_t;
 231
 232 typedef struct
 233 {
 234   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 235
 236   /** API message ID base */
 237   u16 msg_id_base;
 238
 239   /* pool of all memory interfaces */
 240   memif_if_t *interfaces;
 241
 242   /* pool of all unix socket files */
 243   memif_socket_file_t *socket_files;
 244   uword *socket_file_index_by_sock_id;  /* map user socket id to pool idx */
 245
 246   /* per thread data */
 247   memif_per_thread_data_t *per_thread_data;
 248
 249   vlib_log_class_t log_class;
 250
 251 } memif_main_t;
 252
 253 extern memif_main_t memif_main;
 254 extern vnet_device_class_t memif_device_class;
 255 extern vlib_node_registration_t memif_input_node;
 256
 257 enum
 258 {
 259   MEMIF_PROCESS_EVENT_START = 1,
 260   MEMIF_PROCESS_EVENT_STOP = 2,
 261 } memif_process_event_t;
 262
 263 typedef struct
 264 {
 265   memif_interface_id_t id;
 266   u32 socket_id;
 267   u8 *secret;
 268   u8 is_master;
 269   u8 is_zero_copy;
 270   memif_interface_mode_t mode:8;
 271   memif_log2_ring_size_t log2_ring_size;
 272   u16 buffer_size;
 273   u8 hw_addr_set;
 274   u8 hw_addr[6];
 275   u8 rx_queues;
 276   u8 tx_queues;
 277
 278   /* return */
 279   u32 sw_if_index;
 280 } memif_create_if_args_t;
 281
 282 int memif_socket_filename_add_del (u8 is_add, u32 sock_id,
 283                                    u8 * sock_filename);
 284 int memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args);
 285 int memif_delete_if (vlib_main_t * vm, memif_if_t * mif);
 286 clib_error_t *memif_plugin_api_hookup (vlib_main_t * vm);
 287
 288 static_always_inline void *
 289 memif_get_buffer (memif_if_t * mif, memif_ring_t * ring, u16 slot)
 290 {
 291   u16 region = ring->desc[slot].region;
 292   return mif->regions[region].shm + ring->desc[slot].offset;
 293 }
 294
 295 /* memif.c */
 296 clib_error_t *memif_init_regions_and_queues (memif_if_t * mif);
 297 clib_error_t *memif_connect (memif_if_t * mif);
 298 void memif_disconnect (memif_if_t * mif, clib_error_t * err);
 299
 300 /* socket.c */
 301 void memif_socket_close (clib_socket_t ** sock);
 302 clib_error_t *memif_conn_fd_accept_ready (clib_file_t * uf);
 303 clib_error_t *memif_master_conn_fd_read_ready (clib_file_t * uf);
 304 clib_error_t *memif_slave_conn_fd_read_ready (clib_file_t * uf);
 305 clib_error_t *memif_master_conn_fd_write_ready (clib_file_t * uf);
 306 clib_error_t *memif_slave_conn_fd_write_ready (clib_file_t * uf);
 307 clib_error_t *memif_master_conn_fd_error (clib_file_t * uf);
 308 clib_error_t *memif_slave_conn_fd_error (clib_file_t * uf);
 309 clib_error_t *memif_msg_send_disconnect (memif_if_t * mif,
 310                                          clib_error_t * err);
 311 u8 *format_memif_device_name (u8 * s, va_list * args);
 312
 313
 314 /*
 315  * fd.io coding-style-patch-verification: ON
 316  *
 317  * Local Variables:
 318  * eval: (c-set-style "gnu")
 319  * End:
 320  */