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_DIR "/run/vpp"
  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) - 1)
  28 #define MEMIF_MAX_S2M_RING              (vec_len (vlib_mains) - 1)
  29 #define MEMIF_MAX_REGION                255
  30 #define MEMIF_MAX_LOG2_RING_SIZE        14
  31
  32 #define MEMIF_DEBUG 0
  33
  34 #if MEMIF_DEBUG == 1
  35 #define DBG(...) clib_warning(__VA_ARGS__)
  36 #define DBG_UNIX_LOG(...) clib_unix_warning(__VA_ARGS__)
  37 #else
  38 #define DBG(...)
  39 #define DBG_UNIX_LOG(...)
  40 #endif
  41
  42 #if MEMIF_DEBUG == 1
  43 #define memif_file_add(a, b) do {                                       \
  44   ASSERT (*a == ~0);                                                    \
  45   *a = unix_file_add (&unix_main, b);                                   \
  46   clib_warning ("unix_file_add fd %d private_data %u idx %u",           \
  47                 (b)->file_descriptor, (b)->private_data, *a);           \
  48 } while (0)
  49
  50 #define memif_file_del(a) do {                                          \
  51   clib_warning ("unix_file_del idx %u",a - unix_main.file_pool);        \
  52   unix_file_del (&unix_main, a);                                        \
  53 } while (0)
  54
  55 #define memif_file_del_by_index(a) do {                                 \
  56   clib_warning ("unix_file_del idx %u", a);                             \
  57   unix_file_del_by_index (&unix_main, a);                               \
  58 } while (0)
  59 #else
  60 #define memif_file_add(a, b) do {                                       \
  61   ASSERT (*a == ~0);                                                    \
  62   *a = unix_file_add (&unix_main, b);                                   \
  63 } while (0)
  64 #define memif_file_del(a) unix_file_del(&unix_main, a)
  65 #define memif_file_del_by_index(a) unix_file_del_by_index(&unix_main, a)
  66 #endif
  67
  68 typedef struct
  69 {
  70   u8 *filename;
  71   int fd;
  72   uword unix_file_index;
  73   uword *pending_file_indices;
  74   int ref_cnt;
  75   int is_listener;
  76
  77   /* hash of all registered id */
  78   mhash_t dev_instance_by_id;
  79
  80   /* hash of all registered fds */
  81   uword *dev_instance_by_fd;
  82 } memif_socket_file_t;
  83
  84 typedef struct
  85 {
  86   void *shm;
  87   memif_region_size_t region_size;
  88   int fd;
  89 } memif_region_t;
  90
  91 typedef struct
  92 {
  93   memif_msg_t msg;
  94   int fd;
  95 } memif_msg_fifo_elt_t;
  96
  97 typedef struct
  98 {
  99   /* ring data */
 100   memif_ring_t *ring;
 101   memif_log2_ring_size_t log2_ring_size;
 102   memif_region_index_t region;
 103   memif_region_offset_t offset;
 104
 105   u16 last_head;
 106   u16 last_tail;
 107
 108   /* interrupts */
 109   int int_fd;
 110   uword int_unix_file_index;
 111   u64 int_count;
 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   uword socket_file_index;
 143   int conn_fd;
 144   uword conn_unix_file_index;
 145   memif_msg_fifo_elt_t *msg_queue;
 146   u8 *secret;
 147
 148   memif_region_t *regions;
 149
 150   memif_queue_t *rx_queues;
 151   memif_queue_t *tx_queues;
 152
 153   /* remote info */
 154   pid_t remote_pid;
 155   uid_t remote_uid;
 156   gid_t remote_gid;
 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   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 184
 185   /** API message ID base */
 186   u16 msg_id_base;
 187
 188   /* pool of all memory interfaces */
 189   memif_if_t *interfaces;
 190
 191   /* pool of all unix socket files */
 192   memif_socket_file_t *socket_files;
 193   mhash_t socket_file_index_by_filename;
 194
 195   /* rx buffer cache */
 196   u32 **rx_buffers;
 197
 198 } memif_main_t;
 199
 200 extern memif_main_t memif_main;
 201 extern vnet_device_class_t memif_device_class;
 202 extern vlib_node_registration_t memif_input_node;
 203
 204 enum
 205 {
 206   MEMIF_PROCESS_EVENT_START = 1,
 207   MEMIF_PROCESS_EVENT_STOP = 2,
 208 } memif_process_event_t;
 209
 210 typedef struct
 211 {
 212   memif_interface_id_t id;
 213   u8 *socket_filename;
 214   u8 *secret;
 215   u8 is_master;
 216   memif_interface_mode_t mode:8;
 217   memif_log2_ring_size_t log2_ring_size;
 218   u16 buffer_size;
 219   u8 hw_addr_set;
 220   u8 hw_addr[6];
 221   u8 rx_queues;
 222   u8 tx_queues;
 223
 224   /* return */
 225   u32 sw_if_index;
 226 } memif_create_if_args_t;
 227
 228 int memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args);
 229 int memif_delete_if (vlib_main_t * vm, memif_if_t * mif);
 230 clib_error_t *memif_plugin_api_hookup (vlib_main_t * vm);
 231
 232 #ifndef __NR_memfd_create
 233 #if defined __x86_64__
 234 #define __NR_memfd_create 319
 235 #elif defined __arm__
 236 #define __NR_memfd_create 385
 237 #elif defined __aarch64__
 238 #define __NR_memfd_create 279
 239 #else
 240 #error "__NR_memfd_create unknown for this architecture"
 241 #endif
 242 #endif
 243
 244 static inline int
 245 memfd_create (const char *name, unsigned int flags)
 246 {
 247   return syscall (__NR_memfd_create, name, flags);
 248 }
 249
 250 static_always_inline void *
 251 memif_get_buffer (memif_if_t * mif, memif_ring_t * ring, u16 slot)
 252 {
 253   u16 region = ring->desc[slot].region;
 254   return mif->regions[region].shm + ring->desc[slot].offset;
 255 }
 256
 257 #ifndef F_LINUX_SPECIFIC_BASE
 258 #define F_LINUX_SPECIFIC_BASE 1024
 259 #endif
 260 #define MFD_ALLOW_SEALING       0x0002U
 261 #define F_ADD_SEALS (F_LINUX_SPECIFIC_BASE + 9)
 262 #define F_GET_SEALS (F_LINUX_SPECIFIC_BASE + 10)
 263
 264 #define F_SEAL_SEAL     0x0001  /* prevent further seals from being set */
 265 #define F_SEAL_SHRINK   0x0002  /* prevent file from shrinking */
 266 #define F_SEAL_GROW     0x0004  /* prevent file from growing */
 267 #define F_SEAL_WRITE    0x0008  /* prevent writes */
 268
 269 /* memif.c */
 270 clib_error_t *memif_init_regions_and_queues (memif_if_t * mif);
 271 clib_error_t *memif_connect (memif_if_t * mif);
 272 void memif_disconnect (memif_if_t * mif, clib_error_t * err);
 273
 274 /* socket.c */
 275 clib_error_t *memif_conn_fd_accept_ready (unix_file_t * uf);
 276 clib_error_t *memif_master_conn_fd_read_ready (unix_file_t * uf);
 277 clib_error_t *memif_slave_conn_fd_read_ready (unix_file_t * uf);
 278 clib_error_t *memif_master_conn_fd_write_ready (unix_file_t * uf);
 279 clib_error_t *memif_slave_conn_fd_write_ready (unix_file_t * uf);
 280 clib_error_t *memif_master_conn_fd_error (unix_file_t * uf);
 281 clib_error_t *memif_slave_conn_fd_error (unix_file_t * uf);
 282 clib_error_t *memif_msg_send_disconnect (memif_if_t * mif,
 283                                          clib_error_t * err);
 284 u8 *format_memif_device_name (u8 * s, va_list * args);
 285
 286 /*
 287  * fd.io coding-style-patch-verification: ON
 288  *
 289  * Local Variables:
 290  * eval: (c-set-style "gnu")
 291  * End:
 292  */