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