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   clib_socket_t *sock;
  69   clib_socket_t **pending_clients;
  70   int ref_cnt;
  71   int is_listener;
  72
  73   /* hash of all registered id */
  74   mhash_t dev_instance_by_id;
  75
  76   /* hash of all registered fds */
  77   uword *dev_instance_by_fd;
  78 } memif_socket_file_t;
  79
  80 typedef struct
  81 {
  82   void *shm;
  83   memif_region_size_t region_size;
  84   int fd;
  85 } memif_region_t;
  86
  87 typedef struct
  88 {
  89   memif_msg_t msg;
  90   int fd;
  91 } memif_msg_fifo_elt_t;
  92
  93 typedef struct
  94 {
  95   /* ring data */
  96   memif_ring_t *ring;
  97   memif_log2_ring_size_t log2_ring_size;
  98   memif_region_index_t region;
  99   memif_region_offset_t offset;
 100
 101   u16 last_head;
 102   u16 last_tail;
 103
 104   /* interrupts */
 105   int int_fd;
 106   uword int_clib_file_index;
 107   u64 int_count;
 108 } memif_queue_t;
 109
 110 #define foreach_memif_if_flag \
 111   _(0, ADMIN_UP, "admin-up")            \
 112   _(1, IS_SLAVE, "slave")               \
 113   _(2, CONNECTING, "connecting")        \
 114   _(3, CONNECTED, "connected")          \
 115   _(4, DELETING, "deleting")
 116
 117 typedef enum
 118 {
 119 #define _(a, b, c) MEMIF_IF_FLAG_##b = (1 << a),
 120   foreach_memif_if_flag
 121 #undef _
 122 } memif_if_flag_t;
 123
 124 typedef struct
 125 {
 126   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 127   clib_spinlock_t lockp;
 128   u32 flags;
 129   memif_interface_id_t id;
 130   u32 hw_if_index;
 131   u32 sw_if_index;
 132   uword dev_instance;
 133   memif_interface_mode_t mode:8;
 134
 135   u32 per_interface_next_index;
 136
 137   /* socket connection */
 138   clib_socket_t *sock;
 139   uword socket_file_index;
 140   memif_msg_fifo_elt_t *msg_queue;
 141   u8 *secret;
 142
 143   memif_region_t *regions;
 144
 145   memif_queue_t *rx_queues;
 146   memif_queue_t *tx_queues;
 147
 148   /* remote info */
 149   u8 *remote_name;
 150   u8 *remote_if_name;
 151
 152   struct
 153   {
 154     memif_log2_ring_size_t log2_ring_size;
 155     u8 num_s2m_rings;
 156     u8 num_m2s_rings;
 157     u16 buffer_size;
 158   } cfg;
 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   } run;
 167
 168   /* disconnect strings */
 169   u8 *local_disc_string;
 170   u8 *remote_disc_string;
 171 } memif_if_t;
 172
 173 typedef struct
 174 {
 175   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 176
 177   /** API message ID base */
 178   u16 msg_id_base;
 179
 180   /* pool of all memory interfaces */
 181   memif_if_t *interfaces;
 182
 183   /* pool of all unix socket files */
 184   memif_socket_file_t *socket_files;
 185   mhash_t socket_file_index_by_filename;
 186
 187   /* rx buffer cache */
 188   u32 **rx_buffers;
 189
 190 } memif_main_t;
 191
 192 extern memif_main_t memif_main;
 193 extern vnet_device_class_t memif_device_class;
 194 extern vlib_node_registration_t memif_input_node;
 195
 196 enum
 197 {
 198   MEMIF_PROCESS_EVENT_START = 1,
 199   MEMIF_PROCESS_EVENT_STOP = 2,
 200 } memif_process_event_t;
 201
 202 typedef struct
 203 {
 204   memif_interface_id_t id;
 205   u8 *socket_filename;
 206   u8 *secret;
 207   u8 is_master;
 208   memif_interface_mode_t mode:8;
 209   memif_log2_ring_size_t log2_ring_size;
 210   u16 buffer_size;
 211   u8 hw_addr_set;
 212   u8 hw_addr[6];
 213   u8 rx_queues;
 214   u8 tx_queues;
 215
 216   /* return */
 217   u32 sw_if_index;
 218 } memif_create_if_args_t;
 219
 220 int memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args);
 221 int memif_delete_if (vlib_main_t * vm, memif_if_t * mif);
 222 clib_error_t *memif_plugin_api_hookup (vlib_main_t * vm);
 223
 224 static_always_inline void *
 225 memif_get_buffer (memif_if_t * mif, memif_ring_t * ring, u16 slot)
 226 {
 227   u16 region = ring->desc[slot].region;
 228   return mif->regions[region].shm + ring->desc[slot].offset;
 229 }
 230
 231 /* memif.c */
 232 clib_error_t *memif_init_regions_and_queues (memif_if_t * mif);
 233 clib_error_t *memif_connect (memif_if_t * mif);
 234 void memif_disconnect (memif_if_t * mif, clib_error_t * err);
 235
 236 /* socket.c */
 237 void memif_socket_close (clib_socket_t ** sock);
 238 clib_error_t *memif_conn_fd_accept_ready (clib_file_t * uf);
 239 clib_error_t *memif_master_conn_fd_read_ready (clib_file_t * uf);
 240 clib_error_t *memif_slave_conn_fd_read_ready (clib_file_t * uf);
 241 clib_error_t *memif_master_conn_fd_write_ready (clib_file_t * uf);
 242 clib_error_t *memif_slave_conn_fd_write_ready (clib_file_t * uf);
 243 clib_error_t *memif_master_conn_fd_error (clib_file_t * uf);
 244 clib_error_t *memif_slave_conn_fd_error (clib_file_t * uf);
 245 clib_error_t *memif_msg_send_disconnect (memif_if_t * mif,
 246                                          clib_error_t * err);
 247 u8 *format_memif_device_name (u8 * s, va_list * args);
 248
 249 /*
 250  * fd.io coding-style-patch-verification: ON
 251  *
 252  * Local Variables:
 253  * eval: (c-set-style "gnu")
 254  * End:
 255  */