src/plugins/memif/memif.c

   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
  19 #define _GNU_SOURCE
  20 #include <stdint.h>
  21 #include <net/if.h>
  22 #include <sys/types.h>
  23 #include <fcntl.h>
  24 #include <sys/ioctl.h>
  25 #include <sys/socket.h>
  26 #include <sys/un.h>
  27 #include <sys/uio.h>
  28 #include <sys/mman.h>
  29 #include <sys/prctl.h>
  30 #include <sys/eventfd.h>
  31 #include <inttypes.h>
  32 #include <limits.h>
  33
  34 #include <vlib/vlib.h>
  35 #include <vlib/unix/unix.h>
  36 #include <vnet/plugin/plugin.h>
  37 #include <vnet/ethernet/ethernet.h>
  38 #include <vnet/interface/rx_queue_funcs.h>
  39 #include <vnet/interface/tx_queue_funcs.h>
  40 #include <vpp/app/version.h>
  41 #include <memif/memif.h>
  42 #include <memif/private.h>
  43
  44 memif_main_t memif_main;
  45
  46 static u32
  47 memif_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi, u32 flags)
  48 {
  49   /* nothing for now */
  50   return 0;
  51 }
  52
  53 static clib_error_t *
  54 memif_eth_set_max_frame_size (vnet_main_t *vnm, vnet_hw_interface_t *hi,
  55                               u32 flags)
  56 {
  57   /* nothing for now */
  58   return 0;
  59 }
  60
  61 static void
  62 memif_queue_intfd_close (memif_queue_t * mq)
  63 {
  64   if (mq->int_clib_file_index != ~0)
  65     {
  66       memif_file_del_by_index (mq->int_clib_file_index);
  67       mq->int_clib_file_index = ~0;
  68       mq->int_fd = -1;
  69     }
  70   else if (mq->int_fd > -1)
  71     {
  72       close (mq->int_fd);
  73       mq->int_fd = -1;
  74     }
  75 }
  76
  77 static void
  78 memif_disconnect_free_zc_queue_buffer (memif_queue_t * mq, u8 is_rx)
  79 {
  80   vlib_main_t *vm = vlib_get_main ();
  81   u16 ring_size, n_slots, mask, start;
  82
  83   ring_size = 1 << mq->log2_ring_size;
  84   mask = ring_size - 1;
  85   n_slots = mq->ring->head - mq->last_tail;
  86   start = mq->last_tail & mask;
  87   if (is_rx)
  88     vlib_buffer_free_from_ring (vm, mq->buffers, start, ring_size, n_slots);
  89   else
  90     vlib_buffer_free_from_ring_no_next (vm, mq->buffers, start, ring_size,
  91                                         n_slots);
  92   vec_free (mq->buffers);
  93 }
  94
  95 void
  96 memif_disconnect (memif_if_t * mif, clib_error_t * err)
  97 {
  98   memif_main_t *mm = &memif_main;
  99   vnet_main_t *vnm = vnet_get_main ();
 100   memif_region_t *mr;
 101   memif_queue_t *mq;
 102   int i;
 103
 104   if (mif == 0)
 105     return;
 106
 107   memif_log_debug (mif, "disconnect %u (%v)", mif->dev_instance,
 108                    err ? err->what : 0);
 109
 110   if (err)
 111     {
 112       clib_error_t *e = 0;
 113       mif->local_disc_string = vec_dup (err->what);
 114       if (mif->sock && clib_socket_is_connected (mif->sock))
 115         e = memif_msg_send_disconnect (mif, err);
 116       clib_error_free (e);
 117     }
 118
 119   /* set interface down */
 120   mif->flags &= ~(MEMIF_IF_FLAG_CONNECTED | MEMIF_IF_FLAG_CONNECTING);
 121   if (mif->hw_if_index != ~0)
 122     vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
 123
 124   /* close connection socket */
 125   if (mif->sock && mif->sock->fd)
 126     {
 127       memif_socket_file_t *msf = vec_elt_at_index (mm->socket_files,
 128                                                    mif->socket_file_index);
 129       hash_unset (msf->dev_instance_by_fd, mif->sock->fd);
 130       memif_socket_close (&mif->sock);
 131     }
 132   else if (mif->sock)
 133     {
 134       clib_error_t *err;
 135       err = clib_socket_close (mif->sock);
 136       if (err)
 137         {
 138           memif_log_err (mif, "%U", format_clib_error, err);
 139           clib_error_free (err);
 140         }
 141       clib_mem_free (mif->sock);
 142     }
 143
 144   /* *INDENT-OFF* */
 145   vec_foreach_index (i, mif->rx_queues)
 146     {
 147       mq = vec_elt_at_index (mif->rx_queues, i);
 148       if (mq->ring)
 149         {
 150           if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
 151           {
 152             memif_disconnect_free_zc_queue_buffer(mq, 1);
 153           }
 154           mq->ring = 0;
 155         }
 156     }
 157   vnet_hw_if_unregister_all_rx_queues (vnm, mif->hw_if_index);
 158
 159   /* *INDENT-OFF* */
 160   vec_foreach_index (i, mif->tx_queues)
 161   {
 162     mq = vec_elt_at_index (mif->tx_queues, i);
 163     if (mq->ring)
 164     {
 165       if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
 166       {
 167         memif_disconnect_free_zc_queue_buffer(mq, 0);
 168       }
 169       clib_spinlock_free (&mq->lockp);
 170     }
 171     mq->ring = 0;
 172   }
 173   vnet_hw_if_unregister_all_tx_queues (vnm, mif->hw_if_index);
 174   vnet_hw_if_update_runtime_data (vnm, mif->hw_if_index);
 175
 176   /* free tx and rx queues */
 177   vec_foreach (mq, mif->rx_queues)
 178     memif_queue_intfd_close (mq);
 179   vec_free (mif->rx_queues);
 180
 181   vec_foreach (mq, mif->tx_queues)
 182     memif_queue_intfd_close (mq);
 183   vec_free (mif->tx_queues);
 184
 185   /* free memory regions */
 186   vec_foreach (mr, mif->regions)
 187     {
 188       int rv;
 189       if (mr->is_external)
 190         continue;
 191       if ((rv = munmap (mr->shm, mr->region_size)))
 192         memif_log_err (mif, "munmap failed, rv = %d", rv);
 193       if (mr->fd > -1)
 194         close (mr->fd);
 195     }
 196   /* *INDENT-ON* */
 197   vec_free (mif->regions);
 198   vec_free (mif->remote_name);
 199   vec_free (mif->remote_if_name);
 200   clib_fifo_free (mif->msg_queue);
 201 }
 202
 203 static clib_error_t *
 204 memif_int_fd_write_ready (clib_file_t * uf)
 205 {
 206   memif_main_t *mm = &memif_main;
 207   u16 qid = uf->private_data & 0xFFFF;
 208   memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data >> 16);
 209
 210   memif_log_warn (mif, "unexpected EPOLLOUT on RX for queue %u", qid);
 211   return 0;
 212 }
 213
 214 static clib_error_t *
 215 memif_int_fd_read_ready (clib_file_t * uf)
 216 {
 217   memif_main_t *mm = &memif_main;
 218   vnet_main_t *vnm = vnet_get_main ();
 219   u16 qid = uf->private_data & 0xFFFF;
 220   memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data >> 16);
 221   memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, qid);
 222   u64 b;
 223   ssize_t size;
 224
 225   size = read (uf->file_descriptor, &b, sizeof (b));
 226   if (size < 0)
 227     {
 228       memif_log_debug (mif, "Failed to read from socket");
 229       return 0;
 230     }
 231
 232   vnet_hw_if_rx_queue_set_int_pending (vnm, mq->queue_index);
 233   mq->int_count++;
 234
 235   return 0;
 236 }
 237
 238
 239 clib_error_t *
 240 memif_connect (memif_if_t * mif)
 241 {
 242   memif_main_t *mm = &memif_main;
 243   vlib_main_t *vm = vlib_get_main ();
 244   vnet_main_t *vnm = vnet_get_main ();
 245   clib_file_t template = { 0 };
 246   memif_region_t *mr;
 247   int i, j;
 248   u32 n_txqs = 0, n_threads = vlib_get_n_threads ();
 249   clib_error_t *err = NULL;
 250   u8 max_log2_ring_sz = 0;
 251
 252   memif_log_debug (mif, "connect %u", mif->dev_instance);
 253
 254   vec_free (mif->local_disc_string);
 255   vec_free (mif->remote_disc_string);
 256
 257   /* *INDENT-OFF* */
 258   vec_foreach (mr, mif->regions)
 259     {
 260       if (mr->shm)
 261         continue;
 262
 263       if (mr->fd < 0)
 264         {
 265           err = clib_error_return (0, "no memory region fd");
 266           goto error;
 267         }
 268
 269       if ((mr->shm = mmap (NULL, mr->region_size, PROT_READ | PROT_WRITE,
 270                            MAP_SHARED, mr->fd, 0)) == MAP_FAILED)
 271         {
 272           err = clib_error_return_unix (0, "mmap");
 273           goto error;
 274         }
 275     }
 276   /* *INDENT-ON* */
 277
 278   template.read_function = memif_int_fd_read_ready;
 279   template.write_function = memif_int_fd_write_ready;
 280
 281   /* *INDENT-OFF* */
 282   vec_foreach_index (i, mif->tx_queues)
 283     {
 284       memif_queue_t *mq = vec_elt_at_index (mif->tx_queues, i);
 285       max_log2_ring_sz = clib_max (max_log2_ring_sz, mq->log2_ring_size);
 286
 287       mq->ring = mif->regions[mq->region].shm + mq->offset;
 288       if (mq->ring->cookie != MEMIF_COOKIE)
 289         {
 290           err = clib_error_return (0, "wrong cookie on tx ring %u", i);
 291           goto error;
 292         }
 293       mq->queue_index =
 294         vnet_hw_if_register_tx_queue (vnm, mif->hw_if_index, i);
 295       clib_spinlock_init (&mq->lockp);
 296     }
 297
 298   if (vec_len (mif->tx_queues) > 0)
 299     {
 300       n_txqs = vec_len (mif->tx_queues);
 301       for (j = 0; j < n_threads; j++)
 302         {
 303           u32 qi = mif->tx_queues[j % n_txqs].queue_index;
 304           vnet_hw_if_tx_queue_assign_thread (vnm, qi, j);
 305         }
 306     }
 307
 308   vec_foreach_index (i, mif->rx_queues)
 309     {
 310       memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
 311       u32 ti;
 312       u32 qi;
 313       int rv;
 314
 315       max_log2_ring_sz = clib_max (max_log2_ring_sz, mq->log2_ring_size);
 316
 317       mq->ring = mif->regions[mq->region].shm + mq->offset;
 318       if (mq->ring->cookie != MEMIF_COOKIE)
 319         {
 320           err = clib_error_return (0, "wrong cookie on tx ring %u", i);
 321           goto error;
 322         }
 323       qi = vnet_hw_if_register_rx_queue (vnm, mif->hw_if_index, i,
 324                                          VNET_HW_IF_RXQ_THREAD_ANY);
 325       mq->queue_index = qi;
 326       if (mq->int_fd > -1)
 327         {
 328           template.file_descriptor = mq->int_fd;
 329           template.private_data = (mif->dev_instance << 16) | (i & 0xFFFF);
 330           template.description = format (0, "%U rx %u int",
 331                                          format_memif_device_name,
 332                                          mif->dev_instance, i);
 333           memif_file_add (&mq->int_clib_file_index, &template);
 334           vnet_hw_if_set_rx_queue_file_index (vnm, qi,
 335                                               mq->int_clib_file_index);
 336         }
 337       ti = vnet_hw_if_get_rx_queue_thread_index (vnm, qi);
 338       mq->buffer_pool_index = vlib_buffer_pool_get_default_for_numa (
 339         vm, vlib_get_main_by_index (ti)->numa_node);
 340       rv = vnet_hw_if_set_rx_queue_mode (vnm, qi, VNET_HW_IF_RX_MODE_DEFAULT);
 341       vnet_hw_if_update_runtime_data (vnm, mif->hw_if_index);
 342
 343       if (rv)
 344         memif_log_err
 345           (mif, "Warning: unable to set rx mode for interface %d queue %d: "
 346            "rc=%d", mif->hw_if_index, i, rv);
 347       else
 348         {
 349           vnet_hw_if_rx_mode rxmode = vnet_hw_if_get_rx_queue_mode (vnm, qi);
 350
 351           if (rxmode == VNET_HW_IF_RX_MODE_POLLING)
 352             mq->ring->flags |= MEMIF_RING_FLAG_MASK_INT;
 353           else
 354             vnet_hw_if_rx_queue_set_int_pending (vnm, qi);
 355         }
 356     }
 357   /* *INDENT-ON* */
 358
 359   if (1 << max_log2_ring_sz > vec_len (mm->per_thread_data[0].desc_data))
 360     {
 361       memif_per_thread_data_t *ptd;
 362       int with_barrier = 1;
 363
 364       if (vlib_worker_thread_barrier_held ())
 365         with_barrier = 0;
 366
 367       if (with_barrier)
 368         vlib_worker_thread_barrier_sync (vm);
 369
 370       vec_foreach (ptd, mm->per_thread_data)
 371         {
 372           vec_validate_aligned (ptd->desc_data, pow2_mask (max_log2_ring_sz),
 373                                 CLIB_CACHE_LINE_BYTES);
 374           vec_validate_aligned (ptd->desc_len, pow2_mask (max_log2_ring_sz),
 375                                 CLIB_CACHE_LINE_BYTES);
 376           vec_validate_aligned (ptd->desc_status, pow2_mask (max_log2_ring_sz),
 377                                 CLIB_CACHE_LINE_BYTES);
 378         }
 379       if (with_barrier)
 380         vlib_worker_thread_barrier_release (vm);
 381     }
 382
 383   mif->flags &= ~MEMIF_IF_FLAG_CONNECTING;
 384   mif->flags |= MEMIF_IF_FLAG_CONNECTED;
 385
 386   vnet_hw_interface_set_flags (vnm, mif->hw_if_index,
 387                                VNET_HW_INTERFACE_FLAG_LINK_UP);
 388   return 0;
 389
 390 error:
 391   memif_log_err (mif, "%U", format_clib_error, err);
 392   return err;
 393 }
 394
 395 static_always_inline memif_ring_t *
 396 memif_get_ring (memif_if_t * mif, memif_ring_type_t type, u16 ring_num)
 397 {
 398   if (vec_len (mif->regions) == 0)
 399     return NULL;
 400   void *p = mif->regions[0].shm;
 401   int ring_size =
 402     sizeof (memif_ring_t) +
 403     sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size);
 404   p += (ring_num + type * mif->run.num_s2m_rings) * ring_size;
 405
 406   return (memif_ring_t *) p;
 407 }
 408
 409 clib_error_t *
 410 memif_init_regions_and_queues (memif_if_t * mif)
 411 {
 412   vlib_main_t *vm = vlib_get_main ();
 413   memif_socket_file_t *msf;
 414   memif_ring_t *ring = NULL;
 415   int fd, i, j;
 416   u64 buffer_offset;
 417   memif_region_t *r;
 418   clib_error_t *err;
 419
 420   ASSERT (vec_len (mif->regions) == 0);
 421   vec_add2_aligned (mif->regions, r, 1, CLIB_CACHE_LINE_BYTES);
 422
 423   buffer_offset = (mif->run.num_s2m_rings + mif->run.num_m2s_rings) *
 424     (sizeof (memif_ring_t) +
 425      sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size));
 426
 427   r->region_size = buffer_offset;
 428
 429   if ((mif->flags & MEMIF_IF_FLAG_ZERO_COPY) == 0)
 430     r->region_size += mif->run.buffer_size * (1 << mif->run.log2_ring_size) *
 431       (mif->run.num_s2m_rings + mif->run.num_m2s_rings);
 432
 433   if ((fd = clib_mem_vm_create_fd (CLIB_MEM_PAGE_SZ_DEFAULT, "%U region 0",
 434                                    format_memif_device_name,
 435                                    mif->dev_instance)) == -1)
 436     {
 437       err = clib_mem_get_last_error ();
 438       goto error;
 439     }
 440
 441   if ((ftruncate (fd, r->region_size)) == -1)
 442     {
 443       err = clib_error_return_unix (0, "ftruncate");
 444       goto error;
 445     }
 446
 447   msf = pool_elt_at_index (memif_main.socket_files, mif->socket_file_index);
 448   r->shm = clib_mem_vm_map_shared (0, r->region_size, fd, 0, "memif%lu/%lu:0",
 449                                    msf->socket_id, mif->id);
 450
 451   if (r->shm == CLIB_MEM_VM_MAP_FAILED)
 452     {
 453       err = clib_error_return_unix (0, "memif shared region map failed");
 454       goto error;
 455     }
 456
 457   r->fd = fd;
 458
 459   if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
 460     {
 461       vlib_buffer_pool_t *bp;
 462       /* *INDENT-OFF* */
 463       vec_foreach (bp, vm->buffer_main->buffer_pools)
 464         {
 465           vlib_physmem_map_t *pm;
 466           pm = vlib_physmem_get_map (vm, bp->physmem_map_index);
 467           vec_add2_aligned (mif->regions, r, 1, CLIB_CACHE_LINE_BYTES);
 468           r->fd = pm->fd;
 469           r->region_size = pm->n_pages << pm->log2_page_size;
 470           r->shm = pm->base;
 471           r->is_external = 1;
 472         }
 473       /* *INDENT-ON* */
 474     }
 475
 476   for (i = 0; i < mif->run.num_s2m_rings; i++)
 477     {
 478       ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
 479       ring->head = ring->tail = 0;
 480       ring->cookie = MEMIF_COOKIE;
 481
 482       if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
 483         continue;
 484
 485       for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
 486         {
 487           u16 slot = i * (1 << mif->run.log2_ring_size) + j;
 488           ring->desc[j].region = 0;
 489           ring->desc[j].offset =
 490             buffer_offset + (u32) (slot * mif->run.buffer_size);
 491           ring->desc[j].length = mif->run.buffer_size;
 492         }
 493     }
 494   for (i = 0; i < mif->run.num_m2s_rings; i++)
 495     {
 496       ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
 497       ring->head = ring->tail = 0;
 498       ring->cookie = MEMIF_COOKIE;
 499
 500       if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
 501         continue;
 502
 503       for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
 504         {
 505           u16 slot =
 506             (i + mif->run.num_s2m_rings) * (1 << mif->run.log2_ring_size) + j;
 507           ring->desc[j].region = 0;
 508           ring->desc[j].offset =
 509             buffer_offset + (u32) (slot * mif->run.buffer_size);
 510           ring->desc[j].length = mif->run.buffer_size;
 511         }
 512     }
 513
 514   ASSERT (mif->tx_queues == 0);
 515   vec_validate_aligned (mif->tx_queues, mif->run.num_s2m_rings - 1,
 516                         CLIB_CACHE_LINE_BYTES);
 517
 518   /* *INDENT-OFF* */
 519   vec_foreach_index (i, mif->tx_queues)
 520     {
 521       memif_queue_t *mq = vec_elt_at_index (mif->tx_queues, i);
 522       if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
 523         {
 524           err = clib_error_return_unix (0, "eventfd[tx queue %u]", i);
 525           goto error;
 526         }
 527
 528       mq->int_clib_file_index = ~0;
 529       mq->ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
 530       mq->log2_ring_size = mif->cfg.log2_ring_size;
 531       mq->region = 0;
 532       mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
 533       mq->last_head = 0;
 534       mq->type = MEMIF_RING_S2M;
 535       if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
 536         vec_validate_aligned (mq->buffers, 1 << mq->log2_ring_size,
 537                               CLIB_CACHE_LINE_BYTES);
 538     }
 539   /* *INDENT-ON* */
 540
 541   ASSERT (mif->rx_queues == 0);
 542   vec_validate_aligned (mif->rx_queues, mif->run.num_m2s_rings - 1,
 543                         CLIB_CACHE_LINE_BYTES);
 544
 545   /* *INDENT-OFF* */
 546   vec_foreach_index (i, mif->rx_queues)
 547     {
 548       memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
 549       if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
 550         {
 551           err = clib_error_return_unix (0, "eventfd[rx queue %u]", i);
 552           goto error;
 553         }
 554       mq->int_clib_file_index = ~0;
 555       mq->ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
 556       mq->log2_ring_size = mif->cfg.log2_ring_size;
 557       mq->region = 0;
 558       mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
 559       mq->last_head = 0;
 560       mq->type = MEMIF_RING_M2S;
 561       if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
 562         vec_validate_aligned (mq->buffers, 1 << mq->log2_ring_size,
 563                               CLIB_CACHE_LINE_BYTES);
 564     }
 565   /* *INDENT-ON* */
 566
 567   return 0;
 568
 569 error:
 570   memif_log_err (mif, "%U", format_clib_error, err);
 571   return err;
 572 }
 573
 574 static uword
 575 memif_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f)
 576 {
 577   memif_main_t *mm = &memif_main;
 578   memif_if_t *mif;
 579   clib_socket_t *sock;
 580   uword *event_data = 0, event_type;
 581   u8 enabled = 0;
 582   f64 start_time, last_run_duration = 0, now;
 583   clib_error_t *err;
 584
 585   sock = clib_mem_alloc (sizeof (clib_socket_t));
 586   clib_memset (sock, 0, sizeof (clib_socket_t));
 587
 588   while (1)
 589     {
 590       if (enabled)
 591         vlib_process_wait_for_event_or_clock (vm, (f64) 3 -
 592                                               last_run_duration);
 593       else
 594         vlib_process_wait_for_event (vm);
 595
 596       event_type = vlib_process_get_events (vm, &event_data);
 597       vec_reset_length (event_data);
 598
 599       switch (event_type)
 600         {
 601         case ~0:
 602           break;
 603         case MEMIF_PROCESS_EVENT_START:
 604           enabled = 1;
 605           break;
 606         case MEMIF_PROCESS_EVENT_STOP:
 607           enabled = 0;
 608           continue;
 609         case MEMIF_PROCESS_EVENT_ADMIN_UP_DOWN:
 610           break;
 611         default:
 612           ASSERT (0);
 613         }
 614
 615       last_run_duration = start_time = vlib_time_now (vm);
 616       /* *INDENT-OFF* */
 617       pool_foreach (mif, mm->interfaces)
 618          {
 619           memif_socket_file_t * msf = vec_elt_at_index (mm->socket_files, mif->socket_file_index);
 620           /* Allow no more than 10us without a pause */
 621           now = vlib_time_now (vm);
 622           if (now > start_time + 10e-6)
 623             {
 624               vlib_process_suspend (vm, 100e-6);        /* suspend for 100 us */
 625               start_time = vlib_time_now (vm);
 626             }
 627
 628           if ((mif->flags & MEMIF_IF_FLAG_ADMIN_UP) == 0)
 629             continue;
 630
 631           if (mif->flags & MEMIF_IF_FLAG_CONNECTING)
 632             continue;
 633
 634           if (mif->flags & MEMIF_IF_FLAG_CONNECTED)
 635             continue;
 636
 637           if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
 638             {
 639               clib_memset (sock, 0, sizeof(clib_socket_t));
 640               sock->config = (char *) msf->filename;
 641               sock->flags = CLIB_SOCKET_F_IS_CLIENT | CLIB_SOCKET_F_SEQPACKET |
 642                             CLIB_SOCKET_F_BLOCKING;
 643
 644               if ((err = clib_socket_init (sock)))
 645                 {
 646                   clib_error_free (err);
 647                 }
 648               else
 649                 {
 650                   clib_file_t t = { 0 };
 651
 652                   t.read_function = memif_slave_conn_fd_read_ready;
 653                   t.write_function = memif_slave_conn_fd_write_ready;
 654                   t.error_function = memif_slave_conn_fd_error;
 655                   t.file_descriptor = sock->fd;
 656                   t.private_data = mif->dev_instance;
 657                   memif_file_add (&sock->private_data, &t);
 658                   t.description = format (0, "%U ctl",
 659                                           format_memif_device_name,
 660                                           mif->dev_instance);
 661                   hash_set (msf->dev_instance_by_fd, sock->fd, mif->dev_instance);
 662
 663                   mif->flags |= MEMIF_IF_FLAG_CONNECTING;
 664                   mif->sock = sock;
 665                   sock = clib_mem_alloc (sizeof(clib_socket_t));
 666                 }
 667             }
 668         }
 669       /* *INDENT-ON* */
 670       last_run_duration = vlib_time_now (vm) - last_run_duration;
 671     }
 672   return 0;
 673 }
 674
 675 /* *INDENT-OFF* */
 676 VLIB_REGISTER_NODE (memif_process_node,static) = {
 677   .function = memif_process,
 678   .type = VLIB_NODE_TYPE_PROCESS,
 679   .name = "memif-process",
 680 };
 681 /* *INDENT-ON* */
 682
 683 static int
 684 memif_add_socket_file (u32 sock_id, u8 * socket_filename)
 685 {
 686   memif_main_t *mm = &memif_main;
 687   uword *p;
 688   memif_socket_file_t *msf;
 689
 690   p = hash_get (mm->socket_file_index_by_sock_id, sock_id);
 691   if (p)
 692     {
 693       msf = pool_elt_at_index (mm->socket_files, *p);
 694       if (strcmp ((char *) msf->filename, (char *) socket_filename) == 0)
 695         {
 696           /* Silently accept identical "add". */
 697           return 0;
 698         }
 699
 700       /* But don't allow a direct add of a different filename. */
 701       return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
 702     }
 703
 704   pool_get (mm->socket_files, msf);
 705   clib_memset (msf, 0, sizeof (memif_socket_file_t));
 706
 707   msf->filename = socket_filename;
 708   msf->socket_id = sock_id;
 709
 710   hash_set (mm->socket_file_index_by_sock_id, sock_id,
 711             msf - mm->socket_files);
 712
 713   return 0;
 714 }
 715
 716 static int
 717 memif_delete_socket_file (u32 sock_id)
 718 {
 719   memif_main_t *mm = &memif_main;
 720   uword *p;
 721   memif_socket_file_t *msf;
 722
 723   p = hash_get (mm->socket_file_index_by_sock_id, sock_id);
 724   if (!p)
 725     {
 726       /* Don't delete non-existent entries. */
 727       return VNET_API_ERROR_INVALID_ARGUMENT;
 728     }
 729
 730   msf = pool_elt_at_index (mm->socket_files, *p);
 731   if (msf->ref_cnt > 0)
 732     {
 733       return VNET_API_ERROR_UNEXPECTED_INTF_STATE;
 734     }
 735
 736   vec_free (msf->filename);
 737   pool_put (mm->socket_files, msf);
 738
 739   hash_unset (mm->socket_file_index_by_sock_id, sock_id);
 740
 741   return 0;
 742 }
 743
 744 int
 745 memif_socket_filename_add_del (u8 is_add, u32 sock_id, u8 * sock_filename)
 746 {
 747   char *dir = 0, *tmp;
 748   u32 idx = 0;
 749
 750   /* allow adding socket id 0 */
 751   if ((sock_id == 0 && is_add == 0) || sock_id == ~0)
 752     {
 753       return VNET_API_ERROR_INVALID_ARGUMENT;
 754     }
 755
 756   if (is_add == 0)
 757     {
 758       return memif_delete_socket_file (sock_id);
 759     }
 760
 761   if (sock_filename == 0 || sock_filename[0] == 0)
 762     {
 763       return VNET_API_ERROR_INVALID_ARGUMENT;
 764     }
 765
 766   if (sock_filename[0] != '/')
 767     {
 768       clib_error_t *error;
 769
 770       /* copy runtime dir path */
 771       vec_add (dir, vlib_unix_get_runtime_dir (),
 772                strlen (vlib_unix_get_runtime_dir ()));
 773       vec_add1 (dir, '/');
 774
 775       /* if sock_filename contains dirs, add them to path */
 776       tmp = strrchr ((char *) sock_filename, '/');
 777       if (tmp)
 778         {
 779           idx = tmp - (char *) sock_filename;
 780           vec_add (dir, sock_filename, idx);
 781         }
 782
 783       vec_add1 (dir, '\0');
 784       /* create socket dir */
 785       error = vlib_unix_recursive_mkdir (dir);
 786       if (error)
 787         {
 788           clib_error_free (error);
 789           return VNET_API_ERROR_SYSCALL_ERROR_1;
 790         }
 791
 792       sock_filename = format (0, "%s/%s%c", vlib_unix_get_runtime_dir (),
 793                               sock_filename, 0);
 794     }
 795   else
 796     {
 797       sock_filename = vec_dup (sock_filename);
 798
 799       /* check if directory exists */
 800       tmp = strrchr ((char *) sock_filename, '/');
 801       if (tmp)
 802         {
 803           idx = tmp - (char *) sock_filename;
 804           vec_add (dir, sock_filename, idx);
 805           vec_add1 (dir, '\0');
 806         }
 807
 808       /* check dir existance and access rights for effective user/group IDs */
 809       if ((dir == NULL)
 810           ||
 811           (faccessat ( /* ignored */ -1, dir, F_OK | R_OK | W_OK, AT_EACCESS)
 812            < 0))
 813         {
 814           vec_free (dir);
 815           return VNET_API_ERROR_INVALID_ARGUMENT;
 816         }
 817     }
 818   vec_free (dir);
 819
 820   return memif_add_socket_file (sock_id, sock_filename);
 821 }
 822
 823 int
 824 memif_delete_if (vlib_main_t * vm, memif_if_t * mif)
 825 {
 826   vnet_main_t *vnm = vnet_get_main ();
 827   memif_main_t *mm = &memif_main;
 828   memif_socket_file_t *msf =
 829     vec_elt_at_index (mm->socket_files, mif->socket_file_index);
 830   clib_error_t *err;
 831
 832   mif->flags |= MEMIF_IF_FLAG_DELETING;
 833   vec_free (mif->local_disc_string);
 834   vec_free (mif->remote_disc_string);
 835
 836   /* bring down the interface */
 837   vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
 838   vnet_sw_interface_set_flags (vnm, mif->sw_if_index, 0);
 839
 840   err = clib_error_return (0, "interface deleted");
 841   memif_disconnect (mif, err);
 842   clib_error_free (err);
 843
 844   if (mif->hw_if_index != ~0)
 845     {
 846       /* remove the interface */
 847       if (mif->mode == MEMIF_INTERFACE_MODE_IP)
 848         vnet_delete_hw_interface (vnm, mif->hw_if_index);
 849       else
 850         ethernet_delete_interface (vnm, mif->hw_if_index);
 851       mif->hw_if_index = ~0;
 852     }
 853
 854   /* free interface data structures */
 855   mhash_unset (&msf->dev_instance_by_id, &mif->id, 0);
 856
 857   /* remove socket file */
 858   if (--(msf->ref_cnt) == 0)
 859     {
 860       if (msf->is_listener)
 861         {
 862           int i;
 863           /* *INDENT-OFF* */
 864           vec_foreach_index (i, msf->pending_clients)
 865             memif_socket_close (msf->pending_clients + i);
 866           /* *INDENT-ON* */
 867           memif_socket_close (&msf->sock);
 868           vec_free (msf->pending_clients);
 869         }
 870       mhash_free (&msf->dev_instance_by_id);
 871       hash_free (msf->dev_instance_by_fd);
 872       if (msf->sock)
 873         {
 874           err = clib_socket_close (msf->sock);
 875           if (err)
 876             {
 877               memif_log_err (mif, "%U", format_clib_error, err);
 878               clib_error_free (err);
 879             }
 880           clib_mem_free (msf->sock);
 881         }
 882     }
 883
 884   clib_memset (mif, 0, sizeof (*mif));
 885   pool_put (mm->interfaces, mif);
 886
 887   if (pool_elts (mm->interfaces) == 0)
 888     vlib_process_signal_event (vm, memif_process_node.index,
 889                                MEMIF_PROCESS_EVENT_STOP, 0);
 890
 891   return 0;
 892 }
 893
 894 /* *INDENT-OFF* */
 895 VNET_HW_INTERFACE_CLASS (memif_ip_hw_if_class, static) = {
 896   .name = "memif-ip",
 897   .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
 898   .tx_hash_fn_type = VNET_HASH_FN_TYPE_IP,
 899 };
 900 /* *INDENT-ON* */
 901
 902 int
 903 memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args)
 904 {
 905   memif_main_t *mm = &memif_main;
 906   vlib_thread_main_t *tm = vlib_get_thread_main ();
 907   vnet_main_t *vnm = vnet_get_main ();
 908   vnet_eth_interface_registration_t eir = {};
 909   memif_if_t *mif = 0;
 910   vnet_sw_interface_t *sw;
 911   clib_error_t *error = 0;
 912   int ret = 0;
 913   uword *p;
 914   memif_socket_file_t *msf = 0;
 915   int rv = 0;
 916
 917   p = hash_get (mm->socket_file_index_by_sock_id, args->socket_id);
 918   if (p == 0)
 919     {
 920       rv = VNET_API_ERROR_INVALID_ARGUMENT;
 921       goto done;
 922     }
 923
 924   msf = vec_elt_at_index (mm->socket_files, p[0]);
 925
 926   /* existing socket file can be either master or slave but cannot be both */
 927   if (msf->ref_cnt > 0)
 928     {
 929       if ((!msf->is_listener != !args->is_master))
 930         {
 931           rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
 932           goto done;
 933         }
 934
 935       p = mhash_get (&msf->dev_instance_by_id, &args->id);
 936       if (p)
 937         {
 938           rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
 939           goto done;
 940         }
 941     }
 942
 943   /* Create new socket file */
 944   if (msf->ref_cnt == 0)
 945     {
 946       struct stat file_stat;
 947
 948       /* If we are creating listener make sure file doesn't exist or if it
 949        * exists thn delete it if it is old socket file */
 950       if (args->is_master && (stat ((char *) msf->filename, &file_stat) == 0))
 951         {
 952           if (S_ISSOCK (file_stat.st_mode))
 953             {
 954               unlink ((char *) msf->filename);
 955             }
 956           else
 957             {
 958               error = clib_error_return (0, "File exists for %s",
 959                                          msf->filename);
 960               rv = VNET_API_ERROR_VALUE_EXIST;
 961               goto done;
 962             }
 963         }
 964
 965       mhash_init (&msf->dev_instance_by_id, sizeof (uword),
 966                   sizeof (memif_interface_id_t));
 967       msf->dev_instance_by_fd = hash_create (0, sizeof (uword));
 968       msf->is_listener = (args->is_master != 0);
 969
 970       memif_log_debug (0, "initializing socket file %s", msf->filename);
 971     }
 972
 973   if (mm->per_thread_data == 0)
 974     {
 975       int i;
 976
 977       vec_validate_aligned (mm->per_thread_data, tm->n_vlib_mains - 1,
 978                             CLIB_CACHE_LINE_BYTES);
 979
 980       for (i = 0; i < tm->n_vlib_mains; i++)
 981         {
 982           memif_per_thread_data_t *ptd =
 983             vec_elt_at_index (mm->per_thread_data, i);
 984           vlib_buffer_t *bt = &ptd->buffer_template;
 985           clib_memset (bt, 0, sizeof (vlib_buffer_t));
 986           bt->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
 987           bt->total_length_not_including_first_buffer = 0;
 988           vnet_buffer (bt)->sw_if_index[VLIB_TX] = (u32) ~ 0;
 989
 990           /* initially prealloc copy_ops so we can use
 991              _vec_len instead of vec_elen */
 992           vec_validate_aligned (ptd->copy_ops, 0, CLIB_CACHE_LINE_BYTES);
 993           vec_reset_length (ptd->copy_ops);
 994           vec_validate_aligned (ptd->buffers, 0, CLIB_CACHE_LINE_BYTES);
 995           vec_reset_length (ptd->buffers);
 996         }
 997     }
 998
 999   pool_get (mm->interfaces, mif);
1000   clib_memset (mif, 0, sizeof (*mif));
1001   mif->dev_instance = mif - mm->interfaces;
1002   mif->socket_file_index = msf - mm->socket_files;
1003   mif->id = args->id;
1004   mif->sw_if_index = mif->hw_if_index = mif->per_interface_next_index = ~0;
1005   mif->mode = args->mode;
1006   if (args->secret)
1007     mif->secret = vec_dup (args->secret);
1008
1009   if (mif->mode == MEMIF_INTERFACE_MODE_ETHERNET)
1010     {
1011
1012       if (!args->hw_addr_set)
1013         {
1014           f64 now = vlib_time_now (vm);
1015           u32 rnd;
1016           rnd = (u32) (now * 1e6);
1017           rnd = random_u32 (&rnd);
1018
1019           memcpy (args->hw_addr + 2, &rnd, sizeof (rnd));
1020           args->hw_addr[0] = 2;
1021           args->hw_addr[1] = 0xfe;
1022         }
1023
1024       eir.dev_class_index = memif_device_class.index;
1025       eir.dev_instance = mif->dev_instance;
1026       eir.address = args->hw_addr;
1027       eir.cb.flag_change = memif_eth_flag_change;
1028       eir.cb.set_max_frame_size = memif_eth_set_max_frame_size;
1029       mif->hw_if_index = vnet_eth_register_interface (vnm, &eir);
1030     }
1031   else if (mif->mode == MEMIF_INTERFACE_MODE_IP)
1032     {
1033       mif->hw_if_index =
1034         vnet_register_interface (vnm, memif_device_class.index,
1035                                  mif->dev_instance,
1036                                  memif_ip_hw_if_class.index,
1037                                  mif->dev_instance);
1038     }
1039   else
1040     error = clib_error_return (0, "unsupported interface mode");
1041
1042   if (error)
1043     {
1044       ret = VNET_API_ERROR_SYSCALL_ERROR_2;
1045       goto error;
1046     }
1047
1048   sw = vnet_get_hw_sw_interface (vnm, mif->hw_if_index);
1049   mif->sw_if_index = sw->sw_if_index;
1050
1051   mif->cfg.log2_ring_size = args->log2_ring_size;
1052   mif->cfg.buffer_size = args->buffer_size;
1053   mif->cfg.num_s2m_rings =
1054     args->is_master ? args->rx_queues : args->tx_queues;
1055   mif->cfg.num_m2s_rings =
1056     args->is_master ? args->tx_queues : args->rx_queues;
1057
1058   args->sw_if_index = mif->sw_if_index;
1059
1060   /* If this is new one, start listening */
1061   if (msf->is_listener && msf->ref_cnt == 0)
1062     {
1063       struct stat file_stat;
1064       clib_socket_t *s = clib_mem_alloc (sizeof (clib_socket_t));
1065
1066       ASSERT (msf->sock == 0);
1067       msf->sock = s;
1068
1069       clib_memset (s, 0, sizeof (clib_socket_t));
1070       s->config = (char *) msf->filename;
1071       s->flags = CLIB_SOCKET_F_IS_SERVER |
1072         CLIB_SOCKET_F_ALLOW_GROUP_WRITE |
1073         CLIB_SOCKET_F_SEQPACKET | CLIB_SOCKET_F_PASSCRED;
1074
1075       if ((error = clib_socket_init (s)))
1076         {
1077           ret = VNET_API_ERROR_SYSCALL_ERROR_4;
1078           goto error;
1079         }
1080
1081       if (stat ((char *) msf->filename, &file_stat) == -1)
1082         {
1083           ret = VNET_API_ERROR_SYSCALL_ERROR_8;
1084           goto error;
1085         }
1086
1087       clib_file_t template = { 0 };
1088       template.read_function = memif_conn_fd_accept_ready;
1089       template.file_descriptor = msf->sock->fd;
1090       template.private_data = mif->socket_file_index;
1091       template.description = format (0, "memif listener %s", msf->filename);
1092       memif_file_add (&msf->sock->private_data, &template);
1093     }
1094
1095   msf->ref_cnt++;
1096
1097   if (args->is_master == 0)
1098     {
1099       mif->flags |= MEMIF_IF_FLAG_IS_SLAVE;
1100       if (args->is_zero_copy)
1101         mif->flags |= MEMIF_IF_FLAG_ZERO_COPY;
1102     }
1103
1104   vnet_hw_if_set_caps (vnm, mif->hw_if_index, VNET_HW_IF_CAP_INT_MODE);
1105   vnet_hw_if_set_input_node (vnm, mif->hw_if_index, memif_input_node.index);
1106   mhash_set (&msf->dev_instance_by_id, &mif->id, mif->dev_instance, 0);
1107
1108   if (pool_elts (mm->interfaces) == 1)
1109     {
1110       vlib_process_signal_event (vm, memif_process_node.index,
1111                                  MEMIF_PROCESS_EVENT_START, 0);
1112     }
1113   goto done;
1114
1115 error:
1116   memif_delete_if (vm, mif);
1117   if (error)
1118     {
1119       memif_log_err (mif, "%U", format_clib_error, error);
1120       clib_error_free (error);
1121     }
1122   return ret;
1123
1124 done:
1125   return rv;
1126 }
1127
1128 clib_error_t *
1129 memif_interface_admin_up_down (vnet_main_t *vnm, u32 hw_if_index, u32 flags)
1130 {
1131   memif_main_t *mm = &memif_main;
1132   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
1133   memif_if_t *mif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
1134   static clib_error_t *error = 0;
1135
1136   if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
1137     {
1138       if (mif->flags & MEMIF_IF_FLAG_CONNECTED)
1139         {
1140           vnet_hw_interface_set_flags (vnm, mif->hw_if_index,
1141                                        VNET_HW_INTERFACE_FLAG_LINK_UP);
1142         }
1143       mif->flags |= MEMIF_IF_FLAG_ADMIN_UP;
1144     }
1145   else
1146     mif->flags &= ~MEMIF_IF_FLAG_ADMIN_UP;
1147
1148   vlib_process_signal_event (vnm->vlib_main, memif_process_node.index,
1149                              MEMIF_PROCESS_EVENT_ADMIN_UP_DOWN, 0);
1150   return error;
1151 }
1152
1153 static clib_error_t *
1154 memif_init (vlib_main_t * vm)
1155 {
1156   memif_main_t *mm = &memif_main;
1157
1158   clib_memset (mm, 0, sizeof (memif_main_t));
1159
1160   mm->log_class = vlib_log_register_class ("memif_plugin", 0);
1161   memif_log_debug (0, "initialized");
1162
1163   /* initialize binary API */
1164   memif_plugin_api_hookup (vm);
1165
1166   /*
1167    * Pre-stuff socket filename pool with a non-modifieable mapping
1168    * for socket-id 0 to MEMIF_DEFAULT_SOCKET_FILENAME in the
1169    * default run-time directory.
1170    */
1171   memif_socket_filename_add_del (1, 0, (u8 *) MEMIF_DEFAULT_SOCKET_FILENAME);
1172
1173   return 0;
1174 }
1175
1176 VLIB_INIT_FUNCTION (memif_init);
1177
1178 /* *INDENT-OFF* */
1179 VLIB_PLUGIN_REGISTER () = {
1180     .version = VPP_BUILD_VER,
1181     .description = "Packet Memory Interface (memif) -- Experimental",
1182 };
1183 /* *INDENT-ON* */
1184
1185 /*
1186  * fd.io coding-style-patch-verification: ON
1187  *
1188  * Local Variables:
1189  * eval: (c-set-style "gnu")
1190  * End:
1191  */