src/plugins/memif/device.c

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2016 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 #define _GNU_SOURCE
  19 #include <stdint.h>
  20 #include <net/if.h>
  21 #include <sys/ioctl.h>
  22 #include <sys/uio.h>
  23
  24 #include <vlib/vlib.h>
  25 #include <vlib/unix/unix.h>
  26 #include <vnet/ethernet/ethernet.h>
  27
  28 #include <memif/memif.h>
  29
  30 #define foreach_memif_tx_func_error            \
  31 _(NO_FREE_SLOTS, "no free tx slots")           \
  32 _(PENDING_MSGS, "pending msgs in tx ring")
  33
  34 typedef enum
  35 {
  36 #define _(f,s) MEMIF_TX_ERROR_##f,
  37   foreach_memif_tx_func_error
  38 #undef _
  39     MEMIF_TX_N_ERROR,
  40 } memif_tx_func_error_t;
  41
  42 static char *memif_tx_func_error_strings[] = {
  43 #define _(n,s) s,
  44   foreach_memif_tx_func_error
  45 #undef _
  46 };
  47
  48
  49 static u8 *
  50 format_memif_device_name (u8 * s, va_list * args)
  51 {
  52   u32 i = va_arg (*args, u32);
  53
  54   s = format (s, "memif%u", i);
  55   return s;
  56 }
  57
  58 static u8 *
  59 format_memif_device (u8 * s, va_list * args)
  60 {
  61   u32 dev_instance = va_arg (*args, u32);
  62   int verbose = va_arg (*args, int);
  63   uword indent = format_get_indent (s);
  64
  65   s = format (s, "MEMIF interface");
  66   if (verbose)
  67     {
  68       s = format (s, "\n%U instance %u", format_white_space, indent + 2,
  69                   dev_instance);
  70     }
  71   return s;
  72 }
  73
  74 static u8 *
  75 format_memif_tx_trace (u8 * s, va_list * args)
  76 {
  77   s = format (s, "Unimplemented...");
  78   return s;
  79 }
  80
  81 static_always_inline void
  82 memif_prefetch_buffer_and_data (vlib_main_t * vm, u32 bi)
  83 {
  84   vlib_buffer_t *b = vlib_get_buffer (vm, bi);
  85   vlib_prefetch_buffer_header (b, LOAD);
  86   CLIB_PREFETCH (b->data, CLIB_CACHE_LINE_BYTES, LOAD);
  87 }
  88
  89 static_always_inline uword
  90 memif_interface_tx_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
  91                            vlib_frame_t * frame, memif_if_t * mif,
  92                            memif_ring_type_t type)
  93 {
  94   u8 rid;
  95   memif_ring_t *ring;
  96   u32 *buffers = vlib_frame_args (frame);
  97   u32 n_left = frame->n_vectors;
  98   u16 ring_size = 1 << mif->log2_ring_size;
  99   u16 mask = ring_size - 1;
 100   u16 head, tail;
 101   u16 free_slots;
 102   u32 thread_index = vlib_get_thread_index ();
 103   u8 tx_queues = memif_get_tx_queues (mif);
 104
 105   if (tx_queues < vec_len (vlib_mains))
 106     {
 107       rid = thread_index % tx_queues;
 108       clib_spinlock_lock_if_init (&mif->lockp);
 109     }
 110   else
 111     {
 112       rid = thread_index;
 113     }
 114   ring = memif_get_ring (mif, type, rid);
 115
 116   /* free consumed buffers */
 117
 118   head = ring->head;
 119   tail = ring->tail;
 120
 121   if (tail > head)
 122     free_slots = tail - head;
 123   else
 124     free_slots = ring_size - head + tail;
 125
 126   while (n_left > 5 && free_slots > 1)
 127     {
 128       if (PREDICT_TRUE (head + 5 < ring_size))
 129         {
 130           CLIB_PREFETCH (memif_get_buffer (mif, ring, head + 2),
 131                          CLIB_CACHE_LINE_BYTES, STORE);
 132           CLIB_PREFETCH (memif_get_buffer (mif, ring, head + 3),
 133                          CLIB_CACHE_LINE_BYTES, STORE);
 134           CLIB_PREFETCH (&ring->desc[head + 4], CLIB_CACHE_LINE_BYTES, STORE);
 135           CLIB_PREFETCH (&ring->desc[head + 5], CLIB_CACHE_LINE_BYTES, STORE);
 136         }
 137       else
 138         {
 139           CLIB_PREFETCH (memif_get_buffer (mif, ring, (head + 2) % mask),
 140                          CLIB_CACHE_LINE_BYTES, STORE);
 141           CLIB_PREFETCH (memif_get_buffer (mif, ring, (head + 3) % mask),
 142                          CLIB_CACHE_LINE_BYTES, STORE);
 143           CLIB_PREFETCH (&ring->desc[(head + 4) % mask],
 144                          CLIB_CACHE_LINE_BYTES, STORE);
 145           CLIB_PREFETCH (&ring->desc[(head + 5) % mask],
 146                          CLIB_CACHE_LINE_BYTES, STORE);
 147         }
 148
 149       memif_prefetch_buffer_and_data (vm, buffers[2]);
 150       memif_prefetch_buffer_and_data (vm, buffers[3]);
 151
 152       vlib_buffer_t *b0 = vlib_get_buffer (vm, buffers[0]);
 153       vlib_buffer_t *b1 = vlib_get_buffer (vm, buffers[1]);
 154
 155       void *mb0 = memif_get_buffer (mif, ring, head);
 156       clib_memcpy (mb0, vlib_buffer_get_current (b0), CLIB_CACHE_LINE_BYTES);
 157       ring->desc[head].length = b0->current_length;
 158       head = (head + 1) & mask;
 159
 160       void *mb1 = memif_get_buffer (mif, ring, head);
 161       clib_memcpy (mb1, vlib_buffer_get_current (b1), CLIB_CACHE_LINE_BYTES);
 162       ring->desc[head].length = b1->current_length;
 163       head = (head + 1) & mask;
 164
 165       if (b0->current_length > CLIB_CACHE_LINE_BYTES)
 166         {
 167           clib_memcpy (mb0 + CLIB_CACHE_LINE_BYTES,
 168                        vlib_buffer_get_current (b0) + CLIB_CACHE_LINE_BYTES,
 169                        b0->current_length - CLIB_CACHE_LINE_BYTES);
 170         }
 171       if (b1->current_length > CLIB_CACHE_LINE_BYTES)
 172         {
 173           clib_memcpy (mb1 + CLIB_CACHE_LINE_BYTES,
 174                        vlib_buffer_get_current (b1) + CLIB_CACHE_LINE_BYTES,
 175                        b1->current_length - CLIB_CACHE_LINE_BYTES);
 176         }
 177
 178
 179       buffers += 2;
 180       n_left -= 2;
 181       free_slots -= 2;
 182     }
 183
 184   while (n_left && free_slots)
 185     {
 186       vlib_buffer_t *b0 = vlib_get_buffer (vm, buffers[0]);
 187       void *mb0 = memif_get_buffer (mif, ring, head);
 188       clib_memcpy (mb0, vlib_buffer_get_current (b0), CLIB_CACHE_LINE_BYTES);
 189
 190       if (b0->current_length > CLIB_CACHE_LINE_BYTES)
 191         {
 192           clib_memcpy (mb0 + CLIB_CACHE_LINE_BYTES,
 193                        vlib_buffer_get_current (b0) + CLIB_CACHE_LINE_BYTES,
 194                        b0->current_length - CLIB_CACHE_LINE_BYTES);
 195         }
 196       ring->desc[head].length = b0->current_length;
 197       head = (head + 1) & mask;
 198
 199       buffers++;
 200       n_left--;
 201       free_slots--;
 202     }
 203
 204   CLIB_MEMORY_STORE_BARRIER ();
 205   ring->head = head;
 206
 207   clib_spinlock_unlock_if_init (&mif->lockp);
 208
 209   if (n_left)
 210     {
 211       vlib_error_count (vm, node->node_index, MEMIF_TX_ERROR_NO_FREE_SLOTS,
 212                         n_left);
 213       vlib_buffer_free (vm, buffers, n_left);
 214     }
 215
 216   vlib_buffer_free (vm, vlib_frame_args (frame), frame->n_vectors);
 217   if (mif->interrupt_line.fd > 0)
 218     {
 219       u8 b = rid;
 220       CLIB_UNUSED (int r) = write (mif->interrupt_line.fd, &b, sizeof (b));
 221     }
 222
 223   return frame->n_vectors;
 224 }
 225
 226 static uword
 227 memif_interface_tx (vlib_main_t * vm,
 228                     vlib_node_runtime_t * node, vlib_frame_t * frame)
 229 {
 230   memif_main_t *nm = &memif_main;
 231   vnet_interface_output_runtime_t *rund = (void *) node->runtime_data;
 232   memif_if_t *mif = pool_elt_at_index (nm->interfaces, rund->dev_instance);
 233
 234   if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
 235     return memif_interface_tx_inline (vm, node, frame, mif, MEMIF_RING_S2M);
 236   else
 237     return memif_interface_tx_inline (vm, node, frame, mif, MEMIF_RING_M2S);
 238 }
 239
 240 static void
 241 memif_set_interface_next_node (vnet_main_t * vnm, u32 hw_if_index,
 242                                u32 node_index)
 243 {
 244   memif_main_t *apm = &memif_main;
 245   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
 246   memif_if_t *mif = pool_elt_at_index (apm->interfaces, hw->dev_instance);
 247
 248   /* Shut off redirection */
 249   if (node_index == ~0)
 250     {
 251       mif->per_interface_next_index = node_index;
 252       return;
 253     }
 254
 255   mif->per_interface_next_index =
 256     vlib_node_add_next (vlib_get_main (), memif_input_node.index, node_index);
 257 }
 258
 259 static void
 260 memif_clear_hw_interface_counters (u32 instance)
 261 {
 262   /* Nothing for now */
 263 }
 264
 265 static clib_error_t *
 266 memif_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
 267 {
 268   memif_main_t *apm = &memif_main;
 269   vlib_main_t *vm = vlib_get_main ();
 270   memif_msg_t msg = { 0 };
 271   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
 272   memif_if_t *mif = pool_elt_at_index (apm->interfaces, hw->dev_instance);
 273   static clib_error_t *error = 0;
 274
 275   if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
 276     mif->flags |= MEMIF_IF_FLAG_ADMIN_UP;
 277   else
 278     {
 279       mif->flags &= ~MEMIF_IF_FLAG_ADMIN_UP;
 280       if (!(mif->flags & MEMIF_IF_FLAG_DELETING)
 281           && mif->connection.index != ~0)
 282         {
 283           msg.version = MEMIF_VERSION;
 284           msg.type = MEMIF_MSG_TYPE_DISCONNECT;
 285           if (send (mif->connection.fd, &msg, sizeof (msg), 0) < 0)
 286             {
 287               clib_unix_warning ("Failed to send disconnect request");
 288               error = clib_error_return_unix (0, "send fd %d",
 289                                               mif->connection.fd);
 290               memif_disconnect (vm, mif);
 291             }
 292         }
 293     }
 294
 295   return error;
 296 }
 297
 298 static clib_error_t *
 299 memif_subif_add_del_function (vnet_main_t * vnm,
 300                               u32 hw_if_index,
 301                               struct vnet_sw_interface_t *st, int is_add)
 302 {
 303   /* Nothing for now */
 304   return 0;
 305 }
 306
 307 /* *INDENT-OFF* */
 308 VNET_DEVICE_CLASS (memif_device_class) = {
 309   .name = "memif",
 310   .tx_function = memif_interface_tx,
 311   .format_device_name = format_memif_device_name,
 312   .format_device = format_memif_device,
 313   .format_tx_trace = format_memif_tx_trace,
 314   .tx_function_n_errors = MEMIF_TX_N_ERROR,
 315   .tx_function_error_strings = memif_tx_func_error_strings,
 316   .rx_redirect_to_node = memif_set_interface_next_node,
 317   .clear_counters = memif_clear_hw_interface_counters,
 318   .admin_up_down_function = memif_interface_admin_up_down,
 319   .subif_add_del_function = memif_subif_add_del_function,
 320 };
 321
 322 VLIB_DEVICE_TX_FUNCTION_MULTIARCH(memif_device_class,
 323                                   memif_interface_tx)
 324 /* *INDENT-ON* */
 325
 326 /*
 327  * fd.io coding-style-patch-verification: ON
 328  *
 329  * Local Variables:
 330  * eval: (c-set-style "gnu")
 331  * End:
 332  */