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