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