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