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 } memif_region_t;
  87
  88 typedef struct
  89 {
  90   memif_msg_t msg;
  91   int fd;
  92 } memif_msg_fifo_elt_t;
  93
  94 typedef struct
  95 {
  96   /* ring data */
  97   memif_ring_t *ring;
  98   memif_log2_ring_size_t log2_ring_size;
  99   memif_region_index_t region;
 100   memif_region_offset_t offset;
 101
 102   u16 last_head;
 103   u16 last_tail;
 104
 105   /* interrupts */
 106   int int_fd;
 107   uword int_clib_file_index;
 108   u64 int_count;
 109
 110   /* queue type */
 111   memif_ring_type_t type;
 112 } memif_queue_t;
 113
 114 #define foreach_memif_if_flag \
 115   _(0, ADMIN_UP, "admin-up")            \
 116   _(1, IS_SLAVE, "slave")               \
 117   _(2, CONNECTING, "connecting")        \
 118   _(3, CONNECTED, "connected")          \
 119   _(4, DELETING, "deleting")
 120
 121 typedef enum
 122 {
 123 #define _(a, b, c) MEMIF_IF_FLAG_##b = (1 << a),
 124   foreach_memif_if_flag
 125 #undef _
 126 } memif_if_flag_t;
 127
 128 typedef struct
 129 {
 130   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 131   clib_spinlock_t lockp;
 132   u32 flags;
 133   memif_interface_id_t id;
 134   u32 hw_if_index;
 135   u32 sw_if_index;
 136   uword dev_instance;
 137   memif_interface_mode_t mode:8;
 138
 139   u32 per_interface_next_index;
 140
 141   /* socket connection */
 142   clib_socket_t *sock;
 143   uword socket_file_index;
 144   memif_msg_fifo_elt_t *msg_queue;
 145   u8 *secret;
 146
 147   memif_region_t *regions;
 148
 149   memif_queue_t *rx_queues;
 150   memif_queue_t *tx_queues;
 151
 152   /* remote info */
 153   u8 *remote_name;
 154   u8 *remote_if_name;
 155
 156   struct
 157   {
 158     memif_log2_ring_size_t log2_ring_size;
 159     u8 num_s2m_rings;
 160     u8 num_m2s_rings;
 161     u16 buffer_size;
 162   } cfg;
 163
 164   struct
 165   {
 166     memif_log2_ring_size_t log2_ring_size;
 167     u8 num_s2m_rings;
 168     u8 num_m2s_rings;
 169     u16 buffer_size;
 170   } run;
 171
 172   /* disconnect strings */
 173   u8 *local_disc_string;
 174   u8 *remote_disc_string;
 175 } memif_if_t;
 176
 177 typedef struct
 178 {
 179   u32 packet_len;
 180   u16 first_buffer_vec_index;
 181 } memif_packet_op_t;
 182
 183 typedef struct
 184 {
 185   void *data;
 186   u32 data_len;
 187   i16 buffer_offset;
 188   u16 buffer_vec_index;
 189 } memif_copy_op_t;
 190
 191 #define MEMIF_RX_VECTOR_SZ VLIB_FRAME_SIZE
 192
 193 typedef struct
 194 {
 195   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 196
 197   /* copy vector */
 198   memif_packet_op_t packet_ops[MEMIF_RX_VECTOR_SZ];
 199   memif_copy_op_t *copy_ops;
 200   u32 *buffers;
 201
 202   /* buffer template */
 203   vlib_buffer_t buffer_template;
 204 } memif_per_thread_data_t;
 205
 206 typedef struct
 207 {
 208   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 209
 210   /** API message ID base */
 211   u16 msg_id_base;
 212
 213   /* pool of all memory interfaces */
 214   memif_if_t *interfaces;
 215
 216   /* pool of all unix socket files */
 217   memif_socket_file_t *socket_files;
 218   uword *socket_file_index_by_sock_id;  /* map user socket id to pool idx */
 219
 220   /* per thread data */
 221   memif_per_thread_data_t *per_thread_data;
 222
 223 } memif_main_t;
 224
 225 extern memif_main_t memif_main;
 226 extern vnet_device_class_t memif_device_class;
 227 extern vlib_node_registration_t memif_input_node;
 228
 229 enum
 230 {
 231   MEMIF_PROCESS_EVENT_START = 1,
 232   MEMIF_PROCESS_EVENT_STOP = 2,
 233 } memif_process_event_t;
 234
 235 typedef struct
 236 {
 237   memif_interface_id_t id;
 238   u32 socket_id;
 239   u8 *secret;
 240   u8 is_master;
 241   memif_interface_mode_t mode:8;
 242   memif_log2_ring_size_t log2_ring_size;
 243   u16 buffer_size;
 244   u8 hw_addr_set;
 245   u8 hw_addr[6];
 246   u8 rx_queues;
 247   u8 tx_queues;
 248
 249   /* return */
 250   u32 sw_if_index;
 251 } memif_create_if_args_t;
 252
 253 int memif_socket_filename_add_del (u8 is_add, u32 sock_id,
 254                                    u8 * sock_filename);
 255 int memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args);
 256 int memif_delete_if (vlib_main_t * vm, memif_if_t * mif);
 257 clib_error_t *memif_plugin_api_hookup (vlib_main_t * vm);
 258
 259 static_always_inline void *
 260 memif_get_buffer (memif_if_t * mif, memif_ring_t * ring, u16 slot)
 261 {
 262   u16 region = ring->desc[slot].region;
 263   return mif->regions[region].shm + ring->desc[slot].offset;
 264 }
 265
 266 /* memif.c */
 267 clib_error_t *memif_init_regions_and_queues (memif_if_t * mif);
 268 clib_error_t *memif_connect (memif_if_t * mif);
 269 void memif_disconnect (memif_if_t * mif, clib_error_t * err);
 270
 271 /* socket.c */
 272 void memif_socket_close (clib_socket_t ** sock);
 273 clib_error_t *memif_conn_fd_accept_ready (clib_file_t * uf);
 274 clib_error_t *memif_master_conn_fd_read_ready (clib_file_t * uf);
 275 clib_error_t *memif_slave_conn_fd_read_ready (clib_file_t * uf);
 276 clib_error_t *memif_master_conn_fd_write_ready (clib_file_t * uf);
 277 clib_error_t *memif_slave_conn_fd_write_ready (clib_file_t * uf);
 278 clib_error_t *memif_master_conn_fd_error (clib_file_t * uf);
 279 clib_error_t *memif_slave_conn_fd_error (clib_file_t * uf);
 280 clib_error_t *memif_msg_send_disconnect (memif_if_t * mif,
 281                                          clib_error_t * err);
 282 u8 *format_memif_device_name (u8 * s, va_list * args);
 283
 284 /*
 285  * fd.io coding-style-patch-verification: ON
 286  *
 287  * Local Variables:
 288  * eval: (c-set-style "gnu")
 289  * End:
 290  */